📝 An overview of fields to use and not to use.
1. Identity Verification Results
We will discuss the fields used to verify the results for identity verification.
Results
We have the overall results and the results of each check. The Recommended and Not Recommended fields of results are mentioned in the following table.
Note:
There will be two kinds of fields:
- Recommended: means the fields accepted and endorsed as true.
- Not Recommended: means the fields that are not accepted and endorsed as true.
| Checks | Description | Recommended Fields | Not Recommended Fields |
|---|---|---|---|
| Document Fraud Check | This is used to check for any kind of document fraud and to know whether the document is genuine or not. Note: The field documents[index].asf_breakdown is Recommended if DFA on the second document is enabled. | results.documents | documents[index].asf_breakdown |
| Liveness Check | To confirm that a live person is being presented in the application process, i.e., pre-recorded images are not being used. | results.liveness | spoof_result |
| Facematch Check | This checks that the person is the same as the person shown on the ID document. | results.facematch | likeness_overall |
| Data Provider Check | To give the copied data of data providers equipped by the Data provider, such as ID Matrix and Data Connect. | results.data | data_provider.DATA_CONNECT.overall or data_provider.ID_MATRIX.overall |
| Overall Result | This is used to check for overall results. | results.overall |
2. Customer Information
Customer Information contains the details of users and customer-confirmed data such as address, etc.
User Details
The Recommended and Not Recommended fields of customer confirmed data are discussed in the table below:
| Categories | Description | Recommended Fields | Not Recommended Fields |
|---|---|---|---|
| User Details | To check data extracted from the submitted document and link the customer's information with the ID document. | user_details | documents[index].submitted_data and documents[index].extracted |
| Address | To check and verify the address. | user_details.address | submitted_data.address and extracted.address |
| Country Code | To check and verify the country code. | user_details.country_code | user_details.address.country |
| Document Type | To check what kind of document has been submitted. | user_details.document_type | documents[index].identity_document_type and documents[index].extracted.document_typeand documents[index].submitted_data.document_type |
Info:
The fields below are optional.
3. Document Images
Documents
The Documents contain the image URLs of the captured documents, including cropped and originals.
4. Liveness Videos/Selfies
Liveness Attempts
The liveness_attempts contains the selfie image or the liveness video URL.
5. Liveness Face Frame
Facematch Best Frame
The facematch_best_frame contains the image URL of the extracted face frame from the liveness video.
💬 We Are Here to Help!
If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.