Only available to licensed organisations. Please contact [email protected] if you need access to this product.
The Enhanced KYC API allows you to query the Identity Information for an individual using their ID number from one of our supported ID Types. This API will return the personal information of the individual found in the database of the ID authority.
This API is available as both an Asynchronous API (recommended) which guarantees an eventual response regardless of ID authority availability and as a Synchronous API to be used in real time environments such as mobile applications which does not guarantee a response in the case that an ID authority is unavailable. For high volume applications the Asynchronous API is required. If you are using the Asynchronous API you must have a callback endpoint in your request where the response will be delivered. The urls for the endpoints are:
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.
The Enhanced KYC API has the following input parameters which should be contained in a JSON body object submitted to the endpoint
Request Type: Post
The integration option you are using. For rest api send the value as "rest_api"
The version of the integration option you are using
The outgoing signature to authenticate the request from you to Smile Identity
The timestamp used to calculate the signature in ISO date/time format
Yes for Async
Your callback url, results of jobs will be sent to the specified url. You can read more about callback urls here
Date of Birth
A JSON object containing the partner parameters below as well as any additional key value pairs you wish to include for tracking which will be returned in the response
The type of job you want to perform. This will be set to 5.
A value generated by you, so you can track jobs on your end. This value must be unique, can be any string and can follow your identifier convention
A value generated by you, so you can track users on your end. This value must be unique, can be any string and can follow your identifier convention.
The Enhanced KYC API returns a set of top level values as well as a detailed set of actions that can be used for a more granular evaluation of the individual fields.
The Smile internal reference number for the job. Please include this when contacting support on a job.
A unique reference defined by you to keep track of the job
The type of job you performed
A unique reference defined by you to keep track of the user
Textual value of the job outcome. Human readable value for the result.
Numeric value of the job outcome.
A JSON object containing the details of the individual field comparisons
The result of looking up the ID number in the ID authority database is returned in this key
This key confirms if we sent the personal information retrieved from the ID authority sent to you
Country where the ID was issued as supplied by you
ID type as supplied by you
ID number you ran a query for
Top level key - expiration date as retrieved from the ID authority database
Top level key - full name as retrieved from the ID authority database
Top level key - date of birth as retrieved from the ID authority database
Top level key - phone number as retrieved from the ID authority database
Second phone number of ID owner (when available)
Photo of ID card on file in the ID authority database (when applicable)
Gender of ID owner
Address of ID owner
NOTE: this might not be the current address of the ID owner
Top level key - photo as retrieved from the ID authority database in base64 image
The outgoing signature, you can use this to verify that the response is from Smile ID
The outgoing timestamp in ISO date/time format, use this to calculate the outgoing Signature
Depending on the endpoint you hit (asynchronous or synchronous) the immediate response you get is different.
For the Asynchronous Endpoint
For the Synchronous Endpoint (this is the same response sent to the callback of the asynchronous endpoint)
"ResultText":"ID Number Validated",
"FullName":"Leo Doe Joe",
The Enhanced KYC product returns the personal information of users stored in the ID authority database. Each ID authority stores these personal information with different keys causing discrepancies in names of keys containing similar information. For the identity lookup response, we have filtered and standardised the personal information returned to top-level keys to simplify the use of our JSON response across all our supported ID types.
Result codes details what the current (or final) result of a job is. Result Codes for all jobs fall into one of three categories:
- 1.Approved (or Pass) This means that all applicable Actions passed and the overall job was approved.
- 2.Provisionally Approved This means that the job is awaiting a human review, or that a human review was inconclusive or that part of a job passed but another part was unable to be completed. You can treat these jobs as Approved or you handle them based on the Result Code. Please note a
Pure Provisionalresult is a provisionally approved job, but one in which the image comparison Action was provisionally approved but the identity validation Action failed or could not return data. Also note, a
Pending Approvalresult is a custom Strict setting where the user cannot progress in the system without a human review being completed on the Pending job.
- 3.Rejected (or Fail) This means that one or more of the applicable Actions for job failed, and thus, the overall job was rejected according to Smile Identity standards.
This means no further processing is possible on the job. General failures occur when a job could not be submitted due to a logical/technical issue. These jobs do not show up in the portal and do not have a Smile Job ID.
The uploaded Zip file is corrupted.
Error - "You are not authorized to do that" *
An invalid signature was used to sign the request.
Error - No Zip File Received
No Zip files was uploaded.
Error - Invalid JSON
The info.json file in the Zip is not properly structured. Ensure all keys are present and properly named.
Error - A required parameter is missing
Not all the required keys were submitted in the info.json or request payload. Please check request values for this product.
Error - A parameter is of the wrong data type
Error - You are not authorized to do that. *
An invalid signature was used to sign the request.
You have not completed your KYC.
Error - Invalid job type **
An invalid value was inputted in the job_type key. Change the value to "5".
The ID info was not found in the ID authority database.
Error - Unsupported ID number format
Error - Queried Database Unavailable
The ID authority is unavailable.
Error - Need to Activate Product
You do not have access to the ID Type. Please contact support for more information.
(Mobile SDK Only) ID Validation Failed
(Mobile SDK Only) Error - HTTP Request Failed