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

Changes

Changed in 3 of the 21 revisions of this API.214

  • 560e8847c7b31See the full diff
    • ▲

      response property data/results/anyOf[subschema #1]/items/screening/anyOf[subschema #1: EntityScreenBatchScreening]/matches/anyOf[subschema #1]/items/rationale/anyOf[subschema #1]/items/ list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 914af3d38c7c12See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the required property data to the response with the 200 status

      response-required-property-added

    • ○

      added the required property meta to the response with the 200 status

      response-required-property-added

  • 4c4530760ba112See the full diff
    • ○

      added the optional property code to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property code to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property code to the response with the 503 status

      response-optional-property-added

    • ○

      added the optional property hint to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property hint to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property hint to the response with the 503 status

      response-optional-property-added

    • ○

      added the optional property plan to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property plan to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property plan to the response with the 503 status

      response-optional-property-added

    • ○

      added the optional property reason to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property reason to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property reason to the response with the 503 status

      response-optional-property-added