# API Quick Guide

## 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.

{% hint style="info" %}
To get started right away **without an API key**, try our [Postman Demo Collection](https://docs.complycube.com/documentation/integration-resources/postman#demo-collection). It lets you explore the API instantly using a mock account, with no signup required.
{% endhint %}

## Integration steps

The steps below demonstrate how to invoke the ComplyCube API:

{% stepper %}
{% step %}

#### Obtain your test API key

ComplyCube authenticates all API requests using your account’s [API keys](https://portal.complycube.com/developers). 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](https://app.gitbook.com/s/kAhgmUKSf8CFUFVL3GEe/sandbox-and-live), and objects created in one mode, such as clients, addresses, or checks, cannot be accessed or modified from the other.

{% hint style="warning" %}
Always use your **test** API keys for development and testing to avoid accidentally modifying live data.
{% endhint %}
{% endstep %}

{% step %}

#### 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](https://app.gitbook.com/s/kAhgmUKSf8CFUFVL3GEe/core-resources/clients/create-a-client).

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

ComplyCube returns a [client](https://app.gitbook.com/s/kAhgmUKSf8CFUFVL3GEe/core-resources/clients) object in response to your API request.

```javascript
{
    "id": "5eb04fcd0f3e360008035eb1",
    "type": "person",
    "email": "john.doe@example.com",
    "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.
{% endstep %}
{% endstepper %}

## Running verifications

Learn how to run verification checks using the API.<br>

* <img src="https://2950143584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsw26JqCBnT6AEIbxAYyk%2Fuploads%2FvqlvTElgJ5UVQyfZz5t9%2Fextensive_screening_check.svg?alt=media&#x26;token=458367e3-2d53-411f-8c14-00b388609f05" alt="" data-size="line"> [**AML Screening Check**](https://docs.complycube.com/documentation/quick-guides/api-quick-guide/run-an-aml-screening-check) - Screen global sanctions, watchlists, PEPs, and adverse media.
* <img src="https://2950143584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsw26JqCBnT6AEIbxAYyk%2Fuploads%2FkTUCE5qf9E7Ahu1ZfDQW%2Fdocument_check.svg?alt=media&#x26;token=3436b09d-9862-4f68-99fe-65e8de23fe75" alt="" data-size="line"> [**Document Check**](https://docs.complycube.com/documentation/quick-guides/api-quick-guide/run-a-document-check) - Verify government-issued ID documents.
* <img src="https://2950143584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsw26JqCBnT6AEIbxAYyk%2Fuploads%2FwK5qWSqGhq6boeuCpMyH%2Fidentity_check.svg?alt=media&#x26;token=cd0f6628-5aa7-465b-a0fa-1a3fb59ea5eb" alt="" data-size="line"> [**Identity Check**](https://docs.complycube.com/documentation/quick-guides/api-quick-guide/run-an-identity-check) - Perform liveness and biometric verification.
* <img src="https://2950143584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsw26JqCBnT6AEIbxAYyk%2Fuploads%2FWbi1M61EpLj6m3FE5Unc%2Fproof_of_address_check.svg?alt=media&#x26;token=fbbe80aa-c568-401a-b52f-4f2931d6a1bb" alt="" data-size="line"> [**Proof of Address Check**](https://docs.complycube.com/documentation/quick-guides/api-quick-guide/perform-proof-of-address-check) - Extract data and verify POA documents.
* <img src="https://2950143584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsw26JqCBnT6AEIbxAYyk%2Fuploads%2FaRAr9OJoZjBQohpQ9vTt%2Fmulti_bureau_check.svg?alt=media&#x26;token=ed957655-cd77-4683-9562-9a5d32513cb2" alt="" data-size="line"> [**Multi-Bureau Check**](https://docs.complycube.com/documentation/quick-guides/api-quick-guide/perform-multi-bureau-check) - Match client details against trusted credit and government sources.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.complycube.com/documentation/quick-guides/api-quick-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.