Submit AML Job (Enhanced Screening and Monitoring)

post

https://verify.vouched.id/api/v2/aml

AML Enhanced Screening and Monitoring helps assess and track financial crime risk for individuals and entities. It delivers an initial screening with optional ongoing monitoring, providing structured results and automated updates as risk profiles change.

If you would like to start using AML Enhanced Screening and Monitoring, please contact Support by filing a ticket here.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

AML Enhanced Screening and Monitoring Request

firstName

string

The person's first name.

middleName

string

The person's middle name.

lastName

string

required

The person's last name.

title

string

The person's title (e.g. Mr, Mrs, Dr).

suffix

string

The person's name suffix (e.g. Jr, Sr, III).

birthDay

integer

The person's birth day (1-31).

birthMonth

integer

The person's birth month (1-12).

birthYear

integer

The person's birth year (e.g. 1990).

birthCountry

string

ISO 3166-1 alpha-2 country code of the person's birth country.

gender

string

enum

The person's gender.

Allowed:

string

The person's email address.

phone

string

The person's phone number in E.164 format (e.g. +14155552671).

addressLine1

string

Address line 1.

addressLine2

string

Address line 2.

addressCity

string

Address city.

addressSubdivision

string

Address state or subdivision.

addressPostalCode

string

Address postal code.

addressCountry

string

ISO 3166-1 alpha-2 country code of the address.

addressType

string

enum

The type of address.

Allowed:

residenceCountry

string

ISO 3166-1 alpha-2 country code of the person's country of residence.

residenceStatus

string

enum

The person's residence status.

Allowed:

idExpiryDateDay

integer

ID document expiry day (1-31).

idExpiryDateMonth

integer

ID document expiry month (1-12).

idExpiryDateYear

integer

ID document expiry year.

idIssueDateDay

integer

ID document issue day (1-31).

idIssueDateMonth

integer

ID document issue month (1-12).

idIssueDateYear

integer

ID document issue year.

idCountry

string

ISO 3166-1 alpha-2 country code of the ID document.

idNumber

string

The ID document number.

idType

string

enum

The type of ID document.

callbackUrl

uri

URL to receive a webhook callback when the AML job completes. NOTE this will also be used for monitoring updates if enabled for the account. The response structure will be identical to the 200 response of this endpoint.

associatedJobId

string

Existing Vouched IDV job ID to be linked to this AML job. This is purely for data tracking purposes. There are no side effects.

Responses

200AML job result. This response structure is also identical to the GET 200 response.

400Invalid request. Schema validation failed or invalid input.

401Authentication failed. Missing or invalid API key.

403AML has not been enabled for this account.

404Resource not found.

429Rate limit exceeded.

500Internal server error.