Intelligence · min plan: growth · heavy (5u) · scope: read:sanctions · both

Sanctions Screening

Screens names and optional identifiers against active OFAC, UN, EU, UK, and India source entries.

GET /v1/master/sanctions

Required scope

read:sanctions

API credits

5 per success

Minimum plan

growth

Rate-limit bucket

heavy

Parameters

Name	In	Type	Required	Description
q	query	string	yes	Entity name.
country	query	string	—	Optional ISO alpha-2 country.
threshold	query	number	—	Minimum match score from 0.5 to 1.

Sample request

curl "https://getway.clearie.neximprove.com/v1/master/sanctions?q=example" -H "Authorization: Bearer $CLEARIE_API_KEY"

Sample response

{
  "items": [
    {
      "entity_id": "entity_id",
      "name": "Example Entity",
      "score": 0.98,
      "matched_fields": [
        "primary_name"
      ],
      "lists": [
        "OFAC SDN"
      ]
    }
  ],
  "meta": {
    "weighted_units": 5
  }
}

Live response contract

Live calls require API-key authentication, read:sanctions scope, plan access, and available quota. Successful calls consume 5 API credits.

Sandbox sample response

Workspace try-it calls use isolated representative sandbox records. They are for integration validation, not production filing.

Error examples

401 invalid key · 403 missing scope or plan · 429 quota/rate limit · 404 no verified data where applicable.

Response schema

root object {

items* array [

item object {

entity_id* string// e.g. "entity_id"

name* string// e.g. "Example Entity"

score* number// e.g. 0.98

matched_fields* array [

item string// e.g. "primary_name"

]

lists* array [

item string// e.g. "OFAC SDN"

]

}

]

meta* object {

weighted_units* integer// e.g. 5

}

Try this API live in the workspace

The in-app try-it console runs against the isolated deterministic sandbox repository. It never reads live customer or reference records.

Open in workspace Create account