API Quick Guide

Get up and running with our API and start developing your ComplyCube integration.

Integrating ComplyCube into your app or website can start as soon as you create a ComplyCube account, requiring only two steps:

  1. Obtain your API keys so ComplyCube can authenticate your integration’s API requests.

  2. Make a test API request to confirm everything is up and running.

If you want to get started using a mock account immediately without an API key, run our Postman Demo Collection.

Step 1: Obtain your API keys

ComplyCube authenticates your API requests using your account’s API keys. If you do not include your key when making an API request or use one that is incorrect or expired, ComplyCube returns an error.

Every account is provided with two keys: one for testing and one for running live requests. All API requests exist in either test or live mode, and objects — clients, addresses, checks, and so forth —cannot be manipulated by objects in the other.

Use only your test API keys for testing and development. This ensures that you don't accidentally modify your live clients or checks.

Step 2: Make a test API request

To check that your integration is working correctly, make a test API request using your test key to create a client.

curl -X POST https://api.complycube.com/v1/clients \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"type": "person",
"email": "[email protected]",
"personDetails":{
"firstName": "John",
"lastName" :"Doe"
}
}'

ComplyCube returns a client object in response to your API request.

{
"id": "5eb04fcd0f3e360008035eb1",
"type": "person",
"email": "[email protected]",
"personDetails": {
"firstName": "John",
"lastName": "Doe"
},
"createdAt": "2020-01-04T17:24:29.146Z",
"updatedAt": "2020-01-04T17:24:29.146Z"
}

Once you have successfully made an API request, you’re ready to begin integrating ComplyCube.

Next steps

Congrats! Learn how to integrate ComplyCube for common use cases.

Powered by a proprietary Graph Engine and a network of partners, an AML Screening Check enables you to check a client against over 3,000 global, regional, and local lists.

Learn about AML Screening Checks

Utilises ComplyCube's state-of-the-art AI and advanced analytics to extract MRZ and perform 6 categories of analysis on ID documents, including detailed checks on visual security elements, daylight/UV, and font consistency.

Learn about Document Checks

Uses ComplyCube's Deep Learning and cutting-edge facial recognition algorithms to analyse and calculate a similarity score between a provided selfie image and an ID document. This will determine if it’s the same person in both images.

Learn about Identity Checks