Proof of Address Check
Outcome
Output
Client
id
string
The unique identifier for a client.
type
string, possible values include:
person
company
The type of client.
entityName
string
The client's full name.
string
The client's email address.
companyDetails
object
Details for a client of type company
.
createdAt
string
The date and time when the client was created.
updatedAt
string
The date and time when the client was updated.
Address
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
firstName
string
The client's first name.
lastName
string
The client's last name.
Company Details
name
string
The client's name.
Checks Result
Proof of Address Check
state
string, possible values include:
INIT
IN_PROGRESS
ERROR
FAILED
FINISHED
The status of the client's verification
files
links
Links that allow to download client's documents.
outcome
string, possible values include:
clear
attention
not_processed
The outcome attribute represents the overall check result. Returned values include:
clear
: Indicates every analysis type conducted returned a successful result, and hence the document is authentic.attention
: Indicates at least one of the analysis results requires attention.not_processed
: Indicates that ComplyCube was not able to process the images. Reasons include:The image is of low quality.
The image is blurred or glared.
The image is at an angle.
The ID type and country provided do not correspond with the actual document provided uploaded.
Breakdown
Extracted Data
Document Details
documentType
string, possible values include:
bank_statement
driving_license
utility_bill
tax_document
Detected document type.
issuer
string
Document issuing vendor.
issuingDate
object
Issuing date of the document.
Holder Details
entityName
string
Full extracted name of the document holder.
Address Details
addressLine
string
Extracted address line.
Structured Address
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.
latLong
string
Address latitude and longitude.
Date
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:
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
Client Validation
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
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
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
Last updated