Last updated
Last updated
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.
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.