Screen a name against the sanctions corpus

POST

/api/v1/entity/screen

Last modified:2026-07-19 17:02:27

Maintainer:Not configured

OperationId:post_entity_screen

Screen a person or organization name against the OFAC SDN corpus and return a screening signal (clear, review, or hit) with matched records. Fail-CLOSED on staleness: if the underlying list is stale, a hit or clear result is downgraded to review and meta.stale_screening is set to true.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "name": "string",
    "country": "string",
    "dob": "string",
    "nationality": "string",
    "as_of": "string",
    "threshold_hit": 0.9,
    "threshold_review": 0.7
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://sugra.ai/api/v1/entity/screen' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "country": "string",
    "dob": "string",
    "nationality": "string",
    "as_of": "string",
    "threshold_hit": 0.9,
    "threshold_review": 0.7
}'

Responses

🟢200OK

application/json

Screening result with status and matches, plus list-freshness and staleness metadata in the envelope meta.

Bodyapplication/json

Example

null

🟠401Unauthorized

🟠422Parameter Error

🟠429

🔴503Service Unavailable

Modified at 2026-07-19 17:02:27

Weather-Disruption-Risk along a corridor (Sugra derived)

Screen a batch of names against the sanctions corpus