Biometric KYC
Last updated
Was this helpful?
Last updated
Was this helpful?
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
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 .
To successfully run Biometric KYC jobs you need to submit the user's selfie.Please see SmartSelfie capture as , it is important to recognise that the tag supplied and or returned from this is what will need to be used to submit the Job
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.
jobType
should be set to 1 and is required
callBackUrl (Optional)
can be null but if not it should be a url which the job data will be posted to depending on the status the job is in
partnerParams (Optional)
This is the object create in the step above related to partner params
idInfo (Required)
This is the object create in the step above related to user id information
geoInfo
(Optional) This is any information that may be necessary to associate the job with any geolocation
isProduction (required)
should be set to true if you intent to run in production and false if you intend to run in sandbox, it is important to note you cannot run real ID Numbers check on sandbox, for test data please see
The result hashmap is an object will contain results returned from the api this contains strongly typed method to get the response as individual items or as json object or as a string, for more information on how to interpret results you can read more about result codes and responses in the section of the docs.