POST
/
aml
/
checkIndividual
Check Individual
curl --request POST \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/aml/checkIndividual \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Boris Johnson",
  "dob": "1964/06/19"
}'
{
  "timestamp": "2024/09/24T19:16:00Z",
  "totalHits": 1,
  "foundRecords": [
    {
      "id": "c438b18a93cd3c13",
      "sourceType": "PEP",
      "pepType": "POLITICIAN",
      "sourceId": "dilisense_pep",
      "entityType": "INDIVIDUAL",
      "gender": "MALE",
      "name": "Boris Johnson",
      "lastNames": [
        "Johnson",
        "Pfeffel"
      ],
      "aliasNames": [
        "Alexander Boris de Pfeffel Johnson",
        "Boris",
        "BoJo"
      ],
      "givenNames": [
        "Alexander",
        "Boris"
      ],
      "dateOfBirth": [
        "1964/06/19"
      ],
      "placeOfBirth": [
        "New York City"
      ],
      "citizenship": [
        "GB",
        "US"
      ],
      "occupations": [
        "journalist",
        "politician"
      ],
      "positions": [
        "2001/06/07 - 2005/04/11 Member of the 53rd Parliament of the United Kingdom",
        "Since 2019/07/24 Prime Minister of the United Kingdom"
      ],
      "politicalParties": [
        "Conservative Party"
      ],
      "links": [
        "https://www.gov.uk/government/people/boris-johnson",
        "Facebook: borisjohnson"
      ]
    }
  ]
}
For a usage description of the AML Check Individual Service, please refer to the AML page.

​
Endpoint

POST /aml/checkIndividual

​
Swagger

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Search string checked against name fields.

Example:

"Boris Johnson"

​
dob
string

Date of birth in the format yyyy/mm/dd.

Example:

"1964/06/19"

Response

A JSON array of matching individuals.

​
timestamp
string

The timestamp of the response (ISO 8601 date time).

Example:

"2024/09/24T19:16:00Z"

​
totalHits
number

The total number of hits for the searched parameters.

Example:

1

​
foundRecords
object[]

Array with attributes of type Individual.