---
title: "Screen a name against sanctions lists (BETA)"
method: GET
path: "/sanctions/screen"
tags: ["Sanctions"]
---

# Screen a name against sanctions lists (BETA)

`GET /sanctions/screen`

## Request

- Base URL: `https://api.prometiam.com/functions/v1/risk-api`
- URL: `https://api.prometiam.com/functions/v1/risk-api/sanctions/screen`
- Auth: HTTP bearer

**BETA. Do not use as the sole sanctions control until announced GA.**

Trigram fuzzy match of a person or entity name against the EU consolidated list, the UN sanctions list, OFAC, and the UK Sanctions List. Returns matched entities with confidence scores. Names in non-Latin scripts (Cyrillic, Greek, Arabic and others) are transliterated to Latin letters, in the query and in the listed names, before matching, so a name sent in its own script (Руслан Александрович Ромашкин) and the same name in Latin spelling (Ruslan Aleksandrovich Romashkin) match the same listed entity.

## Query parameters

- `name` string, required
- `threshold` integer
- `entity_type` 'person' | 'company' | 'vessel' | 'aircraft' | 'unknown' | 'any' | 'entity'
- `limit` integer
- `include_pep` boolean
- `pep_min_tier` 'national' | 'regional' | 'local'
- `group` 'entity'

## Response `200`

Sanctions match results

- object
  - `data` SanctionsHit[]
    - `id` integer: Sanctions entity id. Use with GET /sanctions/entity/{id}.
    - `entity_name` string: Name as published by the source list.
    - `entity_type` 'person' | 'company' | 'vessel' | 'aircraft' | 'unknown': Values are literal. 'any'/'entity' are NOT stored values.
    - `aliases` string[], nullable
    - `country` string: Country as published. Often null.
    - `nationality` string
    - `date_of_birth` string, date, nullable
    - `date_of_birth_raw` string, nullable: Unparsed DOB string as published (may be a range or partial).
    - `date_of_incorporation` string, date, nullable
    - `identification_numbers` object, nullable: Passport / tax / registry numbers keyed by type.
    - `source_list` string: e.g. OFAC, EU, UN, or a US export-control list.
    - `program` string
    - `program_detail` string, nullable
    - `listing_date` string, date, nullable
    - `delisting_date` string, date, nullable
    - `is_active` boolean: False once delisted.
    - `notice_url` string, nullable: Link to the publishing authority's notice.
    - `match_score` integer: Fuzzy match confidence, 0-100.
    - `matched_name` string: The specific string that matched - the entity name or one alias.
    - `matched_on` 'name' | 'alias': Which field produced matched_name.
  - `meta` Meta
    - `query_ms` integer
    - `search_mode` string
    - `country` 'ES' | 'FR' | 'GB' | 'IE' | 'PL' | 'NO' | 'FI' | 'SE' | 'HR' | 'BE' | 'DK' | 'EE' | 'SK' | 'CH' | 'LV' | 'CY' | 'RO' | 'LT' | 'CA' | 'AU' | 'JP' | 'IL' | 'BR' | 'CO' | 'SG' | 'TW' | 'CZ' | 'DE' | 'US'
    - `rate_limit` RateLimitMeta
      - `rpm_remaining` integer
      - `daily_remaining` integer

## Other responses

- `400`: Missing or invalid parameters
- `401`: Missing, invalid, or expired API key
- `403`: Key lacks the required scope or country access
- `429`: Rate limit exceeded — see `Retry-After` header for seconds until reset

---

[API](https://skmtc.dev/prometiam/apis/prometiam-risk-intelligence-api.md) · [All operations](https://skmtc.dev/prometiam/apis/prometiam-risk-intelligence-api/llms.txt) · [OpenAPI document](https://skmtc.dev/prometiam/apis/prometiam-risk-intelligence-api/revisions/3ee0626d5a45?raw)