Screen a name against U.S. sanctions and export lists
screen_partyScreens one person, company, vessel or aircraft name against a mirrored copy of the U.S. Consolidated Screening List (trade.gov), which combines the export screening lists of the Departments of Commerce, State and the Treasury, including OFAC's Specially Designated Nationals (SDN) list and the BIS Entity List, and against mirrored copies of the UN Security Council Consolidated List, the UK Sanctions List (FCDO) and, when loaded, the EU consolidated financial sanctions list. Matches primary names and aliases while tolerating differences in case, accents, punctuation, word order, company suffixes (LLC, Ltd, GmbH, OOO), small typos, common transliterations and added place or office words (a city, a country, "head office", "branch"). Returns ranked possible matches with score, matched alias, list, programs, entity type, addresses, countries, IDs, a link to the official entry or list and the list's as-of date, or a no-match result at the chosen threshold.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name to screen, as written on the document; any word order, with or without accents or a company suffix. Example: "Rosneft Oil Company". | |
| type | No | Optional entity type filter. Entries from lists that do not state a type are kept. | |
| limit | No | Maximum number of matches to return, 1 to 25 (default 5). | |
| lists | No | Optional: which lists to search. "us" = U.S. Consolidated Screening List (OFAC, BIS, State Department lists), "un" = UN Security Council Consolidated List, "uk" = UK Sanctions List (FCDO), "eu" = EU consolidated financial sanctions list. Default: every list loaded in the mirror (list_status shows which are loaded). A party on several lists appears once per list. | |
| detail | No | "summary" (default) returns the key fields; "full" adds every alias, address, ID, date of birth and remark on the list entry. | summary |
| country | No | Optional country filter: ISO 3166-1 alpha-2 code (e.g. "IR") or English name (e.g. "Iran"). Entries whose list record names only other countries are left out and counted; entries with no country on the list are kept. | |
| min_score | No | Similarity threshold from 0.5 to 1.0 (default 0.85). 1.0 = identical after normalization; lower values return more and weaker possible matches. |