latestOpenAPI 3.1.0Proprietary2026-08-221,5563,4526.6 MB

914af3d38c7c

Sugra Entity

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.

post/api/v1/entity/screen

Request body

namestring nullable
countrystring nullable
dobstring nullable
nationalitystring nullable
as_ofstring nullable
threshold_hitnumber
threshold_reviewnumber
corpus'sanctions' | 'rf_regulatory' | 'all'
include_excludedboolean

Response

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

Example response

{
  "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",
    "source": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ]
  }
}