Screen customer

Get Started > API User Guide > Screen Customer

Screen Customer

ClearDil enables you to meet your AML screening commitments by allowing you to screen your customer against our comprehensive database. Depending on the scope, a screening request can include the following :

• Watchlist
  A global database that covers Sanctions and CTF lists from the likes of UN, US, OFAC, EU, UK, Australia as well as over 2500 official lists e.g. Interpol, Europol, Wanted Lists, Human Trafficking, and many more. This highlights if your customer is a Special Interest Entity/Person (SIE/SIEP), or a Relative or a Close Associate (RCA) of a sanctioned entity.

• PEP
  A global database for politicians, their family members, friends, Relative or Close Associates (RCA), and business partners.

• Banned or Disqualified Entities
  Global database for Banned or Disqualified entities/persons (BDE/BDP) e.g. UK Companies disqualified Directors, India’s blacklisted companies, New York Stock Exchange MKT Disciplinary Actions, CEIS (Brazil) National Register of Debarred and Suspended Companies, and many more.

• Adverse Media
  A globally-curated database sourced from highly-trusted media outlets and agencies (e.g. Agency Bulletins, SEC press releases, etc) which mentions Adverse Media Persons/Entities (AMP/AME) adversely such as corruption charges, fraud allegations, or financial crime.

Perform Screening

To perform a screening, all you need to specify is the scope of the desired screening as illustrated below

In the example below, please ensure you replace your_customer_id with customer id obtained from Create Customer.

Example request:

    curl -X POST https://sandbox.cleardil.com/v1/customers/{your_customer_id}/screenings \
      -H 'Authorization: Bearer your_token' \
      -H 'Content-Type: application/json' \
      -d '[
            "pep",
            "watchlist",
            "disqualified_entities",
            "adverse_media"
          ]'

No Matches

If no matches are found, the outcome of all the scopes will be set to CLEAR with the status of the screening marked as DONE.

Example response:

    {
        "id": "2314c348-ece5-4eac-803c-313d5e086a0e",
        "created_at": "2018-02-09T00:14:02.458Z",
        "updated_at": "2018-02-09T00:14:07.793Z",
        "scope": [
            "WATCHLIST",
            "PEP",
            "DISQUALIFIED_ENTITIES",
            "ADVERSE_MEDIA"
        ],
        "status": "DONE",
        "outcome": {
            "DISQUALIFIED_ENTITIES": "CLEAR",
            "WATCHLIST": "CLEAR",
            "PEP": "CLEAR",
            "ADVERSE_MEDIA": "CLEAR"
        },
        "customer_id": "9852967d-3f52-496b-955d-e737abd8c246",
        "entity_name": "Jon Doe"
    }

Matches Found

If matches are found, the corresponding scope will be set to AWAITING_VALIDATION with status of the screening marked as PENDING.

Example response:

    {
        "id": "2314c348-ece5-4eac-803c-313d5e086a0e",
        "created_at": "2018-02-09T00:14:02.458Z",
        "updated_at": "2018-02-09T00:14:07.793Z",
        "scope": [
            "WATCHLIST",
            "PEP",
            "DISQUALIFIED_ENTITIES",
            "ADVERSE_MEDIA"
        ],
        "status": "PENDING",
        "outcome": {
            "DISQUALIFIED_ENTITIES": "CLEAR",
            "WATCHLIST": "AWAITING_VALIDATION",
            "PEP": "CLEAR",
            "ADVERSE_MEDIA": "CLEAR"
        },
        "customer_id": "9852967d-3f52-496b-955d-e737abd8c246",
        "entity_name": "Jon Doe"
    }

Test Data

Use the following sample customer details to test various match types for individuals:

First Name	Last Name	Screening Scope	Expected Outcome
John	Doe	Any	All Clear
Haristo	Yordanov	Watchlist	SIP Match
Carmen	Pereira	PEP	PEP Match
Rosalind	Altmann	PEP	PEP Match
Paul	Richer	Watchlist	RCA Match
Eldar	Dachaev	Disqualified Entities	BDP Match

Use the following sample customer details to test various match types for companies:

Company Name	Screening Scope	Expected Outcome
General Industries	Any	All Clear
Asia Bank	Watchlist	SIE Match
Google, Inc.	Adverse Media	AME Match
National Financial Service	Disqualified Entities	BDE Match

Please refer to the detailed API documentation for further information regarding the screeing API.