Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Watchlists

Search Multiple Watchlists

Search a name across one or more watchlists, grouped by source.

get/watchlists

Query parameters

qstring required

The name to search for across the watchlists.

Example:banco nacional de cuba

The name to search for across the watchlists.

watchlistsWatchlistSearchSource[] required

Watchlists to search. Repeat the param to search several (e.g. ?watchlists=OFAC&watchlists=PEP). At least one required; one billable order is written per requested watchlist.

Watchlists to search. Repeat the param to search several (e.g. ?watchlists=OFAC&watchlists=PEP). At least one required; one billable order is written per requested watchlist.

similarity_thresholdnumber

Minimum similarity for a match (0.0–1.0).

Minimum similarity for a match (0.0–1.0).

limitinteger

Maximum matches to return per watchlist.

Maximum matches to return per watchlist.

Response

Successful Response

total_matchesinteger required

Total matches returned across all searched watchlists.

Example response

{
  "results": [
    {
      "matches": [
        {
          "name": "banco nacional de cuba",
          "similarity_score": 0.95
        }
      ]
    }
  ]
}