Screen a crypto wallet address against the sanctions corpus

GET

/api/v1/entity/wallet/{address}/screen

Last modified:2026-09-03 17:14:13

Maintainer:Not configured

OperationId:entity_wallet_address_screen

Exact-match screen a wallet address against the OFAC SDN digital-currency addresses (an O(1) lookup, not name matching). Returns hit with the matched record(s) or clear. The query tries the address verbatim AND lowercased so a mixed-case 0x address still matches the stored lowercased key; base58 addresses are checksum-significant and matched verbatim only. Fail-CLOSED: an unavailable index returns 503 (never a clear), and a stale index downgrades a hit/clear to review.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Header Params

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": {
        "screening": {
            "status": "string",
            "matches": [
                null
            ],
            "fifty_percent_rule": {
                "triggered": true,
                "ambiguous": true,
                "aggregate_pct": null,
                "sanctioned_owners": [
                    null
                ],
                "evidence": "string",
                "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

Modified at 2026-09-03 17:14:13

Screening sources manifest: sanctions and PEP source lists, per-source staleness (max_age_hours), attribution, and covered regimes

Screen a document identifier against the sanctions corpus