# Identity Check

### Output

| Attribute                      | Type   | Description                  |
| ------------------------------ | ------ | ---------------------------- |
| [client](#client)              | object | Comply Cube client details.  |
| [checksResult](#checks-result) | map    | Results of performed checks. |

### Client

<table><thead><tr><th>Attribute</th><th width="260.3333333333333">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>string</td><td>The unique identifier for a client.</td></tr><tr><td>type</td><td><p>string, possible values include:</p><ul><li><code>person</code></li><li><code>company</code></li></ul></td><td>The type of client. </td></tr><tr><td>entityName</td><td>string</td><td>The client's full name.</td></tr><tr><td>email</td><td>string</td><td>The client's email address.</td></tr><tr><td><a href="#person-details">personDetails</a></td><td>object</td><td>Details for a client of type <code>person</code>.</td></tr><tr><td>companyDetails</td><td>object</td><td>Details for a client of type <code>company</code>.</td></tr><tr><td>createdAt</td><td>string</td><td>The date and time when the client was created.</td></tr><tr><td>updatedAt</td><td>string</td><td>The date and time when the client was updated.</td></tr></tbody></table>

### 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                   |
| -------------------------------- | ------ | ----------------------------- |
| [identityCheck](#identity-check) | string | Result of the identity check. |

### Identity Check

| Attribute             | Type                                                                                                                                                                                                      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| state                 | <p>string, possible values include: </p><ul><li><code>INIT</code></li><li><code>IN\_PROGRESS</code></li><li><code>ERROR</code></li><li><code>FAILED</code></li><li><code>FINISHED</code></li></ul><p></p> | 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               | <p>string, possible values include: </p><ul><li>clear</li><li>attention</li><li>not\_processed</li></ul>                                                                                                  | <p></p><p>The outcome attribute represents the overall check result. Returned values include:</p><ol><li><code>clear</code>: Indicates every <a href="https://docs.complycube.com/documentation/checks/document-check#analysis-performed">analysis type</a> conducted returned a successful result, and hence the document is authentic.</li><li><code>attention</code>: Indicates at least one of the analysis results requires attention.</li><li><p><code>not\_processed</code>: Indicates that ComplyCube was not able to process the images. Reasons include:</p><ul><li>The image is of <strong>low</strong> <strong>quality</strong>.</li><li>The image is <strong>blurred</strong> or <strong>glared</strong>.</li><li>The image is at an <strong>angle</strong>.</li><li>The <strong>ID type and country</strong> provided do not correspond with the actual document provided uploaded. </li></ul></li></ol> |
| breakdown             | object                                                                                                                                                                                                    | Details of verification.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |

### Document

| Attribute      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Description                                                                                                                       |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| type           | <p>string,</p><p>valid values include:</p><ol><li><code>passport</code></li><li><code>driving\_license</code></li><li><code>national\_insurance\_number</code></li><li><code>social\_security\_number</code></li><li><code>utility\_bill</code></li><li><code>tax\_identification\_number</code></li><li><code>national\_identity\_card</code></li><li><code>visa</code></li><li><code>polling\_card</code></li><li><code>residence\_permit</code></li><li><code>birth\_certificate</code></li><li><code>bank\_statement</code></li><li><code>change\_of\_name</code></li><li><code>tax\_document</code></li><li><code>company\_confirmation\_statement</code></li><li><code>company\_annual\_accounts</code></li><li><code>company\_statement\_of\_capital</code></li><li><code>company\_change\_of\_address</code></li><li><code>company\_incorporation</code></li><li><code>company\_change\_of\_officers</code></li><li><code>company\_change\_of\_beneficial\_owners</code></li><li><code>unknown</code></li><li><code>other</code></li></ol> | 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

| Property                                       | Type   | Description                     |
| ---------------------------------------------- | ------ | ------------------------------- |
| [faceAnalysis](#face-analysis)                 | object | The facial analysis results.    |
| [authenticityAnalysis](#authenticity-analysis) | object | The facial analysis results.    |
| [integrityAnalysis](#integrity-analysis)       | object | The integrity analysis results. |

### Face Analysis

| Attribute                             | Type   | Description                                                                                                |
| ------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------- |
| faceDetection                         | string | Indicates whether a face is detected and that number of faces detected on the ID and live photo are valid. |
| facialSimilarity                      | string | Indicates whether the faces on the live photo and document belong to the same person.                      |
| previouslyEnrolledFace                | string | Indicates whether the face on the live photo has been previously enrolled as a different client.           |
| [breakdown](#face-analysis-breakdown) | object | <p></p><p>Breakdown related to facial analysis.</p>                                                        |

### Face Analysis Breakdown

| Attribute                                       | Type           | Description                                                                                                               |
| ----------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------- |
| facialSimilarityScore                           | number         | Indicates the similarity level of whether two faces belong to the same person. The score will be 100 for a perfect match. |
| [enrolledFacesMatches](#enrolled-faces-matches) | array\<object> | If a face is deemed to have been enrolled previously, this will contain an array of objects.                              |

### **Enrolled Faces Matches**

| Attribute             | Type   | Description                                                                                 |
| --------------------- | ------ | ------------------------------------------------------------------------------------------- |
| clientId              | string | Unique identifier for the matching client.                                                  |
| entityName            | string | Full name of the client.                                                                    |
| livePhotoId           | string | Unique identifier for the matching live photo.                                              |
| facialSimilarityScore | number | The similarity level of the client's face against the live photo associated with the check. |

### **Authenticity Analysis**

| Attribute                                     | Type   | Description                                                                 |
| --------------------------------------------- | ------ | --------------------------------------------------------------------------- |
| spoofedImageAnalysis                          | string | Indicates whether images are spoofed, copied from internet, or blacklisted. |
| livenessCheck                                 | string | Indicates if live photo is genuine and not a photo-of-an-image or screen.   |
| [breakdown](#authenticity-analysis-breakdown) | object | Breakdown related to authenticity analysis.                                 |

### A**uthenticity Analysis Breakdown**

| Attribute            | Type           | Description                                                                                               |
| -------------------- | -------------- | --------------------------------------------------------------------------------------------------------- |
| specimenCheckMatches | array\<string> | If an image is deemed copied from the internet, this will contain an array of URLs pointing to the image. |
| livenessCheckScore   | number         | Indicates the liveness score of the live photo. The score will be 100 when it is assumed to be authentic. |

### **Integrity Analysis**

| Attribute     | Type   | Description                                               |
| ------------- | ------ | --------------------------------------------------------- |
| faceDetection | string | Indicates whether expected number of faces are detected.  |
| vpnDetected   | string | Indicates if client used a Virtual Private Network (VPN). |

### 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"
                },
                "checksResult": {
                    "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": "clear",
                        "breakdown": {
                            "faceAnalysis": {
                                "faceDetection": "clear",
                                "facialSimilarity": "clear",
                                "previouslyEnrolledFace": "clear",
                                "breakdown": {
                                    "facialSimilarityScore": 100
                                }
                            },
                            "authenticityAnalysis": {
                                "spoofedImageAnalysis": "clear",
                                "livenessCheck": "clear",
                                "breakdown": {
                                    "livenessCheckScore": 100
                                }
                            },
                            "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/identity-check.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.