Comply Advantage

Use this check to verify whether a user or company is listed on international watchlists.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

This API Requires a Webhook URL if You Require Monitoring

Go here for more information on setting up a webhook listener.

This API corresponds to the Anti-Money Laundering merit to verify whether a user or company is listed under watchlists provided by over 800 organizations from across the world, such as:

  • FBI
  • Interpol
  • United Nations

The request body can also include metadata so you can use your own internal references to identify your users and requests. Send metadata for every Webhook. The metadata should have a maximum size of ≦4Kb and be only one level deep.

Body Params
string
Defaults to person

Choose between person or company.

string
required

User's full name or company's name

int32

Applicable to 'person', only. User's year of birth.

boolean
Defaults to false

Set to true if you want the search to be monitored regularly.

string

Callback URL for monitoring updates through webhooks. Mandatory if monitor = true.

countryCodes
array of strings

An array of 2-letter country codes as per ISO 3166-1 alpha-2.

countryCodes
boolean
Defaults to false

Specify that results must match all specified parameters.

int32
Defaults to 50

Integer in range of 0-100 specifying how closely matched results must be to the specified parameters.

json
Defaults to { "user-defined-1" : "abcde", "user-defined-2" : "12345" }

Use the metadata parameter to add internal references.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

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