AML

Use Anti-Money Laundering (AML) operations to screen customers and help prevent your business from becoming directly or indirectly involved in criminal activity.

Use AML operations during customer creation, and some transaction processing, to help determine if a potential customer (lead), or customer, has political or economic sanctions against them.

AML operations search the following for screening purposes: Politically Exposed Persons (PEPs) lists, sanction lists, and adverse media lists.

Operations
Webhooks

Retrieve AML checks

Request

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

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

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

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

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

qstring

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

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/aml-checks?limit=1000&offset=1000&sort=string&filter=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of AML checks retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 characters

Unique resource ID.

Example:"aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM"
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

websiteIdstring, <= 50 characters

Website ID associated with the customer.

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
reviewerIdstring or null, <= 50 characters

User ID of the person who reviewed the AML check.

Example:"44433322-2c4y-483z-a0a9-158621f77a21"
reviewerTypestring or nullread-only

Type of reviewer for the current review outcome.

Enum:"human""bot"
Example:"bot"
reviewerNamestring or null

First and last name of the person who reviewed the AML check. If the result is inherited, this field is set to "bot".

reviewStartTimestring or null, (date-time)

Date and time when the AML check review is started.

reviewTimestring or null, (date-time)

Date and time when the AML check review is completed.

prioritystring or null

Highest matched priority of all hits within an AML check.

Default:null
sourcestring

Source of the AML check.

Enum:"sign-up""recurring""purchase"
statusstringread-only

Status of the AML check.

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

customerobject
hitsArray of objects(AML)

List of hits returned during the AML check.

tagsArray of objects(Tag)read-only

List of AML check tags.

provenanceobject or nullread-only

Origin of the AML check result.

noMatchReasonstring or nullread-only

Reason for the no-match result.

Enum:"no_hits_found""mismatched_hits""hits_are_below_relevance_score_threshold""internal_system_error"
Example:"no_hits_found"
noMatchDetailsArray of stringsread-only

List of codes that explain the no-match result.

Example:
[
  "top_hit_not_eligible_for_matching",
  "search_shard_failures"
]
]
Response
[
  {
    "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",
    "reviewerType": "bot",
    "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": [ … ],
    "provenance": { … },
    "noMatchReason": "no_hits_found",
    "noMatchDetails": [ … ],
    "_links": [ … ]
  }
]