Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-24196597.7 KB
aml

Submit AML Job (Enhanced Screening and Monitoring)

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.

post/api/v2/aml

Request body

firstNamestring

The person's first name.

middleNamestring

The person's middle name.

lastNamestring required

The person's last name.

titlestring

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

suffixstring

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

birthDayinteger

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

birthMonthinteger

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

birthYearinteger

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

birthCountrystring

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

gender'MALE' | 'FEMALE' | 'NOT_KNOWN' | 'OTHER'

The person's gender.

emailstring email

The person's email address.

phonestring

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

addressLine1string

Address line 1.

addressLine2string

Address line 2.

addressCitystring

Address city.

addressSubdivisionstring

Address state or subdivision.

addressPostalCodestring

Address postal code.

addressCountrystring

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

addressType'RESIDENTIAL_ADDRESS' | 'MAILING_ADDRESS' | 'OPERATING_ADDRESS' | 'REGISTRATION_ADDRESS' | 'BILLING_ADDRESS'

The type of address.

residenceCountrystring

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

residenceStatus'RESIDENT' | 'PERMANENT_RESIDENT' | 'NON_RESIDENT' | 'TAX_RESIDENT'

The person's residence status.

idExpiryDateDayinteger

ID document expiry day (1-31).

idExpiryDateMonthinteger

ID document expiry month (1-12).

idExpiryDateYearinteger

ID document expiry year.

idIssueDateDayinteger

ID document issue day (1-31).

idIssueDateMonthinteger

ID document issue month (1-12).

idIssueDateYearinteger

ID document issue year.

idCountrystring

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

idNumberstring

The ID document number.

idType'SOCIAL_SECURITY_NUMBER' | 'DRIVING_LICENCE' | 'PASSPORT' | 'IDENTITY_CARD' | 'TAX_REGISTRATION' | 'ALIEN_IDENTIFICATION' | 'EMPLOYER_IDENTIFICATION' | 'OTHER'

The type of ID document.

callbackUrlstring 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.

associatedJobIdstring

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

Response

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