Screen a batch of names against the sanctions corpus

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

Responses

🟢200OK

application/json

Successful Response

Bodyapplication/json

Example

{
    "data": {
        "results": [
            {
                "id": "string",
                "screening": {
                    "status": "string",
                    "matches": [
                        {
                            "list": "string",
                            "program": "string",
                            "restriction_type": "string",
                            "matched_name": "string",
                            "score": 0,
                            "match_type": "string",
                            "rationale": [
                                "string"
                            ],
                            "source_id": "string",
                            "list_published": "string",
                            "coverage_note": null,
                            "incomplete_coverage": true,
                            "hit_grade": true,
                            "identity_conflict": true,
                            "property1": "string",
                            "property2": "string"
                        }
                    ],
                    "property1": "string",
                    "property2": "string"
                },
                "property1": "string",
                "property2": "string"
            }
        ],
        "summary": {
            "total": 0,
            "clear": 0,
            "review": 0,
            "hit": 0,
            "property1": "string",
            "property2": "string"
        },
        "property1": "string",
        "property2": "string"
    },
    "meta": {
        "endpoint": "/api/v1/fred/us/cpi",
        "data_time": "2026-04-16T14:30:00Z",
        "response_time": "2026-04-16T14:30:12Z",
        "provider": "Sugra API v1.0.1",
        "data_age_days": 0,
        "source": "string",
        "attribution": "string",
        "fallback_used": true,
        "fallback_chain": [
            "string"
        ],
        "cached": true,
        "stale": true,
        "period": "string",
        "notes": "string"
    }
}

🟠401Unauthorized

🟠422Parameter Error

🟠429

🔴503Service Unavailable