API Quick Guide

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

Overview

ComplyCube’s API gives you full programmatic access to our verification services. This guide will help you get started quickly, building custom integrations directly into your own systems and applications.

The API provides maximum flexibility for businesses that want complete control over the customer experience and orchestration logic. It exposes all of our services through predictable, resource-oriented endpoints, letting you create clients, trigger KYC checks, and retrieve results.

To get started right away without an API key, try our Postman Demo Collection. It lets you explore the API instantly using a mock account, with no signup required.

Integration steps

The steps below demonstrate how to invoke the ComplyCube API:

Obtain your test API key

ComplyCube authenticates all API requests using your account’s API keys. If you omit a key, or use one that is invalid or expired, the request will return an error.

Each account has two keys: one for testing and one for live requests. API requests always run in either test or live mode, and objects created in one mode, such as clients, addresses, or checks, cannot be accessed or modified from the other.

Always use your test API keys for development and testing to avoid accidentally modifying live data.

Make a test API request

To verify that your integration is set up correctly, send a test API request with 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": "2025-01-04T17:24:29.146Z",
    "updatedAt": "2025-01-04T17:24:29.146Z"
}

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

Running verifications

Learn how to run verification checks using the API.

AML Screening Check - Screen global sanctions, watchlists, PEPs, and adverse media.
Document Check - Verify government-issued ID documents.
Identity Check - Perform liveness and biometric verification.
Proof of Address Check - Extract data and verify POA documents.
Multi-Bureau Check - Match client details against trusted credit and government sources.