v5

OpenAPI 3.1.0Proprietary2026-08-031,5423,1505.5 MB
Sugra Entity

Screen a document identifier against the sanctions corpus

Exact-match screen a document identifier (passport, national id, tax id, vessel IMO, or aircraft tail number) against the OFAC SDN identifiers (an O(1) lookup). The query value is normalized per type to match the stored key: passport/national_id/tax_id are upper-cased with separators stripped; vessel_imo drops a leading IMO (any/no separator) and strips separators to bare digits; aircraft_tail is upper-cased. Fail-CLOSED: an unavailable index returns 503 (never a clear); a stale index downgrades a hit/clear to review.

get/api/v1/entity/id/{id_type}/{value}/screen

Path parameters

id_type'passport' | 'national_id' | 'tax_id' | 'vessel_imo' | 'aircraft_tail' required

Identifier type (passport, national_id, tax_id, vessel_imo, aircraft_tail).

Identifier type (passport, national_id, tax_id, vessel_imo, aircraft_tail).

valuestring required

Identifier value to screen.

Identifier value to screen.

Response

Successful Response

{"stackTrail":"paths:/api/v1/entity/id/{id_type}/{value}/screen:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}