AML

AML, also known as Anti-Money-Laundering is an endpoint that searches multiple PEP, Sanctions, and Adverse Media lists for listed identities or media for screening purposes. Used during some transaction processing and on Contact creation, it helps determine whether someone is blocklisted or has political or economic sanctions against them.

Search PEP/Sanctions/Adverse Media lists

Search multiple PEP/Sanctions/Adverse Media lists with first and last name to find any blocklisted identities. Performs a fuzzy search including soundex. Not all fields are guaranteed to be filled.

Request
Security:
query Parameters
firstName
required
any

First name of individual to search.

lastName
required
any

Last name of individual to search.

dob
any

Date of birth in format YYYY-MM-DD.

country
any

Country of individual as an ISO Alpha-2 code.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200An array of objects representing hits, or an empty array if none are found.
Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array
firstName
string

First Name.

lastName
string or null

Last Name. null if it is a single-name entity.

source
string

Which list this came from.

sourceType
string

The list type.

Enum: "pep" "sanctions" "adverse-media"
gender
string or null

Gender of returned identity (if type is individual).

title
Array of strings or null

The title of their position.

type
string

The record type.

Enum: "individual" "entity"
legalBasis
Array of strings

List of references to legal documents if they exist.

regime
string or null

Regime.

confidence
string

The source list's confidence in information.

Enum: "weak" "medium" "strong" "very-strong"
nationality
string

The nationality of the identity.

Array of objects

Addresses related to the identity.

dob
Array of strings <date>

One or more possible dates of birth.

Array of objects

List of aliases, if any.

Array of objects

Passport information.

comments
string or null

Extra information (the content varies per list).

Array of objects (schemas) non-empty

The links related to resource, including links provided by the list.

get/aml
Request samples
curl -i -X GET \
  https://api-sandbox.rebilly.com/aml \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

AML list possibly matchedWebhook

Request
Security:
Request Body schema: application/json

Customer webhook request body resource.

customerId
string

The customer ID.

eventType
string (GlobalWebhookEventType)

Rebilly webhooks event type.

Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "dispute-modified" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-onboarding-completed" "gateway-account-onboarding-failed" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "lead-source-changed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "payment-instrument-modified" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed"
object
Array of CustomerLink (object) non-empty

The links related to resource.

Responses
2xxReturn any 2xx status to indicate that the data was received successfully.
Request samples
application/json
{
  • "customerId": "string",
  • "eventType": "aml-list-possibly-matched",
  • "_embedded": {
    },
  • "_links": [
    ]
}