Search by customer ID against AML lists

Searches a customer's information, by Rebilly customer ID, against multiple Politically Exposed Person (PEP), sanction, or adverse media lists to determine if the customer is blocklisted. Performs a fuzzy search that uses Soundex. Note that some returned fields may not contain values.

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

Resource identifier string.

Responses
200

Results retrieved.


Returns an array of objects that represent hits, or an empty array if no hits are found.

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
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.

Array
address
string or null

Street address line 1.

address2
string or null

Street address line 2.

city
string or null

City.

region
string or null

State, province, or region.

country
string or null

Country.

birthplace
boolean
Default: false

Individual's place of birth.

dob
Array of strings <date>

One or more possible dates of birth.

Array of objects

List of aliases, if any.

Array
firstName
string

First name of alias.

lastName
string

Last name of alias.

authenticity
string

Degree of confidence in the alias.

Enum: "strong" "weak" "unknown"
Array of objects

Individual's passport information.

Array
number
string

Passport number.

registrationDate
string <date>

Passport registration date.

comments
string or null

Additional information. This content varies per list.

Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
get/customers/{id}/aml
Request samples
Response samples
application/json
[
  • {
    }
]