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:

• Standard AML Screening

• Extensive AML Screening

• Document Check

• Identity Check

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

Attributes

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 or identity_check.
livePhotoId	string	The ID of the live photo. This is expected when the type of check is identity_check.
entityName	string	The full name of the client. This will be auto-generated.
type	string	The type of check. Valid values include: standard_screening_check extensive_screening_check document_check identity_check
options	object	The optional configuration associated with the check. Also, see the options object below.
status	string	The status of the check. As checks are asynchronous, their status will change as their state transitions. Values can be: pending - the status on initiation. complete - the status upon completion. 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.

Sample Object

{
    "id": "5eb2b61e02df0a0008f1cf2a",
    "clientId": "5eb1276d96be4a0008713af5",
    "entityName": "John Doe",
    "type": "extensive_screening_check",
    "enableMonitoring": false,
    "status": "complete",
    "result": {
        "outcome": "clear",
        "breakdown": {
            "summary": {
                "pep": {
                    "level1": "clear",
                    "level2": "clear",
                    "level3": "clear",
                    "level4": "clear"
                },
                "watchlist": {
                    "sanctionsLists": "clear",
                    "otherOfficialLists": "clear",
                    "warCrimes": "clear",
                    "terror": "clear",
                    "otherExclusionLists": "clear",
                    "sanctionsControlAndOwnership": "clear"
                },
                "adverseMedia": {
                    "environmentProduction": "clear",
                    "socialLabour": "clear",
                    "competitiveFinancial": "clear",
                    "regulatory": "clear"
                },
                "otherLists": {
                    "associatedEntity": "clear",
                    "organisedCrime": "clear",
                    "financialCrime": "clear",
                    "taxCrime": "clear",
                    "corruption": "clear",
                    "trafficking": "clear"
                }
            }
        }
    },
    "createdAt": "2020-01-01T14:06:44.756Z",
    "updatedAt": "2020-01-01T14:06:91.913Z"
}

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.

Attributes

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.

Sample Object

{
    ...
    "expirationDate":{
        "day": 1,
        "month": 12,
        "year": 2020
    }
    ...
}

The options object

Attribute	Description
analysisCoverage	Type: array[string] The types of analysis to conduct as part of a document check. Valid values include: consistency_analysis forensic_analysis content_analysis format_analysis front_back_analysis mrz_analysis When this attribute is not provided, we will conduct all analysis types. This is only applicable to checks of type document_check.
screeningListsScope	Type: object The scope of lists to search as part of a screening check. See the screeningListsScope below. When this attribute is not provided, we will conduct a search against all eligible lists. This is only applicable to checks of type standard_screening_check and extensive_screening_check.
screeningClassification	Type: array[string] The match classifications to include as part of a screening check. Valid values include: pepLevel1 pepLevel2 pepLevel3 pepLevel4 watchlistSanctionsLists watchlistOtherOfficialLists watchlistWarCrimes watchlistTerror watchlistOtherExclusionLists watchlistSanctionsControlAndOwnership adverseMediaEnvironmentProduction adverseMediaSocialLabour adverseMediaCompetitiveFinancial adverseMediaRegulatory otherListsAssociatedEntity otherListsOrganisedCrime otherListsFinancialCrime otherListsTaxCrime otherListsCorruption otherListsTrafficking When this attribute is not provided, we will conduct a search against all eligible classifications.

The screeningListsScope object

Attribute	Description
mode	Type: string The criteria to apply to the lists when performing a screening search. Valid values include: inclusion exclusion When this attribute is not provided, it will default to inclusion.
lists	Type: array[string] The lists to include or exclude as part of the screening search.