Create a check

Create a check

POST https://api.complycube.com/v1/checks

Creates a new check.

Headers

Name
Type
Description

Content-Type

string

The content-type must always be set to application/json.

Authentication

string

The API live or test key

Request Body

Name
Type
Description

clientId

string

The ID of the client.

type

string

The type of check. Valid values include: 1. standard_screening_check 2. extensive_screening_check 3. document_check 4. identity_check

enableMonitoring

string

Determines whether continuous monitoring is enabled. When not provided, it defaults to false.

documentId

boolean

The ID of the document. This is required when the type of check is document_check or identity_check.

livePhotoId

string

The ID of the live photo. This is required when the type of check is identity_check.

options

object

The optional configuration associated with the check.

{
    "id": "5eb2b61e02df0a0008f1cf2a",
    "clientId": "5eb1276d96be4a0008713af5",
    "entityName": "John Doe",
    "type": "extensive_screening_check",
    "status": "pending",
    "enableMonitoring": false,
    "createdAt": "2020-01-01T14:06:44.756Z",
    "updatedAt": "2020-01-01T14:06:44.756Z"
}

The options object

Attribute

Type

Description

analysisCoverage

array[string]

The types of analysis to conduct as part of a document check. Valid values include:

  1. consistency_analysis

  2. forensic_analysis

  3. content_analysis

  4. format_analysis

  5. front_back_analysis

  6. mrz_analysis

When this attribute is not provided, we will conduct all analysis types.

This is only applicable to checks of type document_check.

Example request

curl -X POST https://api.complycube.com/v1/checks \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          	"clientId":"5eb1276d96be4a0008713af5",
          	"type": "standard_screening_check"
        }'

Last updated