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
Get the user ID you initially used to register the user
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 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 Live) Liveness images - 8 colour images of user
ID card photo
The selfies images 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 these images.
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 (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.
You can read more about result codes and responses in the section of the docs.