# OnDato

### What kind of data I will get

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

### Integration Scope

KYC - An identity verification service is used by businesses to ensure that users or customers provide information that is associated with the identity of a real person.

### Input

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

| Attribute   | Type   | Description                          |
| ----------- | ------ | ------------------------------------ |
| email       | string | Email of the user (Required).        |
| firstName   | string | First name of the user (Optional).   |
| middleName  | string | Middle name of the user (Optional).  |
| lastName    | string | Last name of the user (Optional).    |
| dateOfBirth | string | Date of birth of the user(Optional). |
| pesel       | string | Pesel of the user(Optional).         |
| phoneNumber | string | Phone number of the user (Optional). |
| countryCode | string | Country code of user (Optional).     |

### Output

<table><thead><tr><th>Attribute</th><th width="201.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>state</td><td>string</td><td>Possible values include: <br>- INIT<br>- IN_PROGRESS<br>- FAILED<br>- COMPLETED<br>- COMPLETED_WITH_ERRORS</td></tr><tr><td><a href="#identity-verification">identityVerification</a></td><td>object</td><td></td></tr><tr><td><a href="#kyc-identification">kycVerification</a></td><td>object</td><td></td></tr></tbody></table>

### Identity Verification

| Attribute                                       | Type           | Description                                 |
| ----------------------------------------------- | -------------- | ------------------------------------------- |
| applicationId                                   | string         | Identifier for the application              |
| [communicationChannels](#communication-channel) | array\<object> | List of communication channels              |
| createdUtc                                      | string         | Creation date and time (UTC)                |
| externalReferenceId                             | string         | External reference identifier               |
| id                                              | string         | Identifier for the data record              |
| modifiedUtc                                     | string         | Modification date and time (UTC)            |
| [redaction](#redaction)                         | object         | Redaction information                       |
| [registration](#registration)                   | object         | User registration details                   |
| [setup](#setup)                                 | object         | Setup information                           |
| status                                          | string         | Status of the data record (e.g., "Pending") |
| [step](#step)                                   | object         | Workflow step details                       |

### Communication Channel

| Attribute | Type   | Description                        |
| --------- | ------ | ---------------------------------- |
| id        | string | Id of the communication channel.   |
| type      | string | Type of the communication channel. |

### Redaction

| Attribute   | Type   | Description                   |
| ----------- | ------ | ----------------------------- |
| redactedUtc | string | Redaction date and time (UTC) |

### Registration

| Attribute    | Type   | Description               |
| ------------ | ------ | ------------------------- |
| dateOfBirth  | string | Date of birth             |
| email        | string | Email address             |
| firstName    | string | First name                |
| lastName     | string | Last name                 |
| middleName   | string | Middle name               |
| personalCode | string | Personal code             |
| phoneNumber  | number | Phone number              |
| countryCode  | string | Country code (e.g., "LT") |

### Setup

| Attribute  | Type   | Description |
| ---------- | ------ | ----------- |
| id         | string | Setup ID    |
| overrideId | string | Override ID |
| versionId  | string | Version ID  |

### Step

| Attribute                                   | Type   | Description                |
| ------------------------------------------- | ------ | -------------------------- |
| [consent](#consent)                         | object | Consent details            |
| [kycIdentification](#kyc-identification-id) | object | KYC identification details |

### Consent

| Attribute    | Type    | Description                   |
| ------------ | ------- | ----------------------------- |
| consentedUtc | string  | Consent date and time (UTC)   |
| id           | string  | Consent ID                    |
| isConsented  | boolean | Indicates if consent is given |

### **KYC Identification Id**

| Attribute | Type   | Description            |
| --------- | ------ | ---------------------- |
| id        | string | Face authentication ID |

### Kyc Identification

| Attribute                            | Type                    | Description                                                       |
| ------------------------------------ | ----------------------- | ----------------------------------------------------------------- |
| [additionalFiles](#additional-files) | array\<object>          | List of additional files                                          |
| applicationId                        | string                  | Identifier for the application                                    |
| [auditFiles](#audit-files)           | array\<object>          | List of audit files                                               |
| completedUtc                         | string                  | Completion date and time (UTC)                                    |
| createdUtc                           | string                  | Creation date and time (UTC)                                      |
| [document](#document)                | object                  | Document details                                                  |
| [face](#face)                        | object                  | Face details                                                      |
| [fraudChecks](#fraud-checks)         | array\<object>          | List of fraud checks                                              |
| id                                   | string                  | Identifier for the data record                                    |
| identityVerificationId               | string                  | Identifier for identity verification                              |
| isCrossChecked                       | boolean                 | Indicates if cross-checked                                        |
| [proofOfAddress](#proof-of-address)  | object                  | Proof of address details                                          |
| [registries](#registries)            | array\<objec&#x74;**>** | List of registries                                                |
| [rules](#rules)                      | array\<object>          | List of rules                                                     |
| [scores](#scores)                    | array\<object>          | List of scores                                                    |
| [setup](#setup-1)                    | object                  | Setup information                                                 |
| status                               | string                  | <p>Possible values:<br>- Awaiting<br>- Approved<br>- Rejected</p> |
| statusReason                         | string                  | Possible value in table below                                     |

<table><thead><tr><th width="239">Status</th><th>Status reasons</th></tr></thead><tbody><tr><td>Awaiting</td><td><ul><li>Unfinished</li><li>Processing</li></ul></td></tr><tr><td>Approved</td><td><ul><li>AutomaticallyIdentified</li><li>ManuallyIdentified</li></ul></td></tr><tr><td>Rejected</td><td><ul><li>TransferToVideoCall</li><li>MissingDocumentPhoto</li><li>DocumentNotAccepted</li><li>DataNotMatch</li><li>DataNotMatch</li><li>Sanctioned</li><li>MissingPersonPhoto</li><li>FacesNotMatch</li><li>PoorPhotoQuality</li><li>PoorPhotoLighting</li><li>FacePhotoUploadFormat</li><li>Miscellaneous</li><li>PossibleFraudAttempt</li><li>UnrelatedPhotoSubmit</li><li>MoreThanOnePerson</li><li>ProhibitedCountryOrState</li><li>DocumentIsExpired</li><li>DocumentWithNonLatinCharacters</li><li>PartOfDocumentIsCovered</li><li>PartOfFaceIsCovered</li><li>UnderagePerson</li><li>ProhibitedNationality</li><li>DuplicatedInfo</li><li>AdverseMediaFound</li><li>DocumentFromScreen</li><li>DocumentManipulation</li><li>DocumentPrinted</li><li>InvalidProofOfAddress</li><li>KnownFraudster</li><li>PoliticallyExposedPerson</li><li>SelfieHasNoFace</li></ul></td></tr></tbody></table>

### **Additional Files**

| Attribute     | Type   | Description                  |
| ------------- | ------ | ---------------------------- |
| createdUtc    | string | Creation date and time (UTC) |
| fileExtension | string | File extension               |
| fileId        | string | File identifier              |
| fileName      | string | File name                    |
| fileType      | string | File type                    |

### **Audit Files**

| Attribute     | Type   | Description                  |
| ------------- | ------ | ---------------------------- |
| createdUtc    | string | Creation date and time (UTC) |
| fileExtension | string | File extension               |
| fileId        | string | File identifier              |
| fileName      | string | File name                    |
| fileType      | string | File type                    |

### **Document**

| Attribute                          | Type                    | Description              |
| ---------------------------------- | ----------------------- | ------------------------ |
| address                            | string                  | Document address         |
| category                           | string                  | Document category        |
| countryIso3                        | string                  | Country ISO-3 code       |
| countryStateIso2                   | string                  | Country state ISO-2 code |
| dateOfBirth                        | string                  | Date of birth            |
| dateOfExpiration                   | string                  | Date of expiration       |
| dateOfIssue                        | string                  | Date of issue            |
| documentNumber                     | string                  | Document number          |
| [files](#document-files)           | array\<objec&#x74;**>** | List of document files   |
| firstName                          | string                  | First name               |
| fullName                           | string                  | Full name                |
| gender                             | string                  | Gender                   |
| lastName                           | string                  | Last name                |
| middleName                         | string                  | Middle name              |
| mrzVerified                        | boolean                 | MRZ verification status  |
| nationalityIso3                    | string                  | Nationality ISO-3 code   |
| [ocrValidations](#ocr-validations) | array\<object>          | List of OCR validations  |
| personalCode                       | string                  | Personal code            |
| type                               | string                  | Document type            |

### Document Files

<table><thead><tr><th width="273.3333333333333">Attribute</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>autoCaptureConfidenceRate</td><td>number</td><td>Auto-capture confidence rate</td></tr><tr><td>createdUtc</td><td>string</td><td>Creation date and time (UTC)</td></tr><tr><td>fileExtension</td><td>string</td><td>File extension</td></tr><tr><td>fileId</td><td>string</td><td>File identifier</td></tr><tr><td>fileName</td><td>string</td><td>File name</td></tr><tr><td>fileType</td><td>string</td><td>File type</td></tr><tr><td>part</td><td>string</td><td>Part of the document</td></tr></tbody></table>

### Face

| Attribute            | Type           | Description             |
| -------------------- | -------------- | ----------------------- |
| ageEstimation        | string         | Age estimation          |
| ageEstimateGroupV2   | string         | Age estimate group (V2) |
| enrollmentId         | string         | Enrollment ID           |
| [files](#face-files) | array\<object> | List of face files      |

### **Face Files**

| Attribute     | Type   | Description                  |
| ------------- | ------ | ---------------------------- |
| createdUtc    | string | Creation date and time (UTC) |
| fileExtension | string | File extension               |
| fileId        | string | File identifier              |
| fileName      | string | File name                    |
| fileType      | string | File type                    |

### **Fraud Checks**

| Attribute              | Type           | Description                          |
| ---------------------- | -------------- | ------------------------------------ |
| fileId                 | string         | File identifier                      |
| name                   | string         | Fraud check name                     |
| reasons                | array\<string> | List of fraud check reasons          |
| status                 | string         | Fraud check status (e.g., "Success") |
| linkedIdentificationId | string         | Linked identification identifier     |

### **Proof of Address**

| Attribute                          | Type           | Description                                       |
| ---------------------------------- | -------------- | ------------------------------------------------- |
| city                               | string         | City                                              |
| files                              | array\<object> | List of proof of address files                    |
| firstName                          | string         | First name                                        |
| lastName                           | string         | Last name                                         |
| [ocrValidations](#ocr-validations) | array\<object> | List of Optical character recognition validations |
| parish                             | string         | Parish                                            |
| street                             | string         | Street                                            |

### **Registries**

| Attribute | Type   | Description             |
| --------- | ------ | ----------------------- |
| name      | string | Registry name           |
| reason    | string | Reason                  |
| status    | string | Status (e.g., "Ignore") |

### Rules

| Attribute | Type   | Description              |
| --------- | ------ | ------------------------ |
| name      | string | Rule name                |
| reason    | string | Reason                   |
| status    | string | Status (e.g., "Success") |

### Scores

| Attribute | Type   | Description |
| --------- | ------ | ----------- |
| name      | string | Score name  |
| value     | string | Score value |

### Setup

| Attribute | Type   | Description |
| --------- | ------ | ----------- |
| id        | string | Setup ID    |
| versionId | string | Version ID  |

### OCR Validations

| Attribute | Type    | Description                             |
| --------- | ------- | --------------------------------------- |
| isValid   | boolean | Flag indicating if validation is valid  |
| key       | string  | Name of the field that's been validated |

### Output Example

```postman_json
{
    "state": "COMPLETED",
    "identityVerification": {
        "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "communicationChannels": [
            {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type": "Email"
            }
        ],
        "createdUtc": "2023-09-14T13:09:56.847Z",
        "externalReferenceId": "123",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "modifiedUtc": "2023-09-14T13:09:56.847Z",
        "redaction": {
            "redactedUtc": "2023-09-14T13:09:56.847Z"
        },
        "registration": {
            "dateOfBirth": "2021-01-14",
            "email": "John@email.com",
            "firstName": "John",
            "lastName": "Johnson",
            "middleName": "Adam",
            "personalCode": "1214148111000",
            "phoneNumber": 370624515141,
            "countryCode": "LT"
        },
        "setup": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "overrideId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        },
        "status": "Pending",
        "step": {
            "authenticationSignature": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            },
            "consent": {
                "consentedUtc": "2021-01-02T14:08:39.712Z",
                "id": "01d9d9df-afb3-445c-a9cf-012012df58ea",
                "isConsented": false
            },
            "documentSignatures": [
                {
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                }
            ],
            "forms": [
                {
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                }
            ],
            "kybIdentification": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            },
            "kycIdentification": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            },
            "faceAuthentication": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            }
        }
    },
    "kycVerification": {
        "additionalFiles": [
            {
                "createdUtc": "2023-09-14T13:13:15.724Z",
                "fileExtension": "jpeg",
                "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "fileName": "identity_file.jpeg",
                "fileType": "ProofOfAddress"
            }
        ],
        "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "auditFiles": [
            {
                "createdUtc": "2023-09-14T13:13:15.724Z",
                "fileExtension": "jpeg",
                "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "fileName": "identity_file.jpeg",
                "fileType": "ScreenRecording"
            }
        ],
        "completedUtc": "2023-09-14T13:13:15.724Z",
        "createdUtc": "2023-09-14T13:13:15.724Z",
        "document": {
            "address": "string",
            "category": "B",
            "countryIso3": "LTU",
            "countryStateIso2": "GR",
            "dateOfBirth": "2000-02-03",
            "dateOfExpiration": "2000-02-03",
            "dateOfIssue": "2000-02-03",
            "documentNumber": "PU2343443343",
            "files": [
                {
                    "autoCaptureConfidenceRate": 99.9,
                    "createdUtc": "2023-09-14T13:13:15.725Z",
                    "fileExtension": "jpeg",
                    "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "fileName": "identity_file.jpeg",
                    "fileType": "DocumentPhoto",
                    "part": "Front"
                }
            ],
            "firstName": "John",
            "fullName": "John Adam Jones",
            "gender": "Male",
            "lastName": "Jones",
            "middleName": "Adam",
            "mrzVerified": true,
            "nationalityIso3": "LTU",
            "ocrValidations": [
                {
                    "isValid": true,
                    "key": "Address"
                }
            ],
            "personalCode": "199202030202",
            "type": "IdCard"
        },
        "face": {
            "ageEstimation": "AgeUnder13",
            "ageEstimateGroupV2": "AgeEstimateNotAvailable",
            "enrollmentId": "adfc35b9-faba-4b6f-9f7d-f33e2a83b0e6",
            "files": [
                {
                    "createdUtc": "2023-09-14T13:13:15.725Z",
                    "fileExtension": "gif",
                    "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "fileName": "face_file.gif",
                    "fileType": "FaceVideo"
                }
            ]
        },
        "fraudChecks": [
            {
                "fileId": "52de38da842b4451bb4b18121eb4b80f",
                "name": "SeonIp",
                "reasons": [
                    "string"
                ],
                "status": "Success",
                "linkedIdentificationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            }
        ],
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "identityVerificationId": "1dbb6d1d-0596-4247-9b37-879e44c53ddc",
        "isCrossChecked": true,
        "proofOfAddress": {
            "city": "Amestris",
            "files": [
                {
                    "createdUtc": "2023-09-14T13:13:15.725Z",
                    "fileExtension": "jpeg",
                    "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "fileName": "identity_file.jpeg",
                    "fileType": "DocumentPhoto"
                }
            ],
            "firstName": "John",
            "lastName": "Jones",
            "ocrValidations": [
                {
                    "isValid": true,
                    "key": "FirstName"
                }
            ],
            "parish": "Amestria",
            "street": "Amestry st. 15-25"
        },
        "registries": [
            {
                "name": "SharedDatabase",
                "reason": "FoundInSanctionsList",
                "status": "Ignore"
            }
        ],
        "rules": [
            {
                "name": "SelfieHasFace",
                "reason": "SelfieHasNoFace",
                "status": "Success"
            }
        ],
        "scores": [
            {
                "name": "SelfieAndDocumentImageComparison",
                "value": "0"
            }
        ],
        "setup": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        },
        "status": "Awaiting",
        "statusReason": "MissingDocumentPhoto"
    },
    "files": {
        ...
    }
}
```


---

# 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/ondato.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.
