Developer docs
/
Rebilly API
/
AML
/
Retrieve an AML check

Retrieve an AML check

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

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

get
/aml-checks/{id}
Responses

200

AML check retrieved.

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

404

Resource not found.

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",
"customer": {
"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",


"organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8"
},
"hits": [

],
"tags": [

],
"_links": [

]
}