AML Check Individual Service - IdCanopy API Documentation

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"
      ]
    }
  ]
}

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.

Show child attributes

foundRecords.id

string

Unique identifier for the record.

Example:

"c438b18a93cd3c13"

foundRecords.sourceType

enum<string>

Possible values: SANCTION, PEP, CRIMINAL.

Available options:

SANCTION,

PEP,

CRIMINAL

Example:

"PEP"

foundRecords.pepType

string

Type of PEP (e.g., POLITICIAN, JUDGE, BOARD_MEMBER_OF_CENTRAL_BANK).

Example:

"POLITICIAN"

foundRecords.sourceId

string

The source ID of the list.

Example:

"dilisense_pep"

foundRecords.entityType

enum<string>

Enumeration: INDIVIDUAL, UNKNOWN.

Available options:

INDIVIDUAL,

UNKNOWN

Example:

"INDIVIDUAL"

foundRecords.gender

enum<string>

Enumeration: FEMALE, MALE, UNKNOWN.

Available options:

FEMALE,

MALE,

UNKNOWN

Example:

"MALE"

foundRecords.name

string

Name of the individual.

Example:

"Boris Johnson"

foundRecords.lastNames

string[]

A list of last names of this individual.

Example:

["Johnson", "Pfeffel"]

foundRecords.aliasNames

string[]

A list of alias names of this individual.

Example:

[
  "Alexander Boris de Pfeffel Johnson",
  "Boris",
  "BoJo"
]

foundRecords.givenNames

string[]

A list of given names of this individual.

Example:

["Alexander", "Boris"]

foundRecords.dateOfBirth

string[]

A list of dates of birth for this individual.

Example:

["1964/06/19"]

foundRecords.placeOfBirth

string[]

A list of places of birth for this individual.

Example:

["New York City"]

foundRecords.citizenship

string[]

A list of citizenships for this individual in ISO 3166-1 alpha-2 format.

Example:

["GB", "US"]

foundRecords.occupations

string[]

A list of occupations for this individual.

Example:

["journalist", "politician"]

foundRecords.positions

string[]

A list of positions for this individual.

Example:

[
  "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"
]

foundRecords.politicalParties

string[]

A list of political parties for this individual.

Example:

["Conservative Party"]

foundRecords.links

string[]

A list of links for this individual (e.g., websites, email addresses).

Example:

[
  "https://www.gov.uk/government/people/boris-johnson",
  "Facebook: borisjohnson"
]

Address Verification Service AML Ongoing Monitoring Register Entity Service

⌘I

Endpoints

​Endpoint

​Swagger

Authorizations

Body

Response

Endpoint

Swagger