Legacy v1

The original endpoints. Still served, but they cannot see every list.

Do not build anything new on v1. These endpoints keep working for existing integrations and are not going away without notice, but they are incomplete in a way that matters for compliance.

Why it is deprecated

v1 predates the aggregated list. It queries the nine original sanctions tables directly, so it cannot see the eleven lists added since: World Bank debarment, FBI and NCA wanted lists, BaFin and FCA warnings, shadow fleet vessels and companies, and the five SEC enforcement streams.

The consequence is not cosmetic. A v1 search can report a party clear that v2 finds, because the list carrying the match is not one v1 looks at.

Every v1 response carries a Deprecation header, a Link to its replacement and a Warning saying so, so an integration can detect this without reading this page.

Search

POST /api/v1/search

Auth x-api-key

Request

Field	Type	Required	Description
`prompt`	string	Yes	The name to screen.
`search_type`	string	No	The same four values as v2. Defaults to `fuzzy_search`.

Response

Matches report the physical source table and a raw similarity score, rather than v2’s list slug and match score. There is no api_usage_id in a v1 body.

Field	Type	Description
`name`	string \| null	The matched name.
`table`	string \| null	The source table the match came from.
`similarity`	number \| null	Raw similarity for the match.

{
  "search results": [
    {
      "name": "SMITH, John",
      "table": "ofac_sdn",
      "similarity": 96.1
    }
  ]
}

Bulk search

POST /api/v1/bulk-search

Auth x-api-key

The bulk counterpart, with the same coverage gap. Use v2 bulk screening instead.

Migrating to v2

The request bodies are compatible: the same prompt and search_type work against v2. What changes is the response.

Field	Type	Description
`table`	v1	Becomes `list` in v2, a list slug rather than a physical table name.
`similarity`	v1	Becomes `match_score`.
`id, source_uid`	v2	New. Identify the entity and the publisher’s own reference.
`api_usage_id`	v2	New. Ties the call to its usage record for audit.

Point your client at /api/v2/search and read the new field names. Coverage widens from nine lists to everything we carry.

We use cookies to improve your experience on our website. By browsing this website, you agree to our use of cookies.