Last updated
Last updated
Required Class: WebApi Class
Get your Smile ID Partner ID
Get your API Key
Create a Endpoint
Get your user's Selfie images
Get the ID information from your users
Submit the Job to Smile ID
Interpret your results
You can find your Partner ID in the menu list when logged into .
Click on the Generate New API Key button
Copy your api key (ensure you are in the right environment)
The size of the payload sent to your callback varies based on the size of image returned by the ID authority. We recommend your callback should accept payloads up to 1.5MB in size.
To successfully run Biometric KYC 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 live) 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.
You can copy the sample code below and edit with your partner and job details.
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
return_job_status
is set to false
If return_job_status
is set to false
, the response will be a JSON string containing:
The job result will be sent to the callback url you provided, it will look as follows:
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 advice 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 image_links
and history
also set to true
) then you will receive the JSON object containing the machine result like below:
Your API Key is also in the developer section of
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 .
We recommend that you use our to capture both of these types of images
To submit a Biometric KYC job you need the ID information of your user. Depending on the ID type you are attempting to query, the required information varies. For the comprehensive list of required information for each ID Type, check the section of the docs.
Refer to the category column of result codes of for the comprehensive list of final codes (approved or rejected) and in-progress codes (inconclusive, provisional approval or suspected for spoof).
You can read more about result codes and responses in the section of the docs.