Sanction Check
This endpoint allows you to perform a Sanction check on an individual or entity.
Endpoint: GET {baseurl}/v1/api/aml/perform-customer-check
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Conditional | The full name of the subject. Either name or customerId must be provided. |
customerId | string | Conditional | A unique customer identifier. Either name or customerId must be provided. |
countryCode | string | No | ISO2 country code (e.g., "NG" for Nigeria). |
dob | string | No | The date of birth of the subject in YYYY-MM-DD format. |
dataSource | string | No | The data source to check against. Available values: PEP-LISTS, CRIME, SANCTIONS-LISTS. |
minScore | number | No | The minimum confidence score threshold for the search (between 0 and 1). |
reference | string | No | A unique reference for the verification request. |
customer | string | No | ID of the customer (optional). |
verificationGroup | string | No | ID of the verification group (optional). |
Headers
| Header | Type | Required | Description |
|---|---|---|---|
x-api-key | string | Conditional | API Key to be provided if x-auth-token is not provided. |
Sample Request
curl -X 'GET' \
'{baseurl}/v1/api/aml/perform-customer-check?name=John%20Doe&dataSource=SANCTIONS-LISTS&minScore=0.8&reference=34567899287654567332&dob=1990-01-01&countryCode=NG&customer=6791457be570f7f292f1fe23&verificationGroup=6791457be570f7f292f1fe23' \
--header 'x-api-key: {API-KEY}'Sample Response
{
"status": true,
"statusCode": 200,
"message": "AML Response",
"data": {
"totalMatches": null,
"searchId": "mock-search-456",
"searchTimestamp": "2025-05-15T11:36:58.518Z",
"searchParams": {
"name": "Jane Doe",
"dataSource": "PEP-LISTS",
"minScore": 0.8
}
}
}