Skip to main content
GET
Search Multiple Watchlists

Authorizations

X-API-Key
string
header
required

Query Parameters

q
string
required

The name to search for across the watchlists.

Minimum string length: 1
Examples:

"banco nacional de cuba"

"vladimir putin"

watchlists
enum<string>[]
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.

Minimum array length: 1

Watchlists that can be searched by name via the GET /watchlists route.

Available options:
OFAC,
PEP,
CSL,
FBI,
CNS,
OIG
similarity_threshold
number
default:0.9

Minimum similarity for a match (0.0–1.0).

Required range: 0 <= x <= 1
limit
integer
default:5

Maximum matches to return per watchlist.

Required range: 1 <= x <= 50

Response

Successful Response

Response for a multi-watchlist name search, grouped by source.

Includes one WatchlistSourceResult per requested source — including sources with zero matches — so callers can confirm which lists were searched.

results
WatchlistSourceResult (v1) · object[]
required

Per-source results, one entry per requested watchlist.

total_matches
integer
required

Total matches returned across all searched watchlists.

Examples:

0

5