Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.didx.co.za/llms.txt

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

​
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

FieldTypeRequiredDescription
ConsentReceivedbooleanYesMust be true
FirstNamestringYesSubject’s first name
LastNamestringYesSubject’s last name
DateOfBirthstringNoDate of birth (YYYY-MM-DD) to improve match accuracy
IdNumberstringNoSA ID number to improve match accuracy
CRefstringNoYour transaction reference

​
Response

{
  "data": [
    {
      "name": "John Doe",
      "matchScore": 95,
      "isPep": false,
      "isSanctioned": false,
      "hasAdverseMedia": false,
      "categories": [],
      "sources": []
    }
  ],
  "Status": "Success",
  "CRef": "REF00001"
}

​
Response Fields

FieldDescription
matchScoreConfidence score of the name match (0–100)
isPeptrue if the individual is flagged as a Politically Exposed Person
isSanctionedtrue if the individual appears on a sanctions list
hasAdverseMediatrue if adverse media is found
categoriesCategories of PEP/sanctions matches found
sourcesData 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.