Skip to main content
POST
/
compliance
/
aml
/
lookup
AML lookup
curl --request POST \
  --url https://api.onswitch.xyz/compliance/aml/lookup \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: <api-key>' \
  --data '
{
  "type": "INDIVIDUAL",
  "name": "Jane Doe",
  "country": "NG",
  "date_of_birth": "1990-01-15"
}
'
{
  "success": true,
  "message": "AML lookup successful",
  "timestamp": "2026-05-13T21:44:33.474Z",
  "data": {
    "status": "REJECTED",
    "reference": "18a51cca-ed07-4a74-b1b7-03cceab33e23",
    "details": {
      "subject": {
        "type": "INDIVIDUAL",
        "country": "NG",
        "name": "tinubu bola",
        "is_sandbox": false
      },
      "matches": [
        {
          "certainty": 92,
          "name": "Bola Ahmed Tinubu",
          "source": "https://example.com/entities/ng-chip-pep-ng-0011663",
          "flags": [
            "PEP"
          ],
          "last_updated": "2024-10-11T12:50:30"
        },
        {
          "certainty": 83,
          "name": "Bola Ahmed Tinubu Gcfr",
          "source": "https://example.com/entities/unprot-0312b57d2eeec1382a57638aa4d0979eedecd04c",
          "flags": [
            "PEP"
          ],
          "last_updated": "2026-04-26T13:01:02"
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.onswitch.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-service-key
string
header
required

Service key for API authentication

Body

application/json

Screen a natural person by name, country, and date of birth.

type
enum<string>
required
Available options:
INDIVIDUAL
reference
string<uuid>
name
string

Legal name of the individual to screen.

country
enum<string>
Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
EU,
AN,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BM,
BN,
BO,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
GZ,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
XK,
YE,
YT,
ZA,
ZM,
ZW
date_of_birth
string<date>

Date of birth in YYYY-MM-DD.

Response

AML lookup completed

success
boolean
required
message
string
required
timestamp
string<date-time>
required
data
object
required