Screen a batch of names against the sanctions corpus

POST

/api/v1/entity/screen/batch

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

Maintainer:Not configured

OperationId:post_entity_screen_batch

Screen up to 1000 names in one request, each against the OFAC SDN corpus, returning a per-item screening signal (clear, review, or hit) plus an aggregate summary. Each item is screened with the same fail-CLOSED staleness and partial-coverage downgrade as POST /screen. Billing: each item counts as one billable screen (N items = N screens). Fail-CLOSED: if no sanctions list is loaded the whole batch returns 503 (never a per-item false clear).

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Header Params

Body Params application/jsonRequired

Example

{
    "items": [
        {
            "name": "string",
            "country": "string",
            "dob": "string",
            "nationality": "string",
            "id": "string"
        }
    ],
    "threshold_hit": 0.9,
    "threshold_review": 0.7,
    "as_of": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Responses

🟢200OK

application/json

Successful Response

Bodyapplication/json

Example

null

🟠401Unauthorized

🟠422Parameter Error

🟠429

🔴503Service Unavailable

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

Screen a name against the sanctions corpus

Resolve a name to candidate corpus entities