Last updated
Last updated
Required Class: SmileIdentityCore Class
Get your Smile ID Partner ID
Get your API Key
Create a Endpoint
Get your user's Selfie images
Get the user's ID document image
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)
To successfully run document verification 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.
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
. Please note that it can take up to 1 minute 30 seconds to get an in sync result as there are times when the submitted job requires human review.
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
In addition to the user's selfie, we also need an image of the ID document to complete a document verification job. We will also need the country of issuance of the ID document and the document type. For the full list of document types we support, you can check the section of the docs. To check the authenticity of the document, we require high resolution images, please read the minimum specification of the document image and best practices in .
You can read more about result codes and responses in the section of the docs.