AML screening match details

GET/api/v2/aml/screening/info

When an AML screening returns hits, each match carries the details below. This page explains what those attributes mean and how to read the match score so you can make a compliance decision.

Headers

Header	Required	Description
`Authorization`	Yes	Your app’s secret key, sent as-is — not `Bearer`.
`AppId`	Yes	The App ID from your dashboard.

Query parameters

Parameter	Type	Required	Description
`id`	string	Yes	The reference/ID of the AML screening whose match details you want.

What’s in a match

Attribute	What it tells you
Name & aliases	The matched entity’s primary and alternate names.
Entity type	Whether the match is a person or an organization.
Match score	Confidence of the match — see the scoring guide below.
Category	The AML classification — sanctions, PEP, or adverse media.
Date of birth & country	Demographic identifiers used to confirm the match.
Media articles	Related adverse-media references, with source and publication date.
Risk level	Overall risk assessment for the match.

Match categories

Every match falls into one of three types:

Sanctions — entities under government-enforced restrictions.
PEPs — Politically Exposed Persons.
Adverse media (AM) — negative news coverage and warnings.

Interpreting the score

Scoring prioritises sanctions over other types, exact name matches over fuzzy ones, and alignment on date of birth and country. Two scales apply, depending on the category:

Category	Score range	Meaning
Sanctions	`1.1` – `2.0`	Higher is a stronger match.
Warnings / PEPs / Adverse media	`0.1` – `1.0`	Higher is a stronger match; `0.7` indicates an exact match.

Response

Returns the match entity — its name and aliases, entity type, category (match_types), score, risk level, identifying fields, and any related media. The example on the right is representative; the live response carries the full match set.

Errors

Code	Meaning
`400`	Bad request — a required parameter is missing or malformed.
`401`	Unauthorized — check your key and `AppId` (no `Bearer` prefix).
`402`	Insufficient wallet balance. Fund your wallet.
`404`	No record found for the supplied identifier.
`429`	Too many requests — back off and retry.

curl --request GET \
  "https://api.dojah.io/api/v2/aml/screening/info?id=6e3f2a1b-9c4d-4e2f-8a1b-2c3d4e5f6a7b" \
  -H "Authorization: {{secret_key}}" \
  -H "AppId: {{app_id}}"

const params = new URLSearchParams({
  "id": "6e3f2a1b-9c4d-4e2f-8a1b-2c3d4e5f6a7b",
});

const url = "https://api.dojah.io/api/v2/aml/screening/info?" + params;
const res = await fetch(url, {
  headers: {
    Authorization: process.env.DOJAH_SECRET_KEY,
    AppId: process.env.DOJAH_APP_ID,
  },
});
const data = await res.json();

import os, requests

res = requests.get(
    "https://api.dojah.io/api/v2/aml/screening/info",
    headers={
        "Authorization": os.environ["DOJAH_SECRET_KEY"],
        "AppId": os.environ["DOJAH_APP_ID"],
    },
    params={ "id": "6e3f2a1b-9c4d-4e2f-8a1b-2c3d4e5f6a7b" },
)
data = res.json()

{
  "entity": {
    "id": "6e3f2a1b-9c4d-4e2f-8a1b-2c3d4e5f6a7b",
    "name": "John Doe",
    "aka": ["Johnny Doe"],
    "entity_type": "person",
    "match_types": ["sanction"],
    "score": 1.8,
    "risk_level": "high",
    "fields": {
      "date_of_birth": "1970-01-01",
      "country": "NG"
    },
    "media": [
      {
        "title": "Regulator names individuals in sanctions notice",
        "url": "https://example-news.com/notice",
        "date": "2021-05-01",
        "source": "Example News"
      }
    ]
  }
}

Get started

Core concepts

API Endpoints

Widget SDKs

API clients

AML screening match details

Headers

Query parameters

What’s in a match

Match categories

Interpreting the score

Response

Errors

​Headers

​Query parameters

​What’s in a match

​Match categories

​Interpreting the score

​Response

​Errors

Headers

Query parameters

What’s in a match

Match categories

Interpreting the score

Response

Errors