Sanctions screening is in beta. GET /sanctions/screen?name=... returns the listed entities whose name or alias matches, with a score and the list that carries them. A hit is a lead for a person to review, never a determination.
Sanctions screening is a beta feature: do not use it as the only sanctions control until it is announced as generally available. It matches names, so every hit needs a human review against the listing before you act.
The demo key does not include sanctions screening. The call needs a key of your own on the Professional plan or above; a trial key has 25 calls on it.
curl 'https://api.prometiam.com/functions/v1/risk-api/sanctions/screen?name=sberbank&limit=3' \ -H 'Authorization: Bearer rk_live_...'
Fetched on 10 November 2026 with a real key. Three hits for one bank, the third and most fields of each cut:
{
"data": [
{
"id": 116752,
"entity_name": "SBERBANK",
"entity_type": "company",
"country": "RU",
"source_list": "FR_GELS",
"program": "(UE)2022/1270 du 21/07/2022 (UE Ukraine intégrité territoriale - R (UE) 269/2014)",
"listing_date": "2022-07-21",
"is_active": true,
"match_score": 100,
"matched_name": "SBERBANK",
"matched_on": "name",
...
},
{
"id": 4310,
"entity_name": "Sberbank",
"aliases": ["Сбербанк"],
"source_list": "EU",
"program": "UKR",
"listing_date": "2022-07-21",
"match_score": 100,
...
},
{ "source_list": "NZ_MFAT", "match_score": 100, ... }
],
"meta": {
"query": "sberbank",
"threshold": 80,
"result_count": 3,
"distinct_entities": 1,
"grouping": "none",
"grouping_hint": "The same entity is listed more than once (one hit per list). Add group=entity for one hit per entity with a lists array.",
...
}
}
A name with no hit gives an empty list. name=Acme Trading S.A. returned "data": [] with "hit_count": 0.
curl -X POST 'https://api.prometiam.com/functions/v1/risk-api/sanctions/screen' \
-H 'Authorization: Bearer rk_live_...' \
-H 'Content-Type: application/json' \
-d '{"names": ["sberbank", "Acme Trading S.A."], "group": "entity"}'
The batch answers one item per name, in your order, each with status match or clear and its hits. On 10 November 2026 (without group): "sberbank" gave match with 10 hits, "Acme Trading S.A." gave clear, and meta counted "items": 2, "matches": 1, "clear": 1. A batch holds at most 50 names and does not draw on the trial allowance.
| Field | What it tells you |
|---|---|
match_score | The match type: 100 the listed name or an alias is the query, 80 to 99 it starts with your words, 50 to 79 it holds them as whole words, under 50 only parts of words. |
matched_on, matched_name | Whether the name or an alias matched, and which. |
source_list, program | The list that carries the entity and the programme it is listed under, with listing_date. |
is_active | False for delisted entities. By default only active listings are screened. |
threshold | The minimum similarity for a name to be returned, 80 by default. Lower it (down to 50 on a single call) to catch spelling variants; expect more noise. |
group=entity | Folds the same entity on several lists into one hit with a lists array. |
The lists screened include the EU consolidated list, the UN list, OFAC, the UK Sanctions List and the Australian DFAT list, with further national lists; source_list names the one behind each hit. Names in other scripts are transliterated before matching. Narrow a call with entity_type, country, list and, for people, dob.
A screened name costs 3 credits: 3 for the GET, 6 for the batch of two. Errors are free. Professional EUR 29.99 includes 10,000 credits a month, Scale EUR 99.99 50,000, Enterprise on request.
clear result is not a certification; it means no hit at or above the threshold on the active lists.include_pep=true) is beta too and covers Spain only.validation_error: name is missing, threshold or limit is out of range, entity_type is not one of the documented values, or a batch is empty or holds more than 50 names.upgrade_required: the plan does not include screening, or the trial calls are used up.batch_exceeds_quota and max_items_now.The free trial lasts 14 days and includes 500 credits. A card is required and nothing is charged during the trial; it then continues as Starter (EUR 9.99/month) unless you cancel.