API ReferenceChecks

Get a watchlist

Retrieves a watchlist by ID. Works for both system-managed and custom lists.

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

list_idstringRequired

Watchlist ID (wl_*).

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Response

Watchlist details.
idstring
namestring
list_typeenum
Allowed values:
entry_countinteger
is_activeboolean
is_systemboolean

true for system-managed lists (OFAC/SDN), false for custom.

created_atdatetime
descriptionstring or null
updated_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error