API Request

Send a POST request to the sanctions screening API to screen one or multiple subjects (up to 20) in a single call. Use a JSON request body with subjects (required) and optional options. Responses are returned synchronously with ranked matches and full sanctions context.

Endpoint

POST https://api.sanctionslookup.com/v1/screen

Method: POST

URL: https://api.sanctionslookup.com/v1/screen

Description: Screens up to 20 subjects against OFAC sanctions lists.

Headers

Header	Requirement	Value	Description
Authorization	required	`Bearer YOUR_API_KEY`	API authentication
Content-Type	required	`application/json`	Request format

See the Authentication page for setup, trial access, and security guidance.

Request body

Description: JSON object with top-level subjects (required) and options (optional).

Example:

{
  "subjects": [
    {
      "subject_ref": "client_123",
      "type": "INDIVIDUAL",
      "name": "Kim Jong Un",
      "identifiers": [
        { "value": "P1234567" }
      ]
    }
  ],
  "options": {
    "min_score": 90,
    "max_results_per_subject": 5
  }
}

subjects ·required

Type: array<object>

Max items: 20

Description: List of subject objects to screen. The array itself is required and may contain up to 20 items.

Field	Type	Requirement	Description
name	string	required	Subject name to screen.
subject_ref	string	optional	Your internal identifier per subject, returned in the response.
type	string	optional*	Subject type. Allowed values: `INDIVIDUAL`, `ENTITY`, `VESSEL`, `AIRCRAFT`, `CRYPTO`.
identifiers	array of objects	optional	Exact identifiers. Each item must be `{ "value": string }`.
details	object	optional	Additional attributes. Requires `type`. See Attributes by subject type.

*Required when details is present.

Identifiers are exact values used to identify a subject. Provide one or more identifiers as an array of objects in the format { "value": "string" }. Examples include LEI (5493001KJTIIGC8Y1R12), tax ID (EE123456789), passport number (P1234567), DUNS (123456789), and VAT (EE12345678).

options ·optional

Type: object

Description: Controls match filtering and response size.

Field	Type	Requirement	Default	Description
min_score	integer	optional	80	Minimum score threshold (0–100).
max_results_per_subject	integer	optional	10	Max matches per subject (>0).

*If omitted, default values are applied automatically.

Attributes by subject type (details)

Description: These fields are provided inside the details object and depend on the selected type.

Example:

{
  "subjects": [
    {
      "type": "INDIVIDUAL",
      "name": "Kim Yong Un",
      "details": {
        "gender": "MALE",
        "date_of_birth": "1980-01-09",
        "country": "Russia",
        "country_code": "RU"
      }
    }
  ]
}

*Values are case-insensitive, but returned in uppercase.

Attributes are descriptive values that provide additional context about a subject, such as date of birth or country code. To use attributes, you must set the type, as attributes are type-specific. See the sections below for supported attributes per type. Including attributes helps improve match precision and reduce false positives.

INDIVIDUAL

Field	Type	Requirement	Description
gender	string	optional	Allowed values: `MALE`, `FEMALE`
date_of_birth	string	optional	Format: `YYYY-MM-DD`
country_code	string	optional	2-letter ISO code (e.g. `US`, `GB`)

ENTITY

Field	Type	Requirement	Description
country_code	string	optional	2-letter ISO code (e.g. `US`, `GB`)

VESSEL

Field	Type	Requirement	Description
flag	array of strings	optional	Flag or registry name (e.g. Panama, Liberia)
call_sign	array of strings	optional	Vessel call sign (e.g. 9HA4112)
year_built	string	optional	Year built (format: YYYY)

AIRCRAFT

Field	Type	Requirement	Description
tail_number	array of strings	optional	Aircraft tail number (e.g. N12345)
manufacturer_serial_number	string	optional	Manufacturer serial number
construction_number	string	optional	Construction number

Updated April 18, 2026