API reference, Global watchlist

Process global watchlist

POSThttps://demo-api.incodesmile.com/omni/process/global-watchlist

This endpoint processes a global watchlist search for an individual using the watchlist configuration defined in the flow (including settings for subscription to ongoing monitoring). It performs a comprehensive screening against global watchlists (sanctions, PEPs, adverse media) and saves the results for further processing. The endpoint returns a basic success/failure response.

Headers

api-versionstringrequiredDefaults to 1.0

Request body

application/json

firstNamestring
surNamestring
birthYearinteger (int32)

Year of birth, if known

countryCodesarray
watchlistTypesarray
subscribeboolean

Subscribes to updates on the watchlists to receive notification for updates on the search.

fuzzinessnumber (float)

Determines how closely the returned results must match the supplied name.

search_profilestring

Search profile set for the client to use specify what sources they will be searching against.

Responses