Proof of Address Check
Last updated
Was this helpful?
Last updated
Was this helpful?
To run a Proof of Address Check, you must with type
set to proof_of_address_check
.
This check can only be performed on a of type person
. Furthermore, the documentId
provided must have associated image attachments that adhere to our .
.
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)
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:
clear
: Indicates every analysis conducted returned a successful result, and hence the proof of address document is valid.
attention
: Indicates at least one of the analysis results requires attention.
The breakdown comprises the following objects:
extractedData
objectdocumentDetails
: 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:
clear
: Indicates the analysis returned a successful result.
attention
: Indicates a potential falsified or fraudulent document.
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
clientValidation
objectThe 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.
contentAnalysis
objectThe 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.
geolocationAnalysis
objectThe 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.
The data extracted using . It has the following constituents:
issuingDate
: The issuing date of the document. This will be a .
addressCountry
: The address country. This will be the .
country
: The address country. This will be the .