Developer docs
/
Rebilly API
/
AML
/
Retrieve AML checks

Retrieve AML checks

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

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

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 -. Multiple fields can be sorted by separating each 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.

get
/aml-checks
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.

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.

reviewerName
string or null

First and last name of the person who reviewed the AML check.

reviewStartTime
string or null <date-time>

Date and time when the AML check review is started.

reviewTime
string or null <date-time>

Date and time when the AML check review is completed.

priority
string or null
Default: null

Highest matched priority of all hits within an AML check.

source
string

Source of the AML check.

Enum: "sign-up" "recurring" "purchase"
status
string

Status of the AML check.

Enum Value Description
pending-review

Possible AML match detected and waiting to be manually reviewed.

in-review

A manual AML match review is in progress.

no-match

No possible AML match detected.

confirmed-match

Possible AML match manually reviewed and marked as confirmed.

false-positive

Possible AML match manually reviewed and marked as false positive.

object
Array of objects (AML)

List of hits returned during the AML check.

Array of objects (Tag)

List of AML check tags.

Array of objects

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[
{
"id": "aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
"reviewerId": "44433322-2c4y-483z-a0a9-158621f77a21",
"reviewerName": "string",
"reviewStartTime": "2019-08-24T14:15:22Z",
"reviewTime": "2019-08-24T14:15:22Z",
"priority": null,
"source": "sign-up",
"status": "pending-review",




}
]