Retrieve AML checks

Retrieves a list of AML checks. These checks are records of customer data and potentially matching data in AML lists.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of AML checks retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
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.

Array of objects (Tag)

List of tags that have been assigned to the customer.

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.

get/aml-checks
Request samples
Response samples
application/json
[
  • {
    }
]