Perform AML Screening with ID

Use this endpoint to verify an identity and screen the extracted profile against AML watchlists.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to nin

The channel to use for ID verification (e.g., bvn, nin, cac). Get supported codes from the Available Channels endpoint.

string
required
Defaults to 12345678901

The identity number to verify. (Note: Some channels may require additional fields like dob. Check the Available Channels payload).

check_type
array of strings
Defaults to ["sanction","pep"]

The types of AML checks to perform. Defaults to ["sanction", "pep"].

check_type
boolean
Defaults to false

Set to true to perform an adverse media search on the verified identity. Defaults to false.

boolean

Set to true to enable name comparison. If enabled, you must provide first_name and last_name.

string
Defaults to john

Required if compare: true. The first name you have on file to check against the ID.

string
Defaults to doe

Required if compare: true. The last name you have on file to check against the ID.

Headers
string

your api key

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json