Sanctions Screening
Screen a person, company or vessel name against the US Consolidated Screening List (Treasury, Commerce and State lists) and get clear, possible match or match, with list, programs and country for every hit.
- Price per call
- 1 credit
- per successful call
- Price ceiling
- 1 credit
- every call, same price
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ sanctions. screenAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/sanctions.screen with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/sanctions.screen" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Banco Nacional de Cuba"}'const res = await fetch('https://api.primaryapi.com/v1/run/sanctions.screen', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'Banco Nacional de Cuba',
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/sanctions.screen",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"name": "Banco Nacional de Cuba",
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "sanctions.screen",
"input": {
"name": "Banco Nacional de Cuba"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/sanctions.screen" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Banco Nacional de Cuba"}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
namestringrequired- Name of the person, company or vessel to screen, 2-150 characters with at least one Latin letter.max 150 chars
countrystring- Optional ISO 3166-1 alpha-2 country code, e.g. "RU": ranks matches from that country first and never removes a match.pattern: ^[A-Za-z]{2}$
typeenum- Only records of this type (records without a type always stay in). Omit to screen every record type.one of: person, entity, vessel
Output
When output.found is true, output.data has these fields.
screenedbooleanoutcomeenum- match = at least one strong matchone of: clear, possible_match, match
nameSearchedstringcountrySearchedstring | nulltypeSearchedenum | null- one of: person, entity, vessel
hitCountinteger- Records scoring at or above the possible-match threshold
strongMatchCountintegerpossibleMatchCountintegerlistsWithHitsstring[]- List codes with at least one hit
topMatchNamestring | nulltopMatchListstring | nulltopMatchProgramsstring[]listsCheckedinteger- Source lists in the screened copy (12 for the full US Consolidated Screening List)
recordsCheckedintegerlistUpdatedstring | null- When the screened list copy was published (ISO-8601)
listIsStaleboolean- The list copy is older than 3 days (a stale copy never reports "clear")
coverageenum- us_csl = all US Consolidated Screening List sources; treasury_only = OFAC SDN + non-SDN only (fallback)one of: us_csl, treasury_only
matchesobject[]- Top 10 hits, strong first, then country matches, then score
matches[].matchStrengthenum- strong = score >= 0.93; possible = 0.80-0.93one of: strong, possible
matches[].matchedNamestring- The listed name or alias that matched best
matches[].matchedOnenum- one of: name, alias
matches[].scorenumber- Name similarity 0-1 (token Jaro-Winkler, our matcher)0–1
matches[].countryMatchboolean- The record lists the requested country
matches[].namestring- Primary listed name
matches[].recordTypestring | null- Individual, Entity, Vessel, Aircraft or null (some lists carry no type)
matches[].listCodestring- Source list code, e.g. SDN, EL, DPL, NON-SDN
matches[].listNamestringmatches[].agencystring | null- Publishing agency, e.g. "Treasury Department"
matches[].programsstring[]- Sanctions programs, e.g. ["CUBA"]
matches[].countriesstring[]- ISO-2 codes on the Consolidated Screening List; country names on the OFAC files
matches[].addressesstring[]matches[].datesOfBirthstring[]matches[].aliasesstring[]- Up to 20 listed aliases
matches[].listedSincestring | nullmatches[].listUrlstring | null- Official source list page
TypeScript type
/** output.data when output.found is true */
type SanctionsScreen = {
screened: boolean;
/** match = at least one strong match */
outcome: "clear" | "possible_match" | "match";
nameSearched: string;
countrySearched: string | null;
typeSearched: "person" | "entity" | "vessel" | null;
/** Records scoring at or above the possible-match threshold */
hitCount: number;
strongMatchCount: number;
possibleMatchCount: number;
/** List codes with at least one hit */
listsWithHits: string[];
topMatchName: string | null;
topMatchList: string | null;
topMatchPrograms: string[];
/** Source lists in the screened copy (12 for the full US Consolidated Screening List) */
listsChecked: number;
recordsChecked: number;
/** When the screened list copy was published (ISO-8601) */
listUpdated: string | null;
/** The list copy is older than 3 days (a stale copy never reports "clear") */
listIsStale: boolean;
/** us_csl = all US Consolidated Screening List sources; treasury_only = OFAC SDN + non-SDN only (fallback) */
coverage: "us_csl" | "treasury_only";
/** Top 10 hits, strong first, then country matches, then score */
matches: {
/** strong = score >= 0.93; possible = 0.80-0.93 */
matchStrength: "strong" | "possible";
/** The listed name or alias that matched best */
matchedName: string;
matchedOn: "name" | "alias";
/** Name similarity 0-1 (token Jaro-Winkler, our matcher) */
score: number;
/** The record lists the requested country */
countryMatch: boolean;
/** Primary listed name */
name: string;
/** Individual, Entity, Vessel, Aircraft or null (some lists carry no type) */
recordType: string | null;
/** Source list code, e.g. SDN, EL, DPL, NON-SDN */
listCode: string;
listName: string;
/** Publishing agency, e.g. "Treasury Department" */
agency: string | null;
/** Sanctions programs, e.g. ["CUBA"] */
programs: string[];
/** ISO-2 codes on the Consolidated Screening List; country names on the OFAC files */
countries: string[];
addresses: string[];
datesOfBirth: string[];
/** Up to 20 listed aliases */
aliases: string[];
listedSince: string | null;
/** Official source list page */
listUrl: string | null;
}[];
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"screened": true,
"outcome": "match",
"nameSearched": "Banco Nacional de Cuba",
"countrySearched": null,
"typeSearched": null,
"hitCount": 1,
"strongMatchCount": 1,
"possibleMatchCount": 0,
"listsWithHits": [
"SDN"
],
"topMatchName": "BANCO NACIONAL DE CUBA",
"topMatchList": "SDN",
"topMatchPrograms": [
"CUBA"
],
"listsChecked": 12,
"recordsChecked": 26186,
"listUpdated": "2026-10-30T22:15:00.000Z",
"listIsStale": false,
"coverage": "us_csl",
"matches": [
{
"matchStrength": "strong",
"matchedName": "BANCO NACIONAL DE CUBA",
"matchedOn": "name",
"score": 1,
"countryMatch": false,
"name": "BANCO NACIONAL DE CUBA",
"recordType": "Entity",
"listCode": "SDN",
"listName": "Specially Designated Nationals",
"agency": "Treasury Department",
"programs": [
"CUBA"
],
"countries": [
"CH",
"ES",
"JP",
"PA"
],
"addresses": [
"Zweierstrasse 35, Zurich, CH-8022, CH",
"Avenida de Concha Espina 8, Madrid, E-28036, ES",
"Dai-Ichi Bldg. 6th Floor, 10-2 Nihombashi, 2-chome, Chuo-ku, Tokyo, 103, JP",
"Federico Boyd Avenue & 51 Street, Panama City, PA"
],
"datesOfBirth": [],
"aliases": [
"BNC",
"NATIONAL BANK OF CUBA"
],
"listedSince": null,
"listUrl": "https://sanctionslist.ofac.treas.gov/Home/SdnList"
}
]
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
Fuzzy name matching in process against list copies refreshed every 6 hours: score >= 0.93 is a strong match, 0.80-0.93 a possible match (our thresholds); legal forms (Inc, LLC, PJSC…) and word order are ignored, the country only ranks. Every answer carries listUpdated and recordsChecked; a copy older than 3 days never answers "clear" (the call fails over instead). A clear screening is a billable answer. No UN/UK/EU lists yet.
Screening aid only: a possible or strong match needs analyst review against the official agency lists before acting, and a "clear" result is not a compliance determination. US sanctions apply strict liability and also cover entities 50% or more owned by listed persons, which no list contains. Names of natural persons are processed: send only what the screening needs.
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/sanctions.screen.