Retrieve an AML check

Retrieves the results of a customer's AML check. Customer metadata and an array of matching AML hits is returned.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Responses
200

AML check retrieved.

Response Schema: application/json
id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

websiteId
string <= 50 characters

Website ID associated with the customer.

reviewerId
string or null <= 50 characters

User ID of the person who reviewed the AML check.

reviewTime
string or null <date-time>

Date and time when the AML check review is completed.

object
id
string <= 50 characters

ID of the customer.

object

Customer's data at the time of the AML check.

firstName
string

Customer's first name at the time of the AML check.

lastName
string

Customer's last name at the time of the AML check.

dob
string or null <date>

Customer's date of birth.

country
string

Customer's country of residence.

Array of objects (Tag)

List of tags that have been assigned to the customer.

Array
name
required
string <= 255 characters ^[@~\-\.\w\s]+$

Unique tag name. Tag names are not case-sensitive.

type
required
string

Type of tag. Tags of a specific type can only be assigned to corresponding entity types. For example, you can only use customer tags on customers.

Enum: "customer" "kyc-document"
id
string <= 50 characters

Unique tag identifier string.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of Self (object) non-empty

Resource related links.

organizationId
string <= 50 characters

ID of the customer's organization.

Array of objects (AML)

List of hits returned during the AML check.

Array
firstName
string

First name of the individual, or name of entity.

lastName
string or null

Last name of the individual. Returns a null value for single-named entities.

source
string

Describes which list the result is from.

sourceType
Array of strings

Describes the categories of the individual or entity.

Items Enum: "pep" "sanctions" "adverse-media" "enforcements" "state-owned-enterprise"
gender
string or null

If type=individual, this field describes the gender of the individual.

title
Array of strings or null

Individual's job title.

type
string

Describes whether the source is an individual or an entity.

Enum: "individual" "entity"
legalBasis
Array of strings

List of references to legal documents, if they exist.

regime
string or null

Describes the government, administration, or political entity.

confidence
string

Degree of confidence in the source list information.

Enum: "weak" "medium" "strong" "very-strong"
nationality
string

Nationality of the individual or entity.

Array of objects

Addresses associated with the individual or entity.

dob
Array of strings <date>

One or more possible dates of birth.

Array of objects

List of aliases, if any.

Array of objects

Individual's passport information.

comments
string or null

Additional information. This content varies per list.

Array of objects (Self) non-empty

Related resource links.

Array of Self (object) or CustomerLink (object) non-empty

Related links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/aml-checks/{id}
Request samples
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "reviewerId": "44433322-2c4y-483z-a0a9-158621f77a21",
  • "reviewTime": "2019-08-24T14:15:22Z",
  • "customer": {
    },
  • "hits": [
    ],
  • "_links": [
    ]
}