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

914af3d38c7c

Sugra Entity

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).

post/api/v1/entity/screen/batch

Request body

threshold_hitnumber
threshold_reviewnumber
as_ofstring nullable

Response

Successful Response

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"
    ]
  }
}