SmartSelfie™ Authentication

Required Class: WebApi Class

Running SmartSelfie™ Authentication on Python

Get your Smile ID Partner ID
Get your API Key
Create a Callback Endpoint
Get your user's Selfie
Get the user ID you initially used to register the user
Submit the Job to Smile ID
Interpret your results

Get your Partner ID

You can find your Partner ID in the menu list when logged into the portal.

Get your API Key

Your encoded API Key is also in the developer section of the portal.

Click on the Generate New API Key button
Copy your api key (ensure you are in the right environment)

Create a Callback Endpoint

Responses from this product are asynchronous (based on various actions we carry out on the product) and are sent as soon as they are ready, you will need to setup a callback when submitting a job. You can read about creating a Callback URL here.

Get the User's Selfie

To successfully run SmartSelfie™ Authentication jobs you need to submit the user's selfie. There are two types of selfies that can be submitted

Selfie - a single colour-image selfie of user
(optional but required for proof of life) Liveness images - 8 colour images of user

The selfies can either be submitted as files (with the path to the image specified during submission) or as base64 encoded strings.

We recommend that you use our Web SDK to capture both of these types of images

Get the User's User ID

Since SmartSelfie™ Authentication entails comparing a user's selfie with the selfie they have on file in Smile ID, you must supply the User's existing user_id in the partner params (the user_id must be the same as the one you used when you ran a successful "Biometric KYC" or "Document Verification" for the user). If the User ID you supplied does not exist, the job will fail.

Submit the Job to Smile ID

You can copy the sample code below and edit with your partner and job details.

from smile_id_core import WebApi, ServerError

# Initialize
partner_id = "<Put your partner ID here>"; #login to the Smile ID portal to view your partner id
default_callback = "<Put your default callback url here>";
api_key = "<Put your API key here>"; # copy your API key from the Smile ID portal
sid_server = <0 | 1>; # Use 0 for the sandbox server, use 1 for production server

connection = WebApi(partner_id,default_callback,api_key,sid_server)

# Create required tracking parameters
partner_params = {
    "user_id": "<put previously registered user's user_id here>",
    "job_id": "<put your unique job ID here>",
    "job_type": 2
}

# Create image list
# image_type_id Integer
# 0 - Selfie image jpg (if you have the full path of the selfie)
# 2 - Selfie image jpg base64 encoded (if you have the base64image string of the selfie)
# 4 - Liveness image jpg (if you have the full path of the liveness image)
# 6 - Liveness image jpg base64 encoded (if you have the base64image string of the liveness image)
image_details = [
    {
      "image_type_id": <0 | 2>,
      "image": "<full path to selfie image or base64image string>"
     },
     { # Not required if you don't require proof of life (note photo of photo check will still be performed on the uploaded selfie)
       "image_type_id": <4 | 6>,
       "image": "<full path to liveness image or base64 image string>"
     }
  ]

# Set options for the job
options = {
  "return_job_status": <True | False>, # Set to true if you want to get the job result in sync (in addition to the result been sent to your callback). If set to false, result is sent to callback url only.
  "return_history": <True | False>, # Set to true to return results of all jobs you have ran for the user in addition to current job result. You must set return_job_status to true to use this flag.
  "return_images": <True | False>, # Set to true to receive selfie and liveness images you uploaded. You must set return_job_status to true to use this flag.
  "signature": True
}

# Submit the job
try:
    response = connection.submit_job(partner_params, image_details, {}, options)
except ValueError:
    # some of your params entered for a job are not valid or missing
    print("handle ValueError")
except ServerError:
    # Server returned an error
    print("handle ServerError")
except FileNotFoundError:
    # Sent a file which could not be found
    print("handle FileNotFoundError")

Getting the Job Result

By default, you always get the result of your job in the callback url you provided, however for some use cases you might want to get the job result in sync after submission. The flag return_job_status can be set to True if you want to get the job result in sync.

Please note that the result you get in sync by setting the return_job_status flag to true might not be the final result if human review is required for the job. We recommend you use the responses sent to your callback to build your business logic as that is where we return the final result

Refer to the category column of result codes of SmartSelfie™ Authentication for the comprehensive list of final codes (approved or rejected) and in-progress codes (provisional approval or suspected for spoof).

Response when `return_job_status` is set to `False`

If return_job_status is set to False, the response will be a JSON string containing:

{
    "smile_job_id": "<the generated smile_job_id>",
    "success": true
}

The job result will be sent to the callback url you provided, it will look as follows:

{
  "Actions": {
    "Human_Review_Compare": "Not Applicable",
    "Human_Review_Liveness_Check": "Passed",
    "Human_Review_Update_Selfie": "Not Applicable",
    "Liveness_Check": "Passed",
    "Register_Selfie": "Not Applicable",
    "Return_Personal_Info": "Not Applicable",
    "Selfie_Provided": "Passed",
    "Selfie_To_ID_Authority_Compare": "Not Applicable",
    "Selfie_To_ID_Card_Compare": "Not Applicable",
    "Selfie_To_Registered_Selfie_Compare": "Completed",
    "Update_Registered_Selfie_On_File": "Not Applicable",
    "Verify_ID_Number": "Not Applicable"
  },
  "ConfidenceValue": "99.000000",
  "PartnerParams": {
    "job_id": "KE_TEST_1013",
    "job_type": "2",
    "user_id": "KE_TESTTEST_1012"
  },
  "ResultCode": "1220",
  "ResultText": "Authenticated",
  "SmileJobID": "0000057497",
  "Source": "WebAPI",
  "timestamp": "2021-06-21T15:10:15.729Z",
  "signature": "----signature-----"
}

Response when `return_job_status` is set to `True`

If you have use cases that require you to get the result in sync, you can set the return_job_status to True. We advise that you use the result sent to your callback to make final decisions as there are times when the submitted job requires human review, the final result after the review is completed can not be retrieved by setting the return_job_status to True.

If you set return_job_status to True (with images and history also set to True) then you will receive the JSON object containing the machine result like below:

{
  "timestamp": "2022-03-31T15:07:04.806Z",
  "signature": "---signature---",
  "job_complete": true,
  "job_success": true,
  "code": "2302",
  "result": {
    "Source": "WebAPI - ruby",
    "Actions": {
      "Liveness_Check": "Under Review",
      "Register_Selfie": "Not Applicable",
      "Selfie_Provided": "Passed",
      "Verify_ID_Number": "Not Applicable",
      "Human_Review_Compare": "Not Applicable",
      "Return_Personal_Info": "Not Applicable",
      "Selfie_To_ID_Card_Compare": "Not Applicable",
      "Human_Review_Update_Selfie": "Not Applicable",
      "Human_Review_Liveness_Check": "Not Applicable",
      "Selfie_To_ID_Authority_Compare": "Not Applicable",
      "Update_Registered_Selfie_On_File": "Not Applicable",
      "Selfie_To_Registered_Selfie_Compare": "Completed"
    },
    "ResultCode": "0824",
    "ResultText": "Provisional Authentication - Under Review",
    "ResultType": "SAIA",
    "SmileJobID": "0000000194",
    "JSONVersion": "1.0.0",
    "IsFinalResult": "true",
    "PartnerParams": {
      "job_id": "003",
      "user_id": "rb_ekyc+ss_test_user_005",
      "job_type": "2"
    },
    "ConfidenceValue": "99",
    "IsMachineResult": "true"
  },
  "history": [
    {
      "Source": "WebAPI - ruby",
      "Actions": {
        "Liveness_Check": "Under Review",
        "Register_Selfie": "Not Applicable",
        "Selfie_Provided": "Passed",
        "Verify_ID_Number": "Not Applicable",
        "Human_Review_Compare": "Not Applicable",
        "Return_Personal_Info": "Not Applicable",
        "Selfie_To_ID_Card_Compare": "Not Applicable",
        "Human_Review_Update_Selfie": "Not Applicable",
        "Human_Review_Liveness_Check": "Not Applicable",
        "Selfie_To_ID_Authority_Compare": "Not Applicable",
        "Update_Registered_Selfie_On_File": "Not Applicable",
        "Selfie_To_Registered_Selfie_Compare": "Completed"
      },
      "ResultCode": "0824",
      "ResultText": "Provisional Authentication - Under Review",
      "ResultType": "SAIA",
      "SmileJobID": "0000000194",
      "JSONVersion": "1.0.0",
      "IsFinalResult": "true",
      "PartnerParams": {
        "job_id": "003",
        "user_id": "test_user_005",
        "job_type": "2"
      },
      "ConfidenceValue": "99",
      "IsMachineResult": "true"
    }
  ],
  "image_links": {
    "selfie_image": "---image link---"
  },
  "success": true,
  "smile_job_id": "0000000194"
}