Screen a name against the sanctions corpus

Screen a person or organization name against the sanctions 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. ENTITY-4: optional corpus selects sanctions (default - Western/IGO + PEP), rf_regulatory (Russian domestic Minjust lists), or all.

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,
    "corpus": "sanctions",
    "include_excluded": false,
    "identifier": {
        "type": "inn",
        "value": "string"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

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

Bodyapplication/json

Example

{
    "data": {
        "screening": {
            "status": "string",
            "matches": [
                {
                    "list": "string",
                    "program": null,
                    "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"
    },
    "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