Overview
The AML (Anti-Money Laundering) Screening endpoint checks whether an individual appears on:
- Sanctions lists — international sanctions databases
- PEP lists — Politically Exposed Persons databases
- Adverse media — negative news and media sources
This supports KYC/AML compliance obligations under FICA and related legislation.
Endpoint
POST /Citizen/AMLScreening
Request
curl -X POST "https://citizen.uat.securecitizen.cloud/Citizen/AMLScreening" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"ConsentReceived": true,
"FirstName": "John",
"LastName": "Doe",
"DateOfBirth": "1980-01-01",
"IdNumber": "8001014800080",
"CRef": "REF00001"
}'
Request Fields
| Field | Type | Required | Description |
|---|
ConsentReceived | boolean | Yes | Must be true |
FirstName | string | Yes | Subject’s first name |
LastName | string | Yes | Subject’s last name |
DateOfBirth | string | No | Date of birth (YYYY-MM-DD) to improve match accuracy |
IdNumber | string | No | SA ID number to improve match accuracy |
CRef | string | No | Your transaction reference |
Response
{
"data": [
{
"name": "John Doe",
"matchScore": 95,
"isPep": false,
"isSanctioned": false,
"hasAdverseMedia": false,
"categories": [],
"sources": []
}
],
"Status": "Success",
"CRef": "REF00001"
}
Response Fields
| Field | Description |
|---|
matchScore | Confidence score of the name match (0–100) |
isPep | true if the individual is flagged as a Politically Exposed Person |
isSanctioned | true if the individual appears on a sanctions list |
hasAdverseMedia | true if adverse media is found |
categories | Categories of PEP/sanctions matches found |
sources | Data sources where matches were found |
A high match score does not necessarily indicate a true positive — always review the matched entity details against your subject to confirm identity before taking action.
