---
title: "Screen a name against the sanctions corpus"
method: POST
path: "/api/v1/entity/screen"
tags: ["Sugra Entity"]
---

# Screen a name against the sanctions corpus

`POST /api/v1/entity/screen`

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 body

- EntityScreenRequest
  - `name` string, nullable
  - `country` string, nullable
  - `dob` string, nullable
  - `nationality` string, nullable
  - `as_of` string, nullable
  - `threshold_hit` number
  - `threshold_review` number
  - `corpus` 'sanctions' | 'rf_regulatory' | 'all'
  - `include_excluded` boolean
  - `identifier` RfIdentifierRequest — RF-only exact identifier (INN/OGRN/SNILS/domain/...). Not OFAC docs.
    - `type` 'inn' | 'ogrn' | 'snils' | 'reg_number' | 'domain' | 'url', required
    - `value` string, required

## Response `200`

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

- EnvelopeEntityScreenData
  - `data` EntityScreenData, required
    - `screening` EntityScreenScreening
      - `status` string, nullable
      - `matches` EntityAnchorValueSliceNameMatch[], nullable
        - `list` string, nullable
        - `program` unknown
        - `restriction_type` string, nullable
        - `matched_name` string, nullable
        - `score` union
          - integer
          - number
        - `match_type` string, nullable
        - `rationale` string[], nullable
        - `source_id` string, nullable
        - `list_published` string, nullable
        - `coverage_note` unknown
        - `incomplete_coverage` boolean, nullable
        - `hit_grade` boolean, nullable
        - `identity_conflict` boolean, nullable
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

## Changes

- **2026-08-28** `560e8847c7b3` — 1 breaking
  - response property `data/screening/anyOf[subschema #1: EntityScreenScreening]/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`
- **2026-08-22** `914af3d38c7c` — 1 breaking, 2 info
  - the response's body type/format changed from ``/`` to `object`/`` for status `200`
  - added the required property `data` to the response with the `200` status
  - added the required property `meta` to the response with the `200` status
- **2026-08-08** `4c4530760ba1` — 12 info
  - added the optional property `code` to the response with the `401` status
  - added the optional property `code` to the response with the `429` status
  - added the optional property `code` to the response with the `503` status
  - added the optional property `hint` to the response with the `401` status
  - …8 more
- **2026-07-26** `7fc920a3005c` — 6 info
  - added the new optional request property `corpus`
  - added the new optional request property `identifier`
  - added the new optional request property `include_excluded`
  - the request property `name` became optional
  - …2 more

[Change history](https://skmtc.dev/sugra/apis/sugra-api/changes/api/v1/entity/screen/post.md)

---

[API](https://skmtc.dev/sugra/apis/sugra-api.md) · [All operations](https://skmtc.dev/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sugra/sugra-api/revisions/87582f2e0110/schema)