Proof of Address Check
This check can only be performed on a client of type
person
. Furthermore, the documentId
provided must have associated image attachments that adhere to our image specifications.We will use the front side of the document for the Proof of Address Check.
Attribute | Type | Description |
clientId | string | The ID of the client associated with this check. (Required) |
type | string | This must be set to proof_of_address_check . (Required) |
documentId | string | The ID of the document. (Required) |
cURL
Node.js
Python
PHP
.NET
curl -X POST https://api.complycube.com/v1/checks \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"clientId":"CLIENT_ID",
"documentId":"DOCUMENT_ID",
"type": "proof_of_address_check"
}'
const check = await complycube.check.create("CLIENT_ID", {
documentId: "DOCUMENT_ID",
type: "proof_of_address_check"
});
check = cc_api.check.create('CLIENT_ID',
'proof_of_address_check',
documentId='DOCUMENT_ID')
$result = $ccapi->checks()->create('CLIENT_ID',
['type' => 'proof_of_address_check',
'documentId' => 'DOCUMENT_ID',
'addressId' => 'ADDRESS_ID']);
var checkRequest = new CheckRequest
{
clientId = "CLIENT_ID",
documentId = "DOCUMENT_ID",
addressId = "ADDRESS_ID",
type = "proof_of_address_check"
};
var check = await checkApi.CreateAsync(checkRequest);
The
result
object is only returned when the status of the check is complete
. It has two components - outcome
and breakdown
.The outcome attribute represents the overall check result. Returned values include:
- 1.
clear
: Indicates every analysis conducted returned a successful result, and hence the proof of address document is valid. - 2.
attention
: Indicates at least one of the analysis results requires attention.
The breakdown comprises the following objects:
documentDetails
: Data relating to the document.documentType
: The detected document type. Values include:bank_statement
driving_license
utility_bill
tax_document
issuer
: The document issuing vendor.
holderDetails
: Data relating to the document holder.entityName
: The full extracted name of the document holder.
addressDetails
: Data relating to the extracted address.addressLine
: The extracted address line as a string.address
: This will be the structured address, which includes the following:propertyNumber
: The property number.building
: The building name.line
: The address line.city
: The address city.state
: The address state.postalCode
: The address postal code.latLong
: The address latitude and longitude geographic coordinates.
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
The client validation results. It has the following constituents::
firstName
: Indicates whether the client provided first name matches the extracted entity name.lastName
: Indicates whether the client provided last name matches the extracted entity name.address
: Indicates whether any of the client provided addresses match the extracted address.
The content analysis results. It has the following constituents:
documentAge
: 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.
The geolocation analysis results. It has the following constituents:
ipInAddressCountry
: Indicates the geolocation of the client IP address resides in the extracted address country.ipProximityToAddress
: Indicates the geolocation of the client IP address is within a reasonable distance from the extracted address country.
{
"id": "614cfa9460fe4700098f3af9",
"entityName": "John Doe",
"type": "proof_of_address_check",
"clientId": "5e94b75d01bce00008c86f02",
"documentId": "6149f415cb31190008991526",
"status": "complete",
"result": {
"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"
}
}
},
"createdAt": "2021-04-04T17:25:21.116Z",
"updatedAt": "2021-04-04T17:25:33.116Z"
}
Last modified 1yr ago