Skip to main content
POST
Requires the screen:read scope. Screens the name — and, when given, the company as a second query with results merged — against the active screening lists. Matching is exact case-insensitive (score 1.0) plus fuzzy similarity over names and alternate names; hits scoring 0.7 or higher are returned, top 20 by score. Every request is logged as compliance evidence.
Unlike the other endpoints, this response has no success/message envelope — the body is the result object directly.
​
string
required
The party name to screen (person or organisation), 1–500 chars.
​
string
Company name — screened as a second query; an entry hit by both keeps its best score.
​
object
Optional address, currently informational (matching is name-based): line_1, city, state, postal_code, country_code (ISO alpha-2).
​
string
individual or entity — narrows hits to that party type (vessel, aircraft, and unclassified listings are always kept in scope).

​
Response

​
array
Best score first. Each match:
  • score — 0.7–1.0 (1.0 = exact name or alt-name match)
  • list_code — which screening list the entry is on
  • entry — the listing: name, alt_names, entry_type (individual | entity | vessel | aircraft | unknown), programs, addresses, source_ref, remarks
​
number
Number of matches returned.
​
array
Codes of every active list that was screened against.
Your reference for this call is the X-Request-Id response header (a UUIDv7) — quote it to support or look it up via GET /api/requests to retrieve the archived original payload.
A connectivity check is available at GET /screen/health, returning { "status": "ok", "service": "screen" }.