logo

Start review of an AML check

Starts the manual review process for an AML check with a specified ID.

This operation also sets the AML check reviewStartTime to the current date-time, and updates the review information.

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

ID of the resource.

Responses
201

AML check review started.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
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: 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
id
string <= 50 characters

ID of the customer.

object

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

firstName
string <= 45 characters

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

lastName
string <= 45 characters

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

dob
string or null <date>

Customer's date of birth.

address
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

First line of the customer's street address at the time of the AML check.

address2
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

Second line of the customer's street address at the time of the AML check.

city
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Customer's city of residence at the time of the AML check.

region
string or null <= 45 characters ^[\w\s\-\/\p{L},.#;:()']+$

Customer's region of residence at the time of the AML check.

country
string or null

Customer's country of residence at the time of the AML check.

postalCode
string or null <= 10 characters ^[\w\s\-]+$

Customer's postal code at the time of the AML check.

Array of objects (Tag)

List of tags that have been assigned to the customer.

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

Unique name for the tag. 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" "aml-check"
id
string <= 50 characters

ID of the tag.

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 objects (SelfLink)

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 (SelfLink)

Related links.

Array of objects (Tag)

List of AML check tags.

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

Unique name for the tag. 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" "aml-check"
id
string <= 50 characters

ID of the tag.

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 objects (SelfLink)

Related links.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "customer"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

422

Invalid data sent.

post/aml-checks/{id}/start-review
Request samples 
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": {
    },
  • "hits": [
    ],
  • "tags": [
    ],
  • "_links": [
    ]
}
➔ Next to Stop review of an AML check