# Idenfy

### 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

There are some mandatory fields required for user to run this integration.

| Attrribute | Type   | Description            |
| ---------- | ------ | ---------------------- |
| firstName  | string | FIrst name of the user |
| lastName   | string | Last name of the user  |

### Input Example

```
{
    "firstName": "Jan",
    "lastName": "Kowalski"
}
```

### Output

| Attribute           | Type        | Description                                                                                                                            |
| ------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| platform            | string      | <p></p><p>Possible values:</p><ul><li>PC</li><li>MOBILE</li><li>TABLET</li><li>MOBILE\_APP</li><li>MOBILE\_SDK</li><li>OTHER</li></ul> |
| status              | object      | The status of the verification.                                                                                                        |
| data                | object      | The data from clients identity document.                                                                                               |
| clientIp            | string      | Client's system IP address                                                                                                             |
| startTime           | number      | A timestamp of when a client starts the verification process.                                                                          |
| finishTime          | number      | A timestamp of when the final decision for automatic processing was made.                                                              |
| clientIpCountry     | string      | A country code of the client's system IP address.                                                                                      |
| clientLocation      | string      | Full information available about the client's current location based on the IP address.                                                |
| gdcMatch            | boolean     | Indicates if provided information in additional data matches any entry from global data sources databases.                             |
| manualAddress       | string      | Client address parsed from utility bill. Only occurs if utility bill was uploaded.                                                     |
| manualAddressMatch  | boolean     | Indicates if the document's address matched with the address provided by the partner after the manual check.                           |
| addressVerification | json object | Client's address verification.                                                                                                         |
| registryCenterCheck | json object | Client's registry center check.                                                                                                        |

### Status

| Attribute       | Type           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| --------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| overall         | string         | <p>An overall status of the verification. It is a combination of manual and automatic verification results. Possible values:</p><ul><li>APPROVED</li><li>DENIED</li><li>SUSPECTED</li><li>EXPIRED</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| fraudTags       | array\<string> | <p>A list of fraud tags (strings) indicating why verification was <code>SUSPECTED</code>.<br>Possible values:</p><ul><li>FACE\_SUSPECTED</li><li>FACE\_BLACKLISTED</li><li>DOC\_FACE\_BLACKLISTED</li><li>DOC\_MOBILE\_PHOTO</li><li>DEV\_TOOLS\_OPENED</li><li>DOC\_PRINT\_SPOOFED</li><li>FAKE\_PHOTO</li><li>AML\_SUSPECTION</li><li>AML\_FAILED</li><li>LID\_SUSPECTION</li><li>LID\_FAILED</li><li>UTILITY\_ADDRESS\_CHECK\_FAILURE</li><li>VIRTUAL\_CAMERA</li><li>FACE\_IN\_BLACKLIST</li><li>DOC\_FACE\_IN\_BLACKLIST</li><li>DUPLICATE\_FACE</li><li>DUPLICATE\_DOC\_FACE</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| mismatchTags    | array\<string> | <p>A list of mismatch tags (strings) indicating where partner provided document information does not match with the read information. Possible values: </p><ul><li>NAME </li><li>SURNAME </li><li>DOCUMENT\_NUMBER </li><li>PERSONAL\_CODE </li><li>EXPIRY\_DATE</li><li>DATE\_OF\_BIRTH</li><li>DATE\_OF\_ISSUE</li><li>FULL\_NAME</li><li>UNDER\_AGE</li><li>UNKNOWN\_AGE </li><li>SEX -NATIONALITY</li><li>INVALID\_ADDITIONAL\_STEP</li><li>ADDITIONAL\_STEP\_NOT\_FOUND</li><li>GDC\_NOT\_MATCH</li><li> DOC\_INFO\_MISMATCH</li><li>ADDITIONAL\_STEP\_INFORMATION\_MISMATCH</li><li>EXPIRED\_ADDITIONAL\_STEP\_INFORMATION</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| autoFace        | string         | <p>An automatic face analysis result (decision made by an automated platform). Possible values:</p><ul><li>FACE\_MATCH</li><li>FACE\_MISMATCH</li><li>NO\_FACE\_FOUND</li><li>TOO\_MANY\_FACES</li><li>FACE\_TOO\_BLURRY</li><li>FACE\_GLARED</li><li>FACE\_UNCERTAIN</li><li>FACE\_NOT\_ANALYSED</li><li>FACE\_NOT\_CHECKED</li><li>FACE\_ERROR</li><li>AUTO\_UNVERIFIABLE</li><li>FAKE\_FACE</li><li>null</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| manualFace      | string         | <p>A Final face analysis result (decision made by a automatic system and human). Possible values:</p><ul><li>FACE\_MATCH</li><li>FACE\_MISMATCH</li><li>NO\_FACE\_FOUND</li><li>TOO\_MANY\_FACES</li><li>FACE\_UNCERTAIN</li><li>FAKE\_FACE</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| autoDocument    | string         | <p></p><p>An automatic document analysis result (decision made by an automated platform). Possible values:</p><ul><li>DOC\_VALIDATED</li><li>DOC\_INFO\_MISMATCH</li><li>DOC\_NOT\_FOUND</li><li>DOC\_NOT\_FULLY\_VISIBLE</li><li>DOC\_NOT\_SUPPORTED</li><li>DOC\_FACE\_NOT\_FOUND</li><li>DOC\_TOO\_BLURRY</li><li>DOC\_GLARED</li><li>DOC\_FACE\_GLARED</li><li>MRZ\_NOT\_FOUND</li><li>MRZ\_OCR\_READING\_ERROR</li><li>BARCODE\_NOT\_FOUND</li><li>DOC\_EXPIRED</li><li>COUNTRY\_MISMATCH</li><li>DOC\_TYPE\_MISMATCH</li><li>DOC\_SIDE\_MISMATCH</li><li>DOC\_DAMAGED</li><li>DOC\_FAKE</li><li>DOC\_ERROR</li><li>AUTO\_UNVERIFIABLE</li><li>DOC\_NOT\_ANALYSED</li><li>DOC\_NAME\_ERROR</li><li>DOC\_SURNAME\_ERROR</li><li>DOC\_EXPIRY\_ERROR</li><li>DOC\_DOB\_ERROR</li><li>DOC\_PERSONAL\_NUMBER\_ERROR</li><li>DOC\_NUMBER\_ERROR</li><li>DOC\_DATE\_OF\_ISSUE\_ERROR</li><li>DOC\_SEX\_ERROR</li><li>DOC\_NATIONALITY\_ERROR</li><li>COUNTRY\_NOT\_SUPPORTED</li><li>DOC\_PERSONAL\_CODE\_INVALID</li><li>DOC\_SPOOF\_DETECTED</li><li>MRZ\_INVALID</li><li>DOC\_NOT\_ALLOWED</li></ul> |
| manualDocument  | string         | <p>Final document analysis result (decision made by a automatic system and human). Possible values:</p><ul><li>DOC\_VALIDATED</li><li>DOC\_NOT\_FULLY\_VISIBLE</li><li>DOC\_NOT\_SUPPORTED</li><li>DOC\_EXPIRED</li><li>DOC\_DAMAGED</li><li>DOC\_FAKE</li><li>DOC\_PERSONAL\_CODE\_INVALID</li><li>MRZ\_INVALID</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| additionalSteps | string         | <p>An additional steps result (decision made by human). Possible values:</p><ul><li>VALID</li><li>INVALID</li><li>NOT\_FOUND</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |

### Data

| Attribute              | Type           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ---------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| docFirstName           | string         | Clients name from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| docLastName            | string         | Clients surname from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| docNumber              | string         | Clients document number from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| docPersonalCode        | string         | Clients personal code from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| docExpiry              | string         | Clients document expiry date from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| docDob                 | string         | Clients date of birth from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| docDateOfIssue         | string         | Clients date of issue from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| docType                | string         | <p>Clients used document type to complete verification. Possible values:</p><ul><li>ID\_CARD</li><li>PASSPORT</li><li>RESIDENCE\_PERMIT</li><li>DRIVER\_LICENSE</li><li>PAN\_CARD</li><li>AADHAAR</li><li>OTHER</li><li>VISA</li><li>BORDER\_CROSSING</li><li>ASYLUM</li><li>NATIONAL\_PASSPORT</li><li>INTERNATIONAL\_PASSPORT</li><li>PROVISIONAL\_DRIVER\_LICENSE</li><li>VOTER\_CARD</li><li>OLD\_ID\_CARD</li><li>TRAVEL\_CARD</li><li>PHOTO\_CARD</li><li>MILITARY\_CARD</li><li>PROOF\_OF\_AGE\_CARD</li><li>DIPLOMATIC\_ID</li></ul> |
| docSex                 | string         | <p>Clients sex from the document. Possible values:</p><ul><li>MALE</li><li>FEMALE</li><li>UNDEFINED</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                |
| docNationality         | string         | Clients nationality from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| docIssuingCountry      | string         | Clients documents issuing country from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| docTemporaryAddress    | string         | Clients temporary address from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| docBirthName           | string         | Clients birth name from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| docBirthPlace          | string         | Clients birth place from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| authority              | string         | The authority of the document from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| address                | string         | Clients address from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| mothersMaidenName      | string         | Clients mothers maiden name from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| driverLicenseCategory  | string         | Clients driving license categories (classes) from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| manuallyDataChanged    | boolean        | Indicates whether a manual reviewer has changed any parsed data from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| fullName               | string         | Clients full name parsed from the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| selectedCountry        | string         | Country which was selected in verification process.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| orgFirstName           | string         | Client name from the document in original language.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| orgLastName            | string         | Client surname from the document in original language.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| orgNationality         | string         | Client nationality from the document in original language.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| orgBirthPlace          | string         | Client birth place from the document in original language.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| orgAuthority           | string         | Client document authority categories from the document in original language.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| orgAddress             | string         | Client address from the document in original language.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| orgTemporaryAddress    | string         | Client temporary address from the document in original language.                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| orgMothersMaidenName   | string         | Clients mothers maiden name from the document in original language.                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| orgBirthName           | string         | Client birth name parsed from the document in original language.                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ageEstimate            | string         | <p>Client age detected from selfie when liveness is on. Possible values:</p><ul><li>UNDER\_13</li><li>OVER\_13</li><li>OVER\_18</li><li>OVER\_22</li><li>OVER\_25</li><li>OVER\_30</li></ul>                                                                                                                                                                                                                                                                                                                                                 |
| clientIpProxyRiskLevel | string         | <p>Client's IP address proxy risk level. Possible values:</p><ul><li>VERY\_LOW</li><li>LOW</li><li>MEDIUM</li><li>HIGH</li><li>VERY\_HIGH</li><li>NOT\_CHECKED</li></ul>                                                                                                                                                                                                                                                                                                                                                                     |
| duplicateFaces         | array\<string> | Indicates if other clients which selfie faces were matched with this one's verification.                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| duplicateDocFaces      | array\<string> | Indicates if other clients which document faces were matched with this one's verification.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| additionalData         | string         | Additional data provided alongside any additionalSteps, for example - Social Security Number in `UTILITY_BILL`.                                                                                                                                                                                                                                                                                                                                                                                                                              |

### Example Output

```
{
  "platform": "MOBILE_APP",
  "startTime": 1554726960, 
  "finishTime": 1554727002,
  "clientIp": "192.0.2.0",
  "clientIpCountry": "LT",
  "clientLocation": "Kaunas, Lithuania",
  "final": false,
  "status": {
    "overall": "APPROVED",
    "mismatchTags": [],
    "fraudTags": [],
    "autoDocument": "DOC_VALIDATED",
    "autoFace": "FACE_MATCH",
    "manualDocument": "DOC_VALIDATED",
    "manualFace": "FACE_MATCH",
    "additionalSteps": null
  },
  "data": {
    "docFirstName": "FIRST-NAME-EXAMPLE",
    "docLastName": "LAST-NAME-EXAMPLE",
    "docNumber": "XXXXXXXXX",
    "docPersonalCode": "XXXXXXXXX",
    "docExpiry": "YYYY-MM-DD",
    "docDob": "YYYY-MM-DD",
    "docDateOfIssue": "2018-03-02",
    "docType": "ID_CARD",
    "docSex": "UNDEFINED",
    "docNationality": "LT",
    "docIssuingCountry": "LT",
    "docTemporaryAddress": null,
    "docBirthName": null,
    "birthPlace": "BIRTH PLACE",
    "authority": "AUTHORITY EXAMPLE",
    "address": "ADDRESS EXAMPLE",
    "fullName": "FULL-NAME-EXAMPLE",
    "selectedCountry": "LT",
    "mothersMaidenName": null,
    "driverLicenseCategory": null,
    "manuallyDataChanged": false,
    "orgFirstName": "FIRST-NAME-EXAMPLE",
    "orgLastName":  "LAST-NAME-EXAMPLE",
    "orgNationality": "LIETUVOS",
    "orgBirthPlace": "ŠILUVA",
    "orgAuthority": null,
    "orgAddress": null,
    "orgTemporaryAddress": null,
    "orgMothersMaidenName": null,
    "orgBirthName": null,
    "ageEstimate": "OVER_25",
    "clientIpProxyRiskLevel": "LOW",
    "duplicateDocFaces": null,
    "duplicateFaces": null,
    "additionalData": {
    "UTILITY_BILL": {
      "ssn": {
        "value": "ssn number",
        "status": "MATCH"
      }
    }
  },
  "manualAddress": null,
  "manualAddressMatch": false,
  "registryCenterCheck": null,
  "addressVerification": null
  },
  "additionalStepPdfUrls": {},
}
```


---

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