Create a check

URL

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.

Authorization*

string

The API live or test key

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

  5. enhanced_identity_check

  6. proof_of_address_check

  7. multi_bureau_check

  8. eid_check

  9. ssn_check

  10. age_estimation_check

  11. identity_fraud_check

  12. driving_license_check

  13. device_intelligence_check

  14. email_intelligence_check

  15. mobile_intelligence_check

  16. face_authentication_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, proof_of_address_check, or driving_license_check.

addressId

string

The ID of the address. This is expected when the check type is multi_bureau_check or identity_fraud_check.

livePhotoId

string

The ID of the live photo. This is expected when the type of check is identity_check, age_estimation_check, or face_authentication_check.

liveVideoId

string

The ID of the live video. This is required when the type of check is enhanced_identity_check.

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.

Example request

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

Example response

{
    "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"
}

Last updated

Was this helpful?