👥Sanctions

The APIs allows verifiers to build an in-app experience.

The following APIs allows to verify the AML status - PEP, Sanctions and of the user. We recommend to use this only for verified individuals.

AML

POST https://<server_address>/api/aml

For all individual AML verifications entity_type = person.

Replace <server_address> with the respective environment URL from the Onboarding handbook.

Headers

Name	Type	Description
Authorization*	String	Bearer <token>

Request Body

Name	Type	Description
entity_type*	String	person
name*	String	full name of the person
dob*	String	date of birth ex:31-05-1990

200: OK

//response
// possible values for match_found are
// 1. Potential match
// 2. No
// in either cases, aml_profile will be present in the response.  
{
    "credential_type": "aml",
    "credential_name": "AML",
    "issued_by": "UNIFID",
    "issuer_id": "4aa24fe5-2e8f-4b75-9dbb-499fb6dbbab4",
    "cred_version": "1.0",
    "credentials": {
        "attributes": {
            "name": "Santos Florence",
            "birth_year": "1989",
            "searched_on": "2023-02-15 22:02:00",
            "match_found": "Potential match",
            "aml_profile": "<aml profile url>"
        }
    }
}

// sample request body
// name - provide full name of the user including any middle names
// dob - Date of Birth must be provided in dd-mm-yyyy format

{
    "entity_type": "person",
    "name": "Santos Florence",
    "dob": 01-06-1989,
}