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

string, possible values include:

  • person
  • company
The type of client.
entityNamestringThe client's full name.
emailstringThe client's email address.
personDetailsobjectDetails for a client of type person.
companyDetailsobjectDetails for a client of type company.
createdAtstringThe date and time when the client was created.
updatedAtstringThe date and time when the client was updated.
### Address | Property | Type | Description | | --------- | ------ | ---------------------------------- | | id | string | ID of the address. | | clientId | string | ID of the associated client. | | line | string | Address line. | | city | string | City of the address. | | country | string | Country of the address. | | createdAt | string | Creation timestamp of the address. | | updatedAt | string | Update timestamp of the address. | ### 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 | | ---------------------------------------------- | ------ | ------------------------------------- | | [proofOfAddressCheck](#proof-of-address-check) | object | Result of the proof of address check. | ### Proof of Address Check | Attribute | Type | Description | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | state |

string, possible values include:

| The status of the client's verification | | [document](#document) | object | Document which was used to verification process. | | files | links | Links that allow to download client's documents. | | outcome |

string, possible values include:

|

The outcome attribute represents the overall check result. Returned values include:

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

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

| | [breakdown](#breakdown) | object | Details of verification. | ### Breakdown | Attribute | Type | Description | | -------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------- | | [extractedData](#breakdown) | object | The data extracted using [Optical Character Recognition (OCR)](https://en.wikipedia.org/wiki/Optical_character_recognition). | | [clientValidation](#client-validation) | object | The client validation results. | | [contentAnalysis](#content-analysis) | object | The content analysis results. | | [geolocationAnalysis](#geolocation-analysis) | object | The geolocation analysis results. | ### Extracted Data | Attribute | Type | Description | | ------------------------------------ | ------ | --------------------------------------- | | [documentDetails](#document-details) | object | Data relating to the document. | | [holderDetails](#holder-details) | object | Data relating to the document holder. | | [addressDetails](#address-details) | object | Data relating to the extracted address. | ### **Document Details** | Property | Type | Description | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | documentType |

string, possible values include:

| Detected document type. | | issuer | string | Document issuing vendor. | | issuingDate | object | Issuing date of the document. | ### **Holder Details** | Property | Type | Description | | ---------- | ------ | ------------------------------------------- | | entityName | string | Full extracted name of the document holder. | ### **Address Details** | Property | Type | Description | | ------------------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------- | | addressLine | string | Extracted address line. | | addressCountry | string | The address country. This will be the [two-letter country ISO code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). | | [address](#structured-address) | object | Structured address details. | ### **Structured Address** | Property | Type | Description | | -------------- | ------ | ---------------------------------------------------------------------------------------------------------------------- | | propertyNumber | string | Property number. | | building | string | Building name. | | line | string | Address line. | | city | string | Address city. | | state | string | Address state. | | postalCode | string | Address postal code. | | country | string | The address country. This will be the [two-letter country ISO code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). | | latLong | string | Address latitude and longitude. | ### Date | Attribute | Type | Description | | --------- | ------ | ----------------------------------------- | | day | number | The day of the month. Value range `1-31`. | | month | number | The month. Value range `1-12`. | | year | number | The year, in `YYYY` format. | ### Analysis For each conducted analysis, the returned values include: 1. `clear`: Indicates the analysis returned a successful result. 2. `attention`: Indicates a potential falsified or fraudulent document. 3. `not_processed`: Returned when ComplyCube is not able to process the document. This can occur due to a number of reasons, including: * The document image is invalid * The document image is of poor quality and therefor unreadable ### **Client Validation** | Property | Type | Description | | --------- | ------ | ----------------------------------------------------------------------------------- | | firstName | string | Indicates whether the client provided first name matches the extracted entity name. | | lastName | string | Indicates whether the client provided last name matches the extracted entity name. | | address | string | Indicates whether any of the client provided addresses match the extracted address. | ### **Content Analysis** | Property | Type | Description | | ----------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | documentAge | string | Indicates the document had expired (when it's a Driving License) or is older than 3 months when it's a Bank Statement, Utility Bill, or Tax Document. | ### **Geolocation Analysis** | Property | Type | Description | | -------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------- | | ipInAddressCountry | string | Indicates the geolocation of the client IP address resides in the extracted address country. | | ipProximityToAddress | string | Indicates the geolocation of the client IP address is within a reasonable distance from the extracted address country. | ### Sample Result ```javascript { "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": "clear", "breakdown": { "extractedData": { "holderDetails": { "entityName": "John Doe" }, "documentDetails": { "documentType": "bank_statement", "issuer": "Barclays Bank", "issuingDate": { "day": 25, "month": 1, "year": 2021 } }, "addressDetails": { "address": { "propertyNumber": "323", "line": "Common street", "city": "Aldgate", "state": "London", "postalCode": "W99 0RD", "country": "GB", "latLong": "51.5136,-0.077188" }, "addressLine": "323 Common Street Aldgate London W99 0RD", "addressCountry": "GB" } }, "clientValidation": { "firstName": "clear", "lastName": "clear", "address": "clear" }, "contentAnalysis": { "documentAge": "clear" }, "geoLocationAnalysis": { "ipInAddressCountry": "clear", "ipProximityToAddress": "clear" } } } } } ] } } ```