Perform AML Screening

Use the API to run AML screening for KYC and KYB against sanctions, PEPs, and watchlists.

Overview

This guide shows you how to run an AML Screening Check using the ComplyCube API for KYC and KYB checks.

You can try this check right away using our Demo Postman Collection. It’s publicly accessible and requires no account.

Integration steps

AML Screening API Guide

1

Create a client

The first step in creating any check is to add a client from your backend server. A client can represent either a person or a company. For individuals, you must provide a first and last name, while for companies only the name is required.

The response will contain an id (the Client ID). It is required for the next step.

While not strictly required, we strongly recommend including a customer’s date of birth when registering an individual.

Example request for creating a client

cURL

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

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const client = await complycube.client.create({
  type: "person",
  email: "[e-mail]",
  personDetails: {
    firstName: "John",
    lastName: "Doe",
    dob: "1990-01-01"
  }
});

Python

from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

new_client = {
    'type':'person',
    'email':'[e-mail]',
    'personDetails': {
        'firstName':'John',
        'lastName':'Doe',
        'dob':'1990-01-01'
    }
}

client = cc_api.clients.create(**new_client)

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$result = $ccapi->clients()->create([
    'type' => 'person',
    'email' => '[e-mail]',
    'personDetails' => [
        'firstName' => 'John',
        'lastName' => 'Doe',
        'dob' => '1990-01-01'
    ]
]);

.NET

using ComplyCube.Net;
using ComplyCube.Net.Resources.Clients;

var clientApi = new ClientApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var newclient = new ClientRequest {
  type = "person",
    email = "[e-mail]",
    personDetails = new PersonDetails {
      firstName = "John",
        lastName = "Doe",
        dob = "1990-01-01"
    }
};

var client = await clientApi.CreateAsync(newclient);

Example response

{
    "id": "5eb04fcd0f3e360008035eb1",
    "type": "person",
    "email": "[e-mail]",
    "personDetails": {
        "firstName": "John",
        "lastName": "Doe",
        "dob": "1990-01-01"
    },
    "createdAt": "2025-01-04T17:24:29.146Z",
    "updatedAt": "2025-01-04T17:24:29.146Z"
}

2

Create an AML Screening Check

Create an AML Screening Check by specifying the Client ID and the check type. ComplyCube supports two AML Screening types: Standard and Extensive. The example below demonstrates an Extensive AML Screening.

The response will contain an id (the Check ID). It is required for the next step.

Example request for creating a check

cURL

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

Node.js

const check = await complycube.check.create("5eb04fcd0f3e360008035eb1", {
    type: "extensive_screening_check"
});

Python

check = cc_api.complycube.checks.create(
    "5eb04fcd0f3e360008035eb1",
    type="extensive_screening_check"
)

PHP

$result = $ccapi->checks()->create(
    '5eb04fcd0f3e360008035eb1',
    ['type' => 'extensive_screening_check']
);

.NET

var checkRequest = new CheckRequest {
  clientId = "5eb04fcd0f3e360008035eb1",
  type = "extensive_screening_check"
};

var check = await checkApi.CreateAsync(checkRequest);

Example response

{
    "id": "5ebd40714f23960008c81527",
    "entityName": "John Doe",
    "type": "extensive_screening_check",
    "clientId": "5eb04fcd0f3e360008035eb1",
    "status": "pending",
    "createdAt": "2025-01-04T17:25:21.116Z",
    "updatedAt": "2025-01-04T17:25:21.116Z"
}

3

Retrieve results

ComplyCube will then run the check. You can retrieve its outcome and detailed breakdown via the API, or review the results in the Portal.

If you have set up webhooks, you’ll also receive a notification once the check is complete.

Example request for retrieving the check outcome

cURL

curl -X GET https://api.complycube.com/v1/checks/5ebd40714f23960008c81527 \
     -H 'Authorization: <YOUR_API_KEY>'

Node.js

const check = await complycube.check.get("5ebd40714f23960008c81527");

Python

check = cc_api.checks.get('5ebd40714f23960008c81527')

PHP

$check = $ccapi->checks()->get('5ebd40714f23960008c81527');

.NET

var check = await checkApi.GetAsync("5ebd40714f23960008c81527");

Example response

{
    "id": "65c12a6426d2ab000814037e",
    "entityName": "John Doe",
    "type": "standard_screening_check",
    "clientId": "5eb04fcd0f3e360008035eb1",
    "status": "complete",
    "result": {
        "outcome": "clear",
        "breakdown": {
            "summary": {
                "pep": {
                    "level1": "clear",
                    "level2": "clear",
                    "level3": "clear",
                    "level4": "clear"
                },
                "watchlist":{
                    "sanctionsLists": "clear",
                    "otherOfficialLists": "clear",
                    "warCrimes": "clear",
                    "terror": "clear",
                    "otherExclusionLists": "clear",
                    "sanctionsControlAndOwnership": "clear"
                },
                "adverseMedia": {
                    "environmentProduction": "clear",
                    "socialLabour": "clear",
                    "competitiveFinancial": "clear",
                    "regulatory": "clear"
                },
                "otherLists": {
                    "associatedEntity": "clear",
                    "organisedCrime": "clear",
                    "financialCrime": "clear",
                    "taxCrime": "clear",
                    "corruption": "clear",
                    "trafficking": "clear"
                }
            }
        }
    },
    "createdAt": "2025-01-04T17:25:21.116Z",
    "updatedAt": "2025-01-04T17:25:21.116Z"
}