Document Check
What kind of data I will get
By using this integration you will be able to verify identity customers' documents.
Integration Scope
You can choose which of the document types user will be allowed to pass. These include
national identity card
driving licence
passport
resident permit
Input
You can configure users' input that will be send to comply cube in order to get the most of the verifications.
Field | Description | Type | Required |
---|---|---|---|
The client's email address. | string | Yes | |
mobile | The client's mobile number. | string | No |
telephone | The client's telephone number. | string | No |
joinedDate | The date and time when the client was registered with you. This is relevant for users that migrate existing customers. | string (format YYYY-MM-DD) | No |
Primary details for a client of type person | object | Yes if client is of type person | |
Primary details for a client of type company | object | Yes if client is of type company | |
Primary details of a client's address | object | Yes if proof of address check is selected |
PersonDetails
Field | Description | Type | Required |
---|---|---|---|
firstName | The client's first name. | string | Yes (required when client is a person) |
middleName | The client's middle name. | string | No |
lastName | The client's last name. | string | Yes (required when client is a person) |
dob | The client's date of birth. | string (format YYYY-MM-DD) | No |
gender | The client's gender. | string (possible values include: male, female, other) | No |
nationality | The client's nationality. | string (2 letter country ISO code) | No |
birthCountry | The client's birth country. | string (2 letter country ISO code) | No |
ssn | The client's SSN (Social Security Number). This is for US clients. | string | No |
socialInsuranceNumber | The client's Social Insurance Number. | string | No |
nationalIdentityNumber | The client's National Identity Number. | string | No |
taxIdentificationNumber | The client's Tax Identification Number (TIN). | string | No |
CompanyDetails
Field | Description | Type | Required |
---|---|---|---|
name | Name of the company. | string | Yes (required if client is company) |
website | Website of the company. | string | No |
registrationNumber | Registration number of the company. | string | No |
incorporationCountry | Country where the company is incorporated. | string (2 letter country ISO code) | No |
incorporationType | Type of incorporation of the company. | string (possible values include:
| No |
Input Example
Output
Attribute | Type | Description |
---|---|---|
object | Comply Cube client details. | |
map | Results of performed checks. |
Client
Attribute | Type | Description |
---|---|---|
id | string | The unique identifier for a client. |
type | string, possible values include:
| The type of client. |
entityName | string | The client's full name. |
string | The client's email address. | |
object | Details for a client of type | |
companyDetails | object | Details for a client of type |
createdAt | string | The date and time when the client was created. |
updatedAt | string | The date and time when the client was updated. |
Person Details
Attribute | Type | Description |
---|---|---|
firstName | string | The client's first name. |
lastName | string | The client's last name. |
Company Details
Attribute | Type | Description |
---|---|---|
name | string | The client's name. |
Checks Result
Attribute | Type | Description |
---|---|---|
string | Result of the document check. |
Document Check
Attribute | Type | Description |
---|---|---|
state | string, possible values include:
| The status of the client's verification |
object | Document which was used to verification process. | |
files | links | Links that allow to download client's documents. |
outcome | string, possible values include:
| The outcome attribute represents the overall check result. Returned values include:
|
object | Details of verification. | |
object | The MRZ analysis results. | |
object | The consistency analysis results. | |
object | The content analysis results. | |
object | The format analysis results. | |
object | The forensic analysis results. | |
object | The front and back of the image analysis results. | |
object | The client validation results. | |
array<object> | The images extracted from the document. | |
object | The security and pattern analysis results. |
Document
Attribute | Type | Description |
---|---|---|
type | string, valid values include:
| The type of document. |
issuingCountry | string | The document's issuing country. This will be the two-letter country ISO code. |
createdAt | string | The date and time when the document was created. |
updatedAt | string | The date and time when the document was updated. |
Breakdown
Attribute | Type | Description |
---|---|---|
object | The data extracted using Optical Character Recognition (OCR). | |
object | All the data extracted from the document, including data in native scripts, organized by source (e.g. Visual, MRZ, and barcode) |
Extracted Data
Attribute | Type | Description |
---|---|---|
object | Data relating to the document. | |
object | Data relating to the document holder. |
Document Details
Property | Type | Description |
---|---|---|
documentType | string, possible values include:
| Detected document type. |
hasTwoSides | boolean | A boolean indicating if both sides of the document were used for the analysis. |
issuingCountry | string | The issuing country of the document. This will be the two-letter country ISO code. |
object | Expiry date of the document. | |
documentNumber | string | Document number. |
personalNumber | string | Personal number (if available). |
object | Issuing date of the document. | |
issuingPlace | string | Issuing place of the document. |
issuingAuthority | string | Issuing authority of the document. |
additionalDetails | array | Any additional details extracted from the document. This will be returned as an array of key/value pair objects. |
documentDiscriminator | string | Document discriminator. |
cardAccessNumber | string | Card access number. |
mrz | object | The Machine Readable Zone (MRZ), which is usually at the bottom of the identity page of a passport or the back of an identity card, can be up to 3 lines depending on the document type:
|
Holder Details
Property | Type | Description |
---|---|---|
firstName | array<string> | The list of first/given names as an array. |
lastName | array<string> | The list of last names as an array. |
object | The date of birth. | |
age | number | The age of the document holder. |
birthPlace | string | Birthplace. |
nationality | string | The nationality. This will be the two-letter country ISO code. |
taxIdentificationNumber | string | Tax Identification Number (TIN). |
healthInsuranceNumber | string | Health insurance number. |
gender | string, values include:
| Gender of the document holder. |
Date
Attribute | Type | Description |
---|---|---|
day | number | The day of the month. Value range |
month | number | The month. Value range |
year | number | The year, in |
All extracted Data
Attribute | Type | Description |
---|---|---|
object | All data extracted through the Visual Inspection Zone (VIZ). | |
object | All data extracted through the barcode or QR code. | |
object | All data extracted through the MRZ. |
For each conducted analysis, the returned values include:
clear
: Indicates the analysis returned a successful result.attention
: Indicates a potential falsified or fraudulent document.not_processed
: Returned when the analysis does not apply to a document type, e.g. MRZ Analysis on a document without an MRZ. It will also be returned if ComplyCube does not support a given country's particular analysis for a document type.
MRZ Analysis
Attribute | Type | Description |
---|---|---|
mrzFormat | string | Indicates whether the MRZ checksum test is valid. |
mrzChecksum | string | Indicates whether the MRZ checksum test is valid. |
Consistency Analysis
Attribute | Type | Description |
---|---|---|
lastName | string | Indicates whether the first name on the document and MRZ are consistent. |
firstName | string | Indicates whether the last name on the document and MRZ are consistent. |
dob | string | Indicates whether the birth date on the document and MRZ are consistent. |
documentNumber | string | Indicates whether the document number on the document and MRZ are consistent. |
personalNumber | string | Indicates whether the personal number on the document and MRZ are consistent. |
expirationDate | string | Indicates whether the expiry date on the document and MRZ are consistent. |
issuingDate | string | Indicates whether issuing date on the document and MRZ are consistent. |
Content Analysis
Attribute | Type | Description |
---|---|---|
dataIntegrity | string | Indicates whether the extracted data passes our integrity check. |
issuingDate | string | Indicates whether issuing date has valid content. |
expirationDate | string | Indicates whether the expiration date has valid content. |
nationality | string | Indicates whether nationality has valid content. |
specimenCheck | string | Indicates whether the content has been copied from the internet. |
blackListCheck | string | Indicates a competent authority blacklisted the ID document. |
Format Analysis
Attribute | Type | Description |
---|---|---|
modelIdentification | string | Indicates whether the document model has been identified. |
countryModelValidity | string | Indicates whether the document model adheres to the issuing country specifications. |
documentModelValidity | string | Indicates whether the document model adheres to the document type specifications. |
photocopyDetected | string | Indicates whether the document is a black and white photocopy. |
Forensic Analysis
Attribute | Type | Description |
---|---|---|
documentLivenessCheck | string | Indicates if the document image is genuine and not a photo-of-an-image or photo-of-a-screen. |
tamperingDetected | string | Indicates if the document image is tampered with using image manipulation software, such as Photoshop. |
daylightAnalysis | string | Indicates whether the document daylight colours are valid. |
mrzVisualPlacement | string | Indicates whether the MRZ is in the right location and not tampered with. |
securityElements | string | Indicates whether the document security elements are valid. |
photoLocation | string | Indicates whether the photo is in the correct location for a given document type. |
mrzClassification | string | Indicates whether the MRZ is consistent with the document type. |
object | Breakdown related to forensic analysis. |
Forensic Analysis Breakdown
Attribute | Type | Description |
---|---|---|
documentFrontLivenessScore | number | Indicates the liveness score of the front side image of the document. The score will be 100 when it is assumed to be authentic. |
documentBackLivenessScore | number | Indicates the liveness score of the back side image of the document. The score will be 100 when it is assumed to be authentic. |
Front And Back Analysis
Attribute | Type | Description |
---|---|---|
formatAnalysis | string | Indicates that both sides of the document are following the document type and country specifications. |
dataConsistency | string | Indicates whether data on both sides of the document are consistent. |
Client Validation
Attribute | Type | Description |
---|---|---|
ageVerification | string | Indicates whether the extracted age is greater than or equal to a predefined minimum accepted age. |
clientDataConsistency | string | Indicates whether the client data (e.g. first and last names) corresponds with data extracted from the ID. |
Extracted Images
Property | Type | Description |
---|---|---|
type | string, possible values include:
| Extracted image type. |
data | string | BASE64 encoded image data. |
Security And Pattern Analysis
Attribute | Type | Description |
---|---|---|
similarity | string | The similarity score between the expected and actual image patterns. The higher the score, the more likely the document is authentic. |
outcome | string | The outcome of the analysis. This can be |
narrative | string | A description of the analysis performed. |
actualImageData | string | The |
expectedImageData | string | The |
Output Example
Last updated