Get Started
For developers
User ID verification by SDK
Fraud is always spearheading. Luckily, so is our technology. Using the best combination of human and machine learning fraud spotting, we protect your business against the 6 key types of document fraud:
- Forged documents
- Counterfeit documents
- Blank stolen documents
- Fantasy or camouflage documents
- Impostor or ‘look-a-like’ documents
- Compromised documents
Conventionally, you have to rely on signals to trust a new user - on a device IP, a phone number, or credit database look-up. But these signals can also be exploited by imposters. This creates constant uncertainty, so you can’t focus on the user's experience, and instead start treating them with doubt.
nCore platform integrated with the document verification service provider called Onfido which lets your users scan a photo ID from their mobile device, before checking if it's genuine.
Please note that the Identity verification is applicable only for a user type INDIVIDUAL. In addition to that, user identity verification is only applicable for the customers who are using the SDK to upload documents.
High level identity verification steps
The high level identification verification steps are given below:
- 1.Enable tenant level settings
- 2.Create webhook i.e. IDENTITY_VERIFICATION
- 3.Create a user
- 4.Receive webhook having applicant ID and SDK token
- 5.Initialize SDK and Upload documents via Mobile SDK
- 6.Inform document uploaded successfully after a successful upload
- 7.Identification verification processing started by nCore platform
- 8.Identification verification processing finished successfully, the user is transitioned from PENDINGIDVERIFICATION to PENDINGKYC
- 9.nCore platform Inform by a webhook notification that the process is completed successfully
Step by Step process
Step by step process is given below to configure and perform a successful identification verification process.
Tenant level settings
Following are the settings that are required to be enabled at tenant level for Identity Verification.
Field Name
Field Type
Description
require_document_verification
boolean
This check enables the identity verification process.
checks
enum
Following are the checks you can request to enable at tenant level as per your business need
- DOCUMENT
- FACIAL_SIMILARITY_VIDEO
privacy_notices_read_consent_given
boolean
This parameter indicates that the privacy notices and terms of service have been read and, where specific laws require, that consent has been given for Onfido. This parameter should be set to true after gaining the necessary consent, and if it's set to false the request will fail with a validation error.
Create a webhook
Now create a webhook event as “IDENTITY_VERIFICATION” for receiving a webhook event for applicant id and SDK token generation as shown below:
Create a user
After enabling webhook endpoint, you can create a user by sending a POST request to /users endpoint. Since the parameter require_document_verification is enabled as true at tenant level which means that the user will be created with a user status as PENDINGIDVERIFICATION.
The above sample is given just for reference, please refer to the API Catalog for a complete payload.
Below you can find important restrictions:
- 1.'first_name' and 'last_name' parameters are required in the user profile.
- 2.If address is provided in the user profile, then 'postal_code' and 'country' become required. You can use a postal code of "00000" for countries that do not support postal codes.
- 3.The 'postal_code' of the applicant's address. For UK postal codes, specify the value in the following format: SW4 6EH.
- 4.USA as a country is not supported ('address' > 'country').
- 5.For addresses, the following characters are forbidden: !$%^*=<>.
- 6.For names, the following characters are forbidden: ^!#$%*=<>;{}".
Receive a notification
Once the user is created successfully, you will receive a webhook notification along with the following details as given below:
Webhook notification sample
The system will send a webhook notification event "IDENTITY_VERIFICATION" along with a status_reason_code as "B1" if the user is not verified.
Please note that the SDK token expires in 90 mins.
To renew the SDK token, send a PUT request to /user/{id}:changeStatus endpoint with a value as “B2” in 'status_reason_code' field and ”PENDINGIDVERIFICATION” in 'status' field as shown below:
Be aware that the 'status_reason_code' B2 has been added just for testing purposes, the system should not update the 'status_reason_code' from I0 to B2.
Upload the documents for verification
Now your mobile app user can start uploading the documents.
Prerequisite for this step: The integration between the mobile app user and your backend system.
Trigger user status change for a successful document upload
Once the documents are uploaded successfully, you can send a PUT request to /user/{id}:changeStatus endpoint with a value as “B0” in status_reason_code field and ”PENDINGIDVERIFICATION” in status field as shown below:
Document verification internal process
nCore platform starts identity verification internally.
Receive a successful identity verification notification
Identification verification processing completed successfully, the user is transitioned from PENDINGIDVERIFICATION to PENDINGKYC and you will receive a user status change notification (if configured) as given below.
User status change notification
Also you can check the status by sending a GET request to /user/{id} endpoint:
Response
The above sample is given just for reference, please refer to the API Catalog for a complete payload.
Last modified 1mo ago
Copy link