Docs
API referenceComplianceSupportHomeLog inSign up
  • Introduction
  • Guides
    • API Quick Guide
      • Perform AML Screening
      • Perform Document Check
      • Perform Identity Check
      • Perform Proof of Address Check
      • Perform Multi-Bureau Check
    • Web Portal Quick Guide
      • Perform AML Screening
      • Perform Document Check
      • Perform Multi-Bureau Check
      • Send verification link to client
    • Web SDK Guide
      • Web SDK integration guide
      • Web SDK customizations
    • Mobile SDK Guide
      • Mobile SDK integration guide
      • Mobile SDK stages
      • Mobile SDK tracked events
      • Mobile SDK error codes
    • Hosted Solution Guide
      • Integration guide
    • Postman Guide
    • Webhooks Guide
    • Integration Checklist
  • Check Types
    • AML Screening Check
      • Lists coverage
    • Document Check
      • ID coverage
      • RFID authentication
      • Redaction
      • Expected sides per type
    • Identity Check
    • Enhanced Identity Check
    • Proof of Address Check
    • Multi-Bureau Check
      • Service coverage
    • Face Authentication Check
    • Age Estimation Check
    • Automation
  • Other Services
    • AML Risk Profile
    • Bulk Processing
    • Autofill
    • Company Search
    • Address Search
    • Custom Lists
    • Advanced Case Management
  • Access Management
    • Teams and User Roles
    • Single Sign On (SSO)
      • SSO with Okta
      • SSO with Microsoft Entra ID
  • Useful Resources
    • Testing Data
  • API Reference
Powered by GitBook
On this page
  • Step 1: Obtain your API keys
  • Step 2: Make a test API request
  • Next steps
  • Perform an AML Screening Check
  • Perform a Document Check
  • Perform an Identity Check
  • Perform a Multi-Bureau Check
  • Perform a Proof of Address Check

Was this helpful?

  1. Guides

API Quick Guide

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

PreviousIntroductionNextPerform AML Screening

Last updated 1 year ago

Was this helpful?

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

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

  2. to confirm everything is up and running.

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

Step 1: Obtain your API keys

ComplyCube authenticates your API requests using your account’s . 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 has two keys: one for testing and one for running live requests. All API requests exist in either , 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 .

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"
          }
        }'
{
    "id": "5eb04fcd0f3e360008035eb1",
    "type": "person",
    "email": "john.doe@example.com",
    "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 lets you check a client against over 3,000 global, regional, and local lists.

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

Uses ComplyCube's Deep Learning and cutting-edge facial recognition algorithms to analyze 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.

Leverage ComplyCube's global and extensive data points to match and verify your client's details against multiple trusted sources, such as government and credit bureaus.

Uses ComplyCube's cutting-edge OCR and decision engine to extract relevant details from Proof of Address (POA) documents and verify them against client-provided details and geolocation.

ComplyCube returns a object in response to your API request.

client
Learn about AML Screening Checks
➔
Learn about Document Checks
➔
Learn about Identity Checks
➔
Learn about Multi-Bureau Checks ➔
Learn about Proof of Address Checks ➔
API keys
test or live mode
create a client
Obtain your API keys
Make a test API request
Perform an AML Screening Check
Perform a Document Check
Perform an Identity Check
Perform a Multi-Bureau Check
Postman Demo Collection
Perform a Proof of Address Check