> For the complete documentation index, see [llms.txt](https://docs.transactionlink.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.transactionlink.io/docs/v1/integrations/complycube/identity-verification/document-check.md). # Document Check ### Output | Attribute | Type | Description | | ------------------------------ | ------ | ---------------------------- | | [client](#client) | object | Comply Cube client details. | | [checksResult](#checks-result) | map | Results of performed checks. | ### Client
AttributeTypeDescription
idstringThe unique identifier for a client.
type

string, possible values include:

  • person
  • company
The type of client.
entityNamestringThe client's full name.
emailstringThe client's email address.
personDetailsobjectDetails for a client of type person.
companyDetailsobjectDetails for a client of type company.
createdAtstringThe date and time when the client was created.
updatedAtstringThe 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 | | -------------------------------- | ------ | ----------------------------- | | [documentCheck](#document-check) | string | Result of the document check. | ### Document Check | Attribute | Type | Description | | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | state |

string, possible values include:

| The status of the client's verification | | [document](#document) | 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:

  1. clear: Indicates every analysis type conducted returned a successful result, and hence the document is authentic.
  2. attention: Indicates at least one of the analysis results requires attention.

  3. not\_processed: Indicates that ComplyCube was not able to process the images. Reasons include:

| | [breakdown](#breakdown) | object | Details of verification. | | [mrzAnalysis](#mrz-analysis) | object | The MRZ analysis results. | | [consistencyAnalysis](#consistencyanalysis-object) | object | The consistency analysis results. | | [contentAnalysis](#content-analysis) | object | The content analysis results. | | [formatAnalysis](#format-analysis) | object | The format analysis results. | | [forensicAnalysis](#forensic-analysis) | object | The forensic analysis results. | | [frontAndBackAnalysis](#front-and-back-analysis) | object | The front and back of the image analysis results. | | [clientValidation](#client-validation) | object | The client validation results. | | [extractedImages](#extracted-images) | array\ | The images extracted from the document. | | [securityAndPatternAnalysis](#securityandpatternanalysis-array) | object | The security and pattern analysis results. | ### Document | Attribute | Type | Description | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | type |

string,

valid values include:

  1. passport
  2. driving\_license
  3. national\_insurance\_number
  4. social\_security\_number
  5. utility\_bill
  6. tax\_identification\_number
  7. national\_identity\_card
  8. visa
  9. polling\_card
  10. residence\_permit
  11. birth\_certificate
  12. bank\_statement
  13. change\_of\_name
  14. tax\_document
  15. company\_confirmation\_statement
  16. company\_annual\_accounts
  17. company\_statement\_of\_capital
  18. company\_change\_of\_address
  19. company\_incorporation
  20. company\_change\_of\_officers
  21. company\_change\_of\_beneficial\_owners
  22. unknown
  23. other
| The type of document. | | issuingCountry | string | The document's issuing country. This will be the [two-letter country ISO code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). | | 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 | | --------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------- | | [extractedData](#extracted-data) | object | The data extracted using [Optical Character Recognition (OCR)](https://en.wikipedia.org/wiki/Optical_character_recognition). | | [allExtractedData](#all-extracted-data) | 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 | | ------------------------------------ | ------ | ------------------------------------- | | [documentDetails](#document-details) | object | Data relating to the document. | | [holderDetails](#holder-details) | 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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). | | [expirationDate](#date) | object | Expiry date of the document. | | documentNumber | string | Document number. | | personalNumber | string | Personal number (if available). | | [issuingDate](#date) | 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\ | The list of first/given names as an array. | | lastName | array\ | The list of last names as an array. | | [dob](#date) | 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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). | | taxIdentificationNumber | string | Tax Identification Number (TIN). | | healthInsuranceNumber | string | Health insurance number. | | gender |

string, values include:

  • male
  • female
  • other
| Gender of the document holder. | ### Date | Attribute | Type | Description | | --------- | ------ | ----------------------------------------- | | day | number | The day of the month. Value range `1-31`. | | month | number | The month. Value range `1-12`. | | year | number | The year, in `YYYY` format. | ### All extracted Data | Attribute | Type | Description | | --------------------- | ------ | ------------------------------------------------------------ | | [visual](#visual) | object | All data extracted through the Visual Inspection Zone (VIZ). | | [barcode](#breakdown) | object | All data extracted through the barcode or QR code. | | [mrz](#mrz-analysis) | object | All data extracted through the MRZ. | For each conducted analysis, the returned values include: 1. `clear`: Indicates the analysis returned a successful result. 2. `attention`: Indicates a potential falsified or fraudulent document. 3. `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. | | [breakdown](#forensic-analysis-breakdown) | 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:

  • front\_side
  • back\_side
  • extracted\_face
  • extracted\_signature
  • extracted\_security\_element
  • extracted\_code
  • extracted\_fingerprint
| 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 `clear` or `attention.` | | narrative | string | A description of the analysis performed. | | actualImageData | string | The `BASE64` encoded data of the actual extracted security element pattern. | | expectedImageData | string | The `BASE64` encoded data of the expected security element's pattern. | ### Example ``` { "complyCube": { "idVerification": [ { "client": { "id": "64df68fabc1c610008bbb1b9", "type": "person", "entityName": "Jan Kowalski", "email": "jkowalski@transactionlink.io", "personDetails": { "firstName": "Jan", "lastName": "Kowalski" }, "createdAt": "2023-08-18T12:50:02.168Z", "updatedAt": "2023-08-18T12:50:02.168Z" }, "address": { "id": "64df68fabc1c610008bbb1bb", "clientId": "64df68fabc1c610008bbb1b9", "line": "ŻEROMSKIEGO", "city": "WARSZAWA", "country": "PL", "createdAt": "2023-08-18T12:50:02.488Z", "updatedAt": "2023-08-18T12:50:02.488Z" }, "checksResult": { "documentCheck": { "state": "FINISHED", "document": { "type": "DRIVING_LICENSE", "issuingCountry": "PL", "createdAt": "2023-08-18T12:50:27.062Z", "updatedAt": "2023-08-18T12:54:50.285Z" }, "files": [ { "resourceId": "1f838498-f3c3-41a5-b01c-7d18d89ec871", "resourcePath": "resources/c84db9d5-3e88-4fa2-9211-60f9b9e6b213/1f838498-f3c3-41a5-b01c-7d18d89ec871/4127107e-d7b2-4d7f-8f1f-494682a8cb3d/document_capture.jpeg", "resourceName": "document_capture.jpeg" }, { "resourceId": "f12430da-3c49-4843-8dcf-1a0eab4122ce", "resourcePath": "resources/c84db9d5-3e88-4fa2-9211-60f9b9e6b213/f12430da-3c49-4843-8dcf-1a0eab4122ce/4127107e-d7b2-4d7f-8f1f-494682a8cb3d/document_capture.jpeg", "resourceName": "document_capture.jpeg" } ], "outcome": "clear", "breakdown": { "extractedData": { "documentDetails": { "documentType": "driving_license", "hasTwoSides": true, "issuingCountry": "GB", "issuingDate": { "day": 1, "month": 1, "year": 2015 }, "expirationDate": { "day": 1, "month": 1, "year": 2025 }, "documentNumber": "123456790", "personalNumber": "123456790" }, "holderDetails": { "lastName": [ "DOE" ], "firstName": [ "JOHN" ], "dob": { "day": 3, "month": 9, "year": 1995 }, "address": { "addressText": "110 MAPLE ROAD, SAMPLE CITY, NC 10000-0008", "line": "110 MAPLE ROAD", "city": "SAMPLE CITY", "state": "North Carolina", "postalCode": "10000-0008", "country": "US" } } }, "allExtractedData": { "visual": { "lastName": [ "DOE" ], "firstName": [ "JOHN" ], "dob": { "day": 3, "month": 9, "year": 1995 }, "age": 26, "gender": "male", "documentNumber": "123456790", "documentDiscriminator": "123456790", "issuingDate": { "day": 1, "month": 1, "year": 2015 }, "expirationDate": { "day": 1, "month": 1, "year": 2025 }, "addressText": "110 MAPLE ROAD, SAMPLE CITY, NC 10000-0008", "addressLine": "110 MAPLE ROAD", "addressCity": "SAMPLE CITY", "addressPostalCode": "10000-0008", "height": "175 cm" }, "barcode": { "lastName": [ "DOE" ], "firstName": [ "JOHN" ], "dob": { "day": 3, "month": 9, "year": 1995 }, "gender": "male", "documentNumber": "123456790", "documentDiscriminator": "123456790", "issuingCountry": "US", "issuingDate": { "day": 15, "month": 11, "year": 2018 }, "expirationDate": { "day": 29, "month": 9, "year": 2026 }, "addressText": "110 MAPLE ROAD, SAMPLE CITY, NC 10000-0008", "addressLine": "110 MAPLE ROAD", "addressCity": "SAMPLE CITY", "addressPostalCode": "10000-0008", "addressState": "North Carolina", "addressCountry": "US", "height": "175 cm" } } }, "mrzAnalysis": { "mrzFormat": "clear", "mrzChecksum": "clear" }, "consistencyAnalysis": { "lastName": "clear", "firstName": "clear", "dob": "clear", "documentNumber": "clear", "personalNumber": "clear", "expirationDate": "clear", "issuingDate": "clear" }, "contentAnalysis": { "dataIntegrity": "clear", "issuingDate": "clear", "expirationDate": "clear", "specimenCheck": "clear", "blackListCheck": "clear" }, "formatAnalysis": { "modelIdentification": "clear", "countryModelValidity": "clear", "documentModelValidity": "clear", "photocopyDetected": "clear" }, "forensicAnalysis": { "documentLivenessCheck": "clear", "tamperingDetected": "clear", "mrzVisualPlacement": "clear", "securityElements": "clear", "photoLocation": "clear", "mrzClassification": "clear", "breakdown": { "documentFrontLivenessScore": 100, "documentBackLivenessScore": 100 } }, "frontAndBackAnalysis": { "formatAnalysis": "clear", "dataConsistency": "clear" }, "clientValidation": { "ageVerification": "clear", "clientDataConsistency": "clear" }, "extractedImages": [ { "type": "front_side", "data": "" } ], "securityAndPatternAnalysis": [ { "similarity": 100, "outcome": "clear", "narrative": "Clear", "actualImageData": "", "expectedImageData": "" } ] } } } ] } } ```