# Identity Verification

### What kind of data I will get

By using this integration you will be able to verify identity of your customers.

### Integration Scope

You can choose 3 types of checks that will be performed:

* Document Check - verify the authenticity of clients' ID documents by extracting details from them.
* Identity Check - ensure that your clients are who they say they are.
* Proof of Address Check - retrieve information from documents providing proof of address and cross-reference them with your client's information for verification.

### Input

You can configure users' input that will be send to comply cube in order to get the most of the verifications.

<table><thead><tr><th>Field</th><th>Description</th><th>Type</th><th>Required</th><th data-hidden>Description</th><th data-hidden>Required</th></tr></thead><tbody><tr><td>email</td><td>The client's email address.</td><td>string</td><td>Yes</td><td>Email address of the client.</td><td>Yes</td></tr><tr><td>mobile</td><td>The client's mobile number.</td><td>string</td><td>No</td><td>Client's mobile phone number.</td><td>No</td></tr><tr><td>telephone</td><td>The client's telephone number.</td><td>string</td><td>No</td><td>Client's telephone number.</td><td>No</td></tr><tr><td>joinedDate</td><td>The date and time when the client was registered with you. This is relevant for users that migrate existing customers. </td><td>string (format YYYY-MM-DD)</td><td>No</td><td>Date when the client joined (YYYY-MM-DD).</td><td>No</td></tr><tr><td><a href="#persondetails">personDetails</a></td><td>Primary details for a client of type person</td><td>object</td><td>Yes if client is of type person</td><td>Details about the individual client.</td><td></td></tr><tr><td><a href="#companydetails">companyDetails</a></td><td>Primary details for a client of type company</td><td>object</td><td>Yes if client is of type company</td><td>Details about the client's company.</td><td></td></tr><tr><td><a href="#address">address</a></td><td>Primary details of a client's address</td><td>object</td><td>Yes if proof of address check is selected</td><td>Address information related to the client.</td><td>Required when proof of address check selected</td></tr></tbody></table>

### PersonDetails&#x20;

<table><thead><tr><th>Field</th><th>Description</th><th>Type</th><th>Required</th><th data-hidden>Description</th></tr></thead><tbody><tr><td>firstName</td><td>The client's first name. </td><td>string</td><td>Yes (required when client is a person)</td><td>First name of the individual.</td></tr><tr><td>middleName</td><td>The client's middle name.</td><td>string</td><td>No</td><td>Middle name of the individual.</td></tr><tr><td>lastName</td><td>The client's last name.</td><td>string</td><td>Yes (required when client is a person)</td><td>Last name of the individual.</td></tr><tr><td>dob</td><td>The client's date of birth.</td><td>string (format YYYY-MM-DD)</td><td>No</td><td>Date of birth (YYYY-MM-DD).</td></tr><tr><td>gender</td><td>The client's gender.</td><td>string (possible values include: male, female, other)</td><td>No</td><td>Gender of the individual.</td></tr><tr><td>nationality</td><td>The client's nationality.</td><td>string (2 letter country ISO code)</td><td>No</td><td>Nationality of the individual.</td></tr><tr><td>birthCountry</td><td>The client's birth country.</td><td>string (2 letter country ISO code)</td><td>No</td><td>Country of birth of the individual.</td></tr><tr><td>ssn</td><td>The client's SSN (Social Security Number). This is for US clients.</td><td>string</td><td>No</td><td>Social Security Number (if applicable).</td></tr><tr><td>socialInsuranceNumber</td><td>The client's Social Insurance Number. </td><td>string</td><td>No</td><td>Social Insurance Number (if applicable).</td></tr><tr><td>nationalIdentityNumber</td><td>The client's National Identity Number.</td><td>string</td><td>No</td><td>National Identity Number (if applicable).</td></tr><tr><td>taxIdentificationNumber</td><td>The client's Tax Identification Number (TIN).</td><td>string</td><td>No</td><td>Tax Identification Number (if applicable).</td></tr></tbody></table>

### 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.      | <p>string (possible values include: </p><p></p><ol><li><code>sole\_proprietorship</code></li><li><code>private\_limited\_company</code></li><li><code>public\_limited\_company</code></li><li><code>limited\_partnership</code></li><li><code>holding\_company</code></li><li><code>non\_government\_organisation</code></li><li><code>statutory\_company</code></li><li><code>subsidiary\_company</code></li><li><code>unlimited\_partnership</code></li><li><code>charitable\_incorporated\_organisation</code></li><li><code>chartered\_company)</code></li></ol> | No                                  |

### Address

| Field          | Description                                         | Type                                                                                                                                     | Required |
| -------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| type           | Type of address.                                    | <p>string (possible values include: </p><ul><li><code>main</code></li><li><code>alternative</code></li><li><code>other)</code></li></ul> | No       |
| propertyNumber | Property number (if applicable).                    | string                                                                                                                                   | No       |
| buildingName   | Building name (if applicable).                      | string                                                                                                                                   | No       |
| line           | Address line.                                       | string                                                                                                                                   | Yes      |
| city           | City in the address.                                | string                                                                                                                                   | Yes      |
| state          | State in the address.                               | string                                                                                                                                   | No       |
| postalCode     | Postal code of the address.                         | string                                                                                                                                   | No       |
| country        | Country of the address. (2 letter country ISO code) | string (2 letter country ISO code)                                                                                                       | Yes      |
| fromDate       | Start date of residing at this address.             | string (format YYYY-MM-DD)                                                                                                               | No       |
| toDate         | End date of residing at this address.               | string (format YYYY-MM-DD)                                                                                                               | No       |

### Input Example&#x20;

```
{
    "email": "test@transactionlink.io",
    "personDetails": {
        "firstName": "Jan",
        "lastName": "Kowalski"
    },
    "address": {
        "line": "Polna 12/3",
        "city": "Warsaw",
        "country": "PL"
    }
}
```

### Output

```
{
    "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": {
                    "proofOfAddressCheck": {
                        "state": "FINISHED",
                        "document": {
                            "type": "UTILITY_BILL",
                            "createdAt": "2023-08-18T12:55:20.589Z",
                            "updatedAt": "2023-08-18T12:56:10.461Z"
                        },
                        "files": [
                            {
                                "resourceId": "35767679-5979-4845-b279-3fe5b3cca2b4",
                                "resourcePath": "resources/c84db9d5-3e88-4fa2-9211-60f9b9e6b213/35767679-5979-4845-b279-3fe5b3cca2b4/4127107e-d7b2-4d7f-8f1f-494682a8cb3d/image.jpg",
                                "resourceName": "image.jpg"
                            }
                        ],
                        "outcome": "attention",
                        "breakdown": {
                            "extractedData": {
                                "holderDetails": {
                                    "entityName": "JAN KOWALSKI"
                                },
                                "documentDetails": {
                                    "documentType": "utility_bill",
                                    "issuer": "ORANGE"
                                },
                                "addressDetails": {
                                    "address": {
                                        "country": "PL"
                                    },
                                    "addressLine": "01-111 WARSZAWA ŻEROMSKIEGO 1 m.54",
                                    "addressCountry": "PL"
                                },
                                "geoLocationDetails": {
                                    "ipAddressLatLong": "51.236778259277344,22.619970321655273",
                                    "ipAddressCountry": "PL"
                                }
                            },
                            "clientValidation": {
                                "firstName": "clear",
                                "lastName": "clear",
                                "address": "clear"
                            },
                            "contentAnalysis": {
                                "documentAge": "attention"
                            },
                            "geoLocationAnalysis": {
                                "ipInAddressCountry": "clear",
                                "ipProximityToAddress": "attention"
                            }
                        }
                    },
                    "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": "attention",
                        "breakdown": {
                            "extractedData": {
                                "holderDetails": {
                                    "lastName": [
                                        "KOWALSKI"
                                    ],
                                    "firstName": [
                                        "JAN",
                                        "KACPER"
                                    ],
                                    "dob": {
                                        "day": 5,
                                        "month": 12,
                                        "year": 1992
                                    },
                                    "age": 41,
                                    "birthPlace": "WARSZAWA",
                                    "gender": "male",
                                    "address": {
                                        "addressText": "01-111 WARSZAWA ŻEROMSKIEGO 1 m.54",
                                        "country": "PL"
                                    }
                                },
                                "documentDetails": {
                                    "documentNumber": "123123123",
                                    "documentType": "driving_license",
                                    "documentSubtypes": [
                                        "Poland - Driving License (2004)",
                                        "Poland - Driving License (2004) Side B"
                                    ],
                                    "issuingCountry": "PL",
                                    "issuingAuthority": "PREZYDENT MIASTA WARSZAWA",
                                    "issuingDate": {
                                        "day": 23,
                                        "month": 5,
                                        "year": 2023
                                    },
                                    "personalNumber": "92010123412",
                                    "hasTwoSides": true
                                },
                                "allExtractedData": {
                                    "visual": {
                                        "lastName": [
                                            "KOWALSKI"
                                        ],
                                        "lastNameNative": "KOWALSKI",
                                        "firstName": [
                                            "JAN",
                                            "KACPER"
                                        ],
                                        "firstNameNative": "JAN KACPER",
                                        "entityNameNative": "KOWALSKI JAN KACPER",
                                        "dob": {
                                            "day": 24,
                                            "month": 5,
                                            "year": 1982
                                        },
                                        "birthPlace": "WARSZAWA",
                                        "birthPlaceNative": "WARSZAWA",
                                        "gender": "male",
                                        "documentNumber": "12381293123",
                                        "personalNumber": "92010123412",
                                        "issuingCountry": "PL",
                                        "issuingAuthority": "PREZYDENT MIASTA WARSZAWA",
                                        "issuingAuthorityNative": "PREZYDENT MIASTA WARSZAWA",
                                        "issuingDate": {
                                            "day": 14,
                                            "month": 4,
                                            "year": 2009
                                        },
                                        "addressText": "01-111 WARSZAWA ŻEROMSKIEGO 1 m.54"
                                    }
                                }
                            },
                            "mrzAnalysis": {
                                "mrzChecksum": "not_processed",
                                "mrzFormat": "not_processed"
                            },
                            "contentAnalysis": {
                                "expirationDate": "not_processed",
                                "specimenCheck": "clear",
                                "blackListCheck": "clear",
                                "dataIntegrity": "clear"
                            },
                            "clientValidation": {
                                "ageVerification": "clear",
                                "clientDataConsistency": "attention"
                            },
                            "consistencyAnalysis": {
                                "firstName": "not_processed",
                                "lastName": "not_processed",
                                "documentNumber": "not_processed",
                                "nationality": "not_processed",
                                "issuingDate": "not_processed",
                                "expirationDate": "not_processed",
                                "dob": "not_processed"
                            },
                            "extractedImages": [
                                {
                                    "type": "front_side",
                                    "index": 0,
                                    "data": ""
                                },
                                {
                                    "type": "front_side",
                                    "index": 1,
                                    "data": ""
                                },
                                {
                                    "type": "extracted_face",
                                    "index": 2,
                                    "data": ""
                                },
                                {
                                    "type": "extracted_security_element",
                                    "index": 3,
                                    "data": ""
                                },
                                {
                                    "type": "extracted_signature",
                                    "index": 4,
                                    "data": ""
                                },
                                {
                                    "type": "extracted_code",
                                    "index": 5,
                                    "data": ""
                                }
                            ],
                            "forensicAnalysis": {
                                "mrzVisualPlacement": "not_processed",
                                "securityElements": "attention",
                                "photoLocation": "clear",
                                "mrzClassification": "not_processed",
                                "documentLivenessCheck": "clear",
                                "tamperingDetected": "not_processed",
                                "breakdown": {
                                    "documentFrontLivenessScore": 71,
                                    "documentBackLivenessScore": 73
                                }
                            },
                            "formatAnalysis": {
                                "modelIdentification": "clear",
                                "countryModelValidity": "clear",
                                "documentModelValidity": "clear",
                                "photocopyDetected": "clear"
                            },
                            "frontAndBackAnalysis": {
                                "formatAnalysis": "not_processed",
                                "dataConsistency": "not_processed"
                            },
                            "securityAndPatternAnalysis": [
                                {
                                    "similarity": 72,
                                    "outcome": "clear",
                                    "narrative": "Clear",
                                    "index": 0,
                                    "actualImageData": "",
                                    "expectedImageData": ""
                                },
                                {
                                    "similarity": 90,
                                    "outcome": "clear",
                                    "narrative": "Clear",
                                    "index": 1,
                                    "actualImageData": "",
                                    "expectedImageData": ""
                                },
                                {
                                    "outcome": "clear",
                                    "narrative": "Clear"
                                },
                                {
                                    "outcome": "clear",
                                    "narrative": "Clear"
                                },
                                {
                                    "outcome": "attention",
                                    "narrative": "Not all barcodes read"
                                },
                                {
                                    "similarity": 96,
                                    "outcome": "clear",
                                    "narrative": "Clear",
                                    "index": 5,
                                    "actualImageData": "",
                                    "expectedImageData": ""
                                }
                            ]
                        }
                    },
                    "identityCheck": {
                        "state": "FINISHED",
                        "document": {
                            "type": "DRIVING_LICENSE",
                            "issuingCountry": "PL",
                            "createdAt": "2023-08-18T12:50:27.062Z",
                            "updatedAt": "2023-08-18T12:54:50.285Z"
                        },
                        "files": [
                            {
                                "resourceId": "e652dc6e-22cc-4f47-8e90-fcaa8e0be1a7",
                                "resourcePath": "resources/c84db9d5-3e88-4fa2-9211-60f9b9e6b213/e652dc6e-22cc-4f47-8e90-fcaa8e0be1a7/4127107e-d7b2-4d7f-8f1f-494682a8cb3d/selfie_1692363309716.jpg",
                                "resourceName": "selfie_1692363309716.jpg"
                            }
                        ],
                        "outcome": "attention",
                        "breakdown": {
                            "faceAnalysis": {
                                "facialSimilarity": "clear",
                                "previouslyEnrolledFace": "attention",
                                "breakdown": {
                                    "facialSimilarityScore": 96,
                                    "enrolledFacesMatches": [
                                        {
                                            "clientId": "64d4b36429c7ae0008b37a25",
                                            "facialSimilarityScore": 100,
                                            "entityName": "Jan Kowalski",
                                            "livePhotoId": "64d4b3dab4209f0008ddf2dc"
                                        }
                                    ]
                                }
                            },
                            "authenticityAnalysis": {
                                "spoofedImageAnalysis": "clear",
                                "livenessCheck": "clear",
                                "breakdown": {
                                    "livenessCheckScore": 98
                                }
                            },
                            "integrityAnalysis": {
                                "faceDetection": "clear",
                                "vpnDetected": "clear"
                            }
                        }
                    }
                }
            }
        ]
    }
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.transactionlink.io/docs/v1/integrations/complycube/identity-verification.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.