v1

latestOpenAPI 3.1.02026-07-24450175.9 KB

Comply Advantage

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

post/

entityTypestring

Choose between person or company.

namestring required

User's full name or company's name

birthYearinteger

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

monitorboolean

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

callbackUrlstring

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

countryCodesstring[]

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

exactMatchboolean

Specify that results must match all specified parameters.

fuzzinessThresholdinteger

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

metadatastring json

Use the metadata parameter to add internal references.

200

{
  "data": {
    "searchedOn": "2020-05-13 09:26:50",
    "nameSearched": "JOHN DOE",
    "profileUrl": "https://public.url"
  }
}

All 45 operations