> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usecroma.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Consolidated Screening List
> Every US export and sanctions screening list in one search: the Treasury's OFAC lists, the Commerce Department's Entity List, Denied Persons, Unverified and Military End User lists, and the State Department's nonproliferation sanctions and ITAR debarments. Search by name or alias, list, agency, program, country or an identifying number, and read one party's full record.
Three US agencies keep lists of parties that US persons may not deal with, or
may export to only under a license. The Treasury's Office of Foreign Assets
Control keeps the sanctions lists, the Commerce Department's Bureau of Industry
and Security keeps the export control lists, and the State Department keeps the
nonproliferation sanctions and the parties debarred from arms trade. The
International Trade Administration consolidates all of them into one list, and
that is what this source serves: one search screens a name against every list
at once.
Each party comes with every name the list records, its addresses, the programs
or statutes behind the listing, the identifying numbers the list records (tax
and registration numbers, passports, SWIFT codes, vessel IMO numbers, digital
currency addresses), and for the Commerce lists the Federal Register notice,
the date the listing took effect and the license terms. Brought up to date
every day; a party an agency delists stops matching within a day.
| `list` | List | Agency |
| -------- | ------------------------------------------------------------------ | --------------- |
| `sdn` | Specially Designated Nationals and Blocked Persons | Treasury (OFAC) |
| `ssi` | Sectoral Sanctions Identifications | Treasury (OFAC) |
| `cmic` | Non-SDN Chinese Military-Industrial Complex Companies | Treasury (OFAC) |
| `ns_mbs` | Non-SDN Menu-Based Sanctions | Treasury (OFAC) |
| `plc` | Palestinian Legislative Council | Treasury (OFAC) |
| `cap` | Correspondent Account or Payable-Through Account Sanctions (CAPTA) | Treasury (OFAC) |
| `fse` | Foreign Sanctions Evaders | Treasury (OFAC) |
| `el` | Entity List | Commerce (BIS) |
| `dpl` | Denied Persons List | Commerce (BIS) |
| `uvl` | Unverified List | Commerce (BIS) |
| `meu` | Military End User List | Commerce (BIS) |
| `isn` | Nonproliferation Sanctions | State |
| `dtc` | ITAR Debarred | State |
The Entity List also lists some addresses on their own, under names such as
`Address 01`, with the address in `addresses`: `list: "el"` with a `country`
finds them.
For the Treasury lists alone, with OFAC's own notes on each party, use
[OFAC sanctions](/guides/united-states/ofac).
The whole source, organized and ready to query: every endpoint on this page answers in milliseconds. Every response carries `as_of`: how current the data is. [How datasets work](/datasets).
## Screen a name
`POST /us/csl/parties-search/v1` Dataset
Searches every list by any combination of name or alias, list, agency,
party type, program, country, identifying number and listing date.
| Field | Type | Notes |
| ------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | string | Optional. Words in the party's name or any other name the list records. Every word must match; no stemming. |
| `list` | enum | Optional. One list, by the code in the table above, e.g. `el` for the Entity List. |
| `agency` | enum | Optional. `treasury` for the OFAC lists, `commerce` for the Bureau of Industry and Security's, `state` for the State Department's. |
| `party_type` | enum | Optional. `individual`, `entity` for a company or organisation, `vessel` or `aircraft`. Only the Treasury lists record a type, so this filter leaves the others out. |
| `program` | string | Optional. A sanctions program or statute exactly as it appears in `programs`, e.g. `SDGT`, `RUSSIA-EO14024`, `CMIC-EO13959`, `Chemical and Biological Weapons Act`. |
| `country` | string | Optional. The two-letter code of the country of one of the party's addresses, e.g. `CN`, `RU`, `VE`. |
| `identifier` | string | Optional. An identifying number the list records for the party: a tax id such as a NIT, RFC or RUC, a registration number, a passport, a SWIFT code, an IMO number, a digital currency address. Matched ignoring case, spaces and punctuation, so `900.123.456-7` and `9001234567` match alike. |
| `from_date` | string | Optional. The earliest date the listing took effect, yyyy-mm-dd. Only the Commerce lists and the nonproliferation sanctions record it, so a date filter leaves the others out. |
| `to_date` | string | Optional. The latest date the listing took effect, yyyy-mm-dd. |
| `page` | integer | Optional. 1-based page. Default `1`. |
| `per_page` | integer | Optional. Results per page, 1-50. Default `20`. |
```bash theme={"dark"}
curl https://api.croma.run/us/csl/parties-search/v1 \
-H "Authorization: Bearer $CROMA_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "query": "huawei" }'
```
Returns `as_of` (how current the data is), the applied filters, `total` (matches across every page), `page`, `per_page`, `total_pages`, `count` and `parties[]`, by name.
Every party carries `id` (the key), `list`, `list_name`, `agency` (`treasury`, `commerce` or `state`), `entity_number` (OFAC's number, on a Treasury list), `name`, `alt_names[]`, `party_type` (`individual`, `entity`, `vessel` or `aircraft`, on a Treasury list), `programs[]`, `title`, `remarks`, `addresses[]` (`{ address, city, state, postal_code, country }`), `countries[]`, `identifiers[]` (`{ type, number, country, issue_date, expiration_date }`: tax and registration numbers, passports, national ids, SWIFT codes, vessel IMO numbers, digital currency addresses, websites), `identifier_numbers[]`, `dates_of_birth[]`, `places_of_birth[]`, `nationalities[]`, `citizenships[]`, `federal_register_notice`, `start_date`, `end_date`, `standard_order`, `license_requirement`, `license_policy`, `vessel` (for a vessel), `source_list_url` and `source_information_url` (the agency's pages for the list).
Empty fields are `null`. Each list fills its own subset: the Commerce and State lists carry no party type, and dates, license terms and Federal Register notices come mostly from them.
The `id` of an entry on a Treasury list is the list and OFAC's entity number
(`sdn-36`), the same number the [OFAC sanctions](/guides/united-states/ofac)
endpoints use. On a Commerce or State list it is the list and the entry's own
code, which changes when the agency amends the entry: search by name again
rather than storing it for long.
The search matches the party's name and every other name the list records,
word by word and without stemming. Brought up to date daily; a party an agency
delists stops matching.
A name match is a starting point, not a determination. Each agency's guidance
is to confirm a hit against the party's other identifiers (addresses, dates of
birth, registration numbers) before acting on it, and the lists carry many
similar names.
## One party
`POST /us/csl/party/v1` Dataset
Resolves one party by its id and returns the full record.
| Field | Type | Notes |
| ----- | ------ | ---------------------------------------------------------------------- |
| `id` | string | **Required.** The party's id as returned by the search, e.g. `sdn-36`. |
```bash theme={"dark"}
curl https://api.croma.run/us/csl/party/v1 \
-H "Authorization: Bearer $CROMA_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "id": "sdn-36" }'
```
Returns `found`, `id`, `as_of` and `party` (null when not found).
Every party carries `id` (the key), `list`, `list_name`, `agency` (`treasury`, `commerce` or `state`), `entity_number` (OFAC's number, on a Treasury list), `name`, `alt_names[]`, `party_type` (`individual`, `entity`, `vessel` or `aircraft`, on a Treasury list), `programs[]`, `title`, `remarks`, `addresses[]` (`{ address, city, state, postal_code, country }`), `countries[]`, `identifiers[]` (`{ type, number, country, issue_date, expiration_date }`: tax and registration numbers, passports, national ids, SWIFT codes, vessel IMO numbers, digital currency addresses, websites), `identifier_numbers[]`, `dates_of_birth[]`, `places_of_birth[]`, `nationalities[]`, `citizenships[]`, `federal_register_notice`, `start_date`, `end_date`, `standard_order`, `license_requirement`, `license_policy`, `vessel` (for a vessel), `source_list_url` and `source_information_url` (the agency's pages for the list).
Empty fields are `null`. Each list fills its own subset: the Commerce and State lists carry no party type, and dates, license terms and Federal Register notices come mostly from them.
The `id` of an entry on a Treasury list is the list and OFAC's entity number
(`sdn-36`), the same number the [OFAC sanctions](/guides/united-states/ofac)
endpoints use. On a Commerce or State list it is the list and the entry's own
code, which changes when the agency amends the entry: search by name again
rather than storing it for long.
An id no list carries returns `found: false` with HTTP 200, not an error.
That is also the answer for a party that has been delisted.
Schemas, all response fields, and an interactive playground.