API Reference
v1.7.3
Search
⌃K
Comment on page

Checks

The gateway to ComplyCube's client verification services.
Checks enable you to run various types of verifications against your clients. You can perform the following types of checks:
The checks API allows you to create, update, validate, and retrieve checks. You can retrieve a specific check as well as a list of all your client's checks.
All checks are asynchronous.

The Check object

Attribute
Type
Description
id
string
The unique identifier for a check.
clientId
string
The ID of the client associated with this check.
enableMonitoring
boolean
Determines whether continuous monitoring is enabled. When not provided, it defaults to false.
documentId
string
The ID of the document. This is expected when the type of check is document_check, identity_check, enhanced_identity_check, or
proof_of_address_check.
addressId
string
The ID of the address. This is expected when the check type is multi_bureau_check.
livePhotoId
string
The ID of the live photo. This is expected when the type of check is identity_check or face_authentication_check.
liveVideoId
string
The ID of the live video. This is expected when the type of check is enhanced_identity_check.
entityName
string
The full name of the client. This will be auto-generated.
type
string
options
object
The advanced optional configuration associated with the check. Also, see the options object defined under each type of check.
clientConsent
boolean
Where required, you must collect the client's consent before creating a check.
status
string
The status of the check. As checks are asynchronous, their status will change as their state transitions. Values can be:
  1. 1.
    pending - the status on initiation.
  2. 2.
    complete - the status upon completion.
  3. 3.
    failed - the status if a check fails.
result
object
The result of the check. This will only have a value when a check is complete. The content will depend on the type of check.
createdAt
string
The date and time when the check was created.
updatedAt
string
The date and time when the check was completed.
​

Structured Date format

In many cases, an attribute within a check's result object will contain an attribute with a structured date value.
Attributes
Sample Object
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.
{
...
"expirationDate":{
"day": 1,
"month": 12,
"year": 2020
}
...
}
Previous
List live videos
Next
Create a check
Last modified 30d ago