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 |
|
| The unique identifier for a check. |
|
| The ID of the client associated with this check. |
|
| Determines whether continuous monitoring is enabled. When not provided, it defaults to false. |
|
| The ID of the document. This is expected when the type of check is |
|
| The ID of the live photo. This is expected when the type of check is |
|
| The full name of the client. This will be auto-generated. |
|
| The type of check. Valid values include: |
|
| The optional configuration associated with the check. Also, see the options object below. |
|
| The status of the check. As checks are asynchronous, their status will change as their state transitions. Values can be:
|
|
| 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. |
|
| The date and time when the check was created. |
|
| The date and time when the check was completed. |
Details for a client of type company
. Also, see the companyDetails object below.
Structured Date format
In many cases, an attribute within a check's result
object, will contain an attribute with values that's in a structured date format.
Attribute | Type | Description |
|
| The day of the month. Value range |
|
| The month. Value range |
|
| The year, in |
The options
object
options
object Attribute | Description |
| Type: The types of analysis to conduct as part of a document check. Valid values include:
When this attribute is not provided, we will conduct all analysis types. This is only applicable to checks of type |
| Type: The scope of lists to search as part of a screening check. See the When this attribute is not provided, we will conduct a search against all eligible lists. This is only applicable to checks of type |
| Type: The match classifications to include as part of a screening check. Valid values include:
When this attribute is not provided, we will conduct a search against all eligible classifications. |
The screeningListsScope
object
screeningListsScope
object Attribute | Description |
| Type: The criteria to apply to the lists when performing a screening search. Valid values include:
When this attribute is not provided, it will default to |
| Type: The lists to include or exclude as part of the screening search. |
Last updated