Description of the on_complete Callback

This callback is called after the check is completed. It retrieves the analysis result (unavailable for the capture mode). The result content depends on the Web Adapter result_mode configuration parameter.

Keep in mind that it is more secure to get your back end responsible for the decision logic. You can find more details including code samples here.

Safe

When result_mode is safe, the on_complete callback contains the state of the analysis only:

{
  "state": "finished"
}

Please note: The options listed below are for testing purposes only. If you require more information than what is available in the Safe mode, please follow Security Recommendations.

Status

For the status value, the callback contains the state of the analysis, and for each of the analysis types, the name of the type, state, and resolution.

{
 "state": "finished",
 "analyses": {
   "quality": {
     "state": "finished",
     "resolution": "success"
   }
 }
}

Folder

The folder value is almost similar to the status value, with the only difference: the folder_id is added.

{
 "state": "finished",
 "folder_id": "your_folder_id",
 "analyses": {
   "quality": {
     "state": "finished",
     "resolution": "success"
   }
 }
}

Full

If result_mode is set to full, you receive the full information on the analysis:

• everything that you could see in the folder mode;

• score (the value of the min_confidence or confidence_spoofing parameters; please refer to this article for details);
• timestamps;

• metadata;

• analyses’, company, analysis group IDs;

• thresholds;

• media info;

• and more.

100KB

on_complete_full.json

Example