AML Screening - DIDx Developer Documentation

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,
    "ResidentType": "rsa_citizen",
    "IdentificationNumber": "8001014800080",
    "Firstname": "John",
    "Surname": "Doe",
    "BirthDate": "01-01-1980",
    "CRef": "REF00001"
  }'

Request Fields

Field	Type	Required	Description
`ConsentReceived`	boolean	Yes	Must be `true`
`ResidentType`	string	Yes	Subject’s resident type: `rsa_citizen` or `foreign_national`
`IdentificationNumber`	string	Conditional	Identification number that matches the chosen `ResidentType`. Required for `rsa_citizen`
`Firstname`	string	Conditional	Subject’s first name. Required for `foreign_national`
`Surname`	string	Conditional	Subject’s surname. Required for `foreign_national`
`BirthDate`	string	No	Subject’s date of birth in `DD-MM-YYYY` format
`CRef`	string	No	Your transaction reference

Response

{
  "response_object": {
    "matches": [
      {
        "entityType": "string",
        "gender": "string",
        "names": "John Doe",
        "dateListed": "2020-01-01T00:00:00Z",
        "number": "string",
        "reasonListed": "string",
        "comments": "string",
        "additionalInformation": [
          {
            "type": "string",
            "value": "string",
            "comments": "string"
          }
        ],
        "countries": ["South Africa"]
      }
    ]
  },
  "result": true,
  "result_code": {
    "name": "Success",
    "id": 0
  },
  "CRef": "REF00001",
  "Status": "Success",
  "Message": "string"
}

Response Fields

Field	Description
`result`	`true` if the screening succeeded
`result_code`	Result `name` and numeric `id`
`response_object.matches`	Entities that matched the subject
`matches[].entityType`	Type of the matched entity
`matches[].names`	Name of the matched entity
`matches[].gender`	Gender of the matched entity
`matches[].dateListed`	Date the entity was listed
`matches[].reasonListed`	Reason the entity was listed
`matches[].additionalInformation`	Extra details as `type` and `value` pairs
`matches[].countries`	Countries associated with the entity

A match doesn’t necessarily mean a true positive. Always review the matched entity details against your subject to confirm identity before taking action.