Face Recognition
submit_job method
Copy this code and replace sections marked with <>
#import the WenApi modulefrom smile_id_core import WebApi​partner_id = "<Put your 3 digit partner ID here>"default_callback = "<Put your default callback url here>"api_key = "<Put your base64 encoded API key here>" # Download your API key from the Smile Identity portalsid_server = "0" # Use '0' for the sandbox (test) server, use '1' for production server​# Initializetry:connection = WebApi(partner_id, default_callback, api_key, sid_server)except ValueError:# some of your params entered for a job are not valid or missingprint("handle ValueError")​# Create required tracking parameterspartner_params = {"user_id": '<put your unique ID for the user here>',"job_id": '<put unique job name here',# Job Type Integer 1 for jobs that compare a selfie to an ID,# 2 for authenticating a selfie against a previously registered user,# 4 for registering a user,# 8 for updating the enrolled photo"job_type": "<1 | 2 | 4| 8>"}​# Create image list# image_type_id# 0 - Selfie image jpg or png## 1 - ID card image jpg or png# 2 - Selfie image jpg or png base64 encoded# 3 - ID card image jpg or png base 64 encodedimage_details = [{"image_type_id": "<0 | 2>","image": "<path to selfie image or base64 image string>"},# Not required if suppling ID number info or job type 4 - registration only{"image_type_id": "<1 | 3>","image": '<path to ID card image or base64 image string>'}]​# Create ID number infoid_info = {"first_name": '<name>',"last_name": '<surname>',"country": '<country code>',"id_type": '<id type>',"dob": '<date of birth>', # yyyy-mm-dd"id_number": '<valid id number>',"entered": '<True | False>' # must be a string}​# Create optionsoptions = {"return_job_status": "< True | False >","return_history": "< True | False >","return_image_links": "< True | False >"}​try:response = connection.submit_job(partner_params, image_details, id_info, options)except ValueError:# some of your params entered for a job are not valid or missingprint("handle ValueError")except ServerError:# Server returned an errorprint("handle ServerError")except FileNotFoundError:# Sent a file which could not be foundprint("handle FileNotFoundError")
The response will be a python object. Please note that if you do not need to pass through id_info or options, you may omit calling those class and send through None in submit_job, as follows:
response = connection.submit_job(partner_params, image_details, None, None)
In the case of a Job Type 5 you can simply pass the image details as None. Remember that the response is immediate, so there is no need to query the job_status. There is also no enrollment so no images are required. The response for a job type 5 can be found in the response section below.
Example Response:
Should you choose to set return_job_status to false, the response will be a JSON containing:
{"success": True, "smile_job_id": "<smile_job_id>"}
However, if you have set return_job_status to true (with image_links and history) then you will receive a promise that will return a JSON Object response like below:
{"job_success":true,"result":{"ConfidenceValue":"99","JSONVersion":"1.0.0","Actions":{"Verify_ID_Number":"Verified","Return_Personal_Info":"Returned","Human_Review_Update_Selfie":"Not Applicable","Human_Review_Compare":"Not Applicable","Update_Registered_Selfie_On_File":"Not Applicable","Liveness_Check":"Not Applicable","Register_Selfie":"Approved","Human_Review_Liveness_Check":"Not Applicable","Selfie_To_ID_Authority_Compare":"Completed","Selfie_To_ID_Card_Compare":"Not Applicable","Selfie_To_Registered_Selfie_Compare":"Not Applicable"},"ResultText":"Enroll User","IsFinalResult":"true","IsMachineResult":"true","ResultType":"SAIA","PartnerParams":{"job_type":"1","optional_info":"we are one","user_id":"HBBBBBBH57g","job_id":"HBBBBBBHg"},"Source":"WebAPI","ResultCode":"0810","SmileJobID":"0000001111"},"code":"2302","job_complete":true,"signature":"...","history":[{"ConfidenceValue":"99","JSONVersion":"1.0.0","Actions":{"Verify_ID_Number":"Verified","Return_Personal_Info":"Returned","Human_Review_Update_Selfie":"Not Applicable","Human_Review_Compare":"Not Applicable","Update_Registered_Selfie_On_File":"Not Applicable","Liveness_Check":"Not Applicable","Register_Selfie":"Approved","Human_Review_Liveness_Check":"Not Applicable","Selfie_To_ID_Authority_Compare":"Completed","Selfie_To_ID_Card_Compare":"Not Applicable","Selfie_To_Registered_Selfie_Compare":"Not Applicable"},"ResultText":"Enroll User","IsFinalResult":"true","IsMachineResult":"true","ResultType":"SAIA","PartnerParams":{"job_type":"1","optional_info":"we are one","user_id":"HBBBBBBH57g","job_id":"HBBBBBBHg"},"Source":"WebAPI","ResultCode":"0810","SmileJobID":"0000001111"}],"image_links":{"selfie_image":"image_link"},"timestamp":"2019-10-10T12:32:04.622Z"}
You can also view your response asynchronously at the callback that you have set, it will look as follows:
{"ResultCode": "1220","ResultText": "Authenticated","ResultType": "DIVA","SmileJobID": "0000000001","JSONVersion": "1.0.0","IsFinalResult": "true","PartnerParams": {"job_id": "e7ca3e6c-e527-7165-b0b5-b90db1276378","user_id": "07a0c120-98d7-4fdc-bc62-3c6bfd16c60e","job_type": 2},"ConfidenceValue": "100.000000","IsMachineResult": "true"}
​
If an error occurs, the Web Api package will throw an error. Be sure to catch any error that occurs as in this example:
​
try:response = connection.submit_job(partner_params, image_params, id_info_params, options_params)except ValueError:# some of your params entered for a job are not valid or missingprint("handle ValueError")except ServerError:# Server returned an errorprint("handle ServerError")except FileNotFoundError:# Sent a file which could not be foundprint("handle FileNotFoundError")
​
Last updated 3 months ago