Search Parameters for Consolidated Screening List Sources


Search Parameters for Consolidated Screening List Sources

keyword

Searches for a match within the namealt_namesremarks, and title fields from all lists.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?q={term}

sources

Searches only the lists specified by the Source Abbreviation.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?sources={csl_type}

For each list, the Source Abbreviations are as follows:

Department of Commerce – Bureau of Industry and Security (BIS)

Denied Persons List = DPL
Entity List = EL
Military End User = MEU
Unverified List = UVL

Department of State – Bureau of International Security and Non-Proliferation
Nonproliferation Sanctions = ISN

Department of State – Directorate of Defense Trade Controls
ITAR Debarred = DTC

Department of Treasury - Office of Foreign Assets Control
Correspondent Account or Payable-Through Account Sanctions (CAPTA) = CAP
Foreign Sanctions Evaders = FSE
Palestinian Legislative Council List = PLC
Sectoral Sanctions Identifications List = SSI
Specially Designated Nationals = SDN

countries

Searches only entities whose country, nationalities, or citizenships fields match the country code based on ISO alpha-2 country codes. The country fields are found in the addresses and ids arrays. This method allows you to search for multiple countries (plural) separated by commas but will only return one country (singular) per entity.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?countries={country code}

address

Searches against fields in the addresses array.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?address={query}

name

Searches against the name and alt_names fields.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?name={query}

fuzzy_name

Fuzzy name matching enables users to query a name and get usable results without knowing the exact spelling of an entry. It works by expanding queries to include results that are fuzzily similar to the given term, where similarity is defined by distance - the number of changes required to get from one term to another.

The following example contains terms with a distance of 1. Valid transformation types are given in parenthesis.

star => stir  (substitution)
star => stars (insertion)
star => tar   (deletion)
star => tsar  (transposition)

This notion of distance between strings is defined formally as Damerau–Levenshtein distance

We allow for fuzzy matching up to a distance of 2. For example, a search for Smith, will return matches on the following variants of the name (among others).

query termdistance
Smith0
Smyth1
Smithy1
Smythe2
Stitch2
...

Fuzzy matching can be particularly helpful with names that are commonly transliterated into English in various ways.

Results from a fuzzy name search include a score. The higher the score, the more closely the query term matches an entry in the consolidated screening list.

Note: The fuzzy_name parameter only works in tandem with name. Set fuzzy_name=true to utilize fuzzy name matching when searching against the name and alt_names fields. The default setting for fuzzy_name is false, which means the endpoint will only return exact matches.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?name={query}&fuzzy_name=true

Also, special characters such as hashtags (#) and ampersands (&) contained in a need to be URL encoded; e.g., AT&T should be encoded as at%26t.

Fuzzy search filters out the following common words: co, company, corp, corporation, inc, incorporated, limited, ltd, mrs, ms, mr, organization, sa, sas, llc, university, and univ.  For example, 'Water Corporation' returns the same results as 'Water' because 'Corporation' is one of the common words.

type

Searches based on the type of the entry (e.g, Individual, Entity, Vessel).

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?type={entry type}

start_date

Returns entries based on their start date. Dates are filtered by comparing them against an inclusive range, which must be entered with the following format: YYYY-mm-dd TO YYYY-mm-dd. Searching on a single date can be done by entering the same value for the start and end of the range.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?&start_date={YYYY-mm-dd TO YYYY-mm-dd}

end_date

Returns entries based on their end date. Dates are filtered by comparing them against an inclusive range, which must be entered with the following format: YYYY-mm-dd TO YYYY-mm-dd. Searching on a single date can be done by entering the same value for the start and end of the range.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?end_date={YYYY-mm-dd TO YYYY-mm-dd}

issue_date

Returns entries based on the issue dates of the ids array. Dates are filtered by comparing them against an inclusive range, which must be entered with the following format: YYYY-mm-dd TO YYYY-mm-dd. Searching on a single date can be done by entering the same value for the start and end of the range.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?issue_date={YYYY-mm-dd TO YYYY-mm-dd}

expiration_date

Returns entries based on the expiration dates of the ids array. Dates are filtered by comparing them against an inclusive range, which must be entered with the following format: YYYY-mm-dd TO YYYY-mm-dd. Searching on a single date can be done by entering the same value for the start and end of the range.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?expiration_date={YYYY-mm-dd TO YYYY-mm-dd}

sort

Returns entries sorted by the provided field name. The possible fields to sort by are namestart_dateissue_dateend_date, and expiration_date.

Enter the field name followed by a colon, then the desired order asc (ascending) or desc (descending). For example, start_date:desc sorts results from most recent start date to earliest. Entries that do not contain the entered field or contain a null or empty value will be returned after the sorted results.

Note: By default, searches that do not contain a full-text search (qnameaddress) will return results by name:asc even if no sort parameter is entered.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?sort={fieldname:order}

size + offset

The size parameter allows you to configure the number of results to be returned up to a maximum of 100. The offset parameter defines the offset from the first result you want to fetch. Unless specified the API returns 10 results at a time.

https://api.trade.gov/gateway/v1/consolidated_screening_list/search?size={1 to 100}&offset={1 to n}

Note: When using multiple parameters, the result set will contain the intersection of the matches determined by the parameter values.

Metadata

Last Updated and Last Imported

Recency information about each source queried is given in sources_used in the following fields:

FieldDescription
sourceThe name of the list and the issuing agency.
source_last_updatedThe most recent date and time the list changed.
last_importedThe most recent date and time the list was imported.

The source_last_updated field reflects the most recent date and time we noticed that the issuing agency had updated their list. We check for updates and import lists hourly.

Search Performed At

The search_performed_at field displays the date and time of the current search in UTC.

The Screening Lists, Their Sources, and Specific Fields

Each list returns a unique set of fields. Where appropriate, the Consolidated Screening List normalizes the field names, such as addressesstart_date, and federal_register_notice.

Department of Commerce – Bureau of Industry and Security (BIS)

Denied Persons List (DPL)

Individuals and entities that have been denied export privileges. Any dealings with a party on this list that would violate the terms of its denial order are prohibited.

FieldDescription
addressesArray of entity’s complete addresses.
     addressStreet address for addresses entry.
     cityCity for addresses entry.
     stateState for addresses entry.
     postal_codePostal code for addresses entry.
     countryCountry for addresses entry.
end_dateThe date on which the entity's inclusion on the list will be lifted, waived, or will have expired.
federal_register_noticeThe official source of information about the parties on this list.
nameEntity's name.
remarksAdditional remarks or notes regarding the company, entity, or person on the list.
sourceDenied Persons List (DPL) - Bureau of Industry and Security.
source_information_urlInformation from the Source agency about the list.
source_list_urlLocation of the original list.
standard_orderWhether or not (Y/N) the standard order applies to the Denied Party as defined by the Bureau of Industry and Security (BIS).
start_dateThe effective date for the entity to be included on the list as defined by the Federal Register Notice.

Entity List (EL)

Parties whose presence in a transaction can trigger a license requirement supplemental to those elsewhere in the Export Administration Regulations (EAR). The list specifies the license requirements and policy that apply to each listed party.

FieldDescription
addressesArray of entity’s complete addresses.
     addressStreet address for addresses entry.
     cityCity for addresses entry.
     stateState for addresses entry.
     postal_codePostal code for addresses entry.
     countryCountry for addresses entry.
alt_namesAlias names used by the entity.
federal_register_noticeThe official source of information about the parties on this list.
license_policyThe policy set forth in the Export Administration Regulations regarding denial.
license_requirementThe license requirement as determined by the Export Administration Regulations.
nameEntity's name.
titleEntity's title.
sourceEntity List (EL) - Bureau of Industry and Security.
source_information_urlInformation from the Source agency about the list.
source_list_urlLocation of the original list.
standard_orderWhether or not (Y/N) the standard order applies to the Denied Party as defined by the Bureau of Industry and Security (BIS).
start_dateThe effective date of the entity on the list as defined by the Federal Register Notice.

Military End User (MEU)

Parties whose presence in a transaction as a party to the transaction triggers a license requirement for any item subject to the EAR listed in supplement no. 2 to part 744. No license exceptions are available for exports, reexports or transfers (in-country) to listed entities on the MEU List for items specified in supplement no. 2 to part 744, except license exceptions for items authorized under the provisions of License Exception GOV set forth in § 740.11(b)(2)(i) and (ii) of the EAR. The license application procedure and license review policy for entities specified in supplement no. 2 to part 744 is specified in § 744.21(d) and (e). 

FieldDescription
addressesArray of entity’s complete addresses.
     addressStreet address for addresses entry.
     cityCity for addresses entry.
     stateState for addresses entry.
     postal_codePostal code for addresses entry.
     countryCountry for addresses entry.
alt_namesAlias names used by the entity.
federal_register_noticeThe official source of information about the parties on this list.
license_policyThe policy set forth in the Export Administration Regulations regarding denial.
license_requirementThe license requirement as determined by the Export Administration Regulations.
nameEntity's name.
titleEntity's title.
sourceMilitary End User (MEU) - Bureau of Industry and Security.
source_information_urlInformation from the Source agency about the list.
source_list_urlLocation of the original list.
standard_orderWhether or not (Y/N) the standard order applies to the Denied Party as defined by the Bureau of Industry and Security (BIS).
start_dateThe effective date of the entity on the list as defined by the Federal Register Notice.

Unverified List (UVL)

End-users who BIS has been unable to verify in prior transactions. The presence of a party on this list in a transaction is a “Red Flag” that should be resolved before proceeding with the transaction.

FieldDescription
addressesArray of entity’s complete addresses.
     addressStreet address for addresses entry.
     cityCity for addresses entry.
     stateState for addresses entry.
     postal_codePostal code for addresses entry.
     countryCountry for addresses entry.
alt_namesAlias names used by the entity.
nameEntity's name.
sourceUnverified List (UVL) - Bureau of Industry and Security.
source_information_urlInformation from the Source agency about the list.
source_list_urlLocation of the original list.

Department of State – Bureau of International Security and Non-Proliferation

Nonproliferation Sanctions (ISN)

Parties that have been sanctioned under various statutes. The linked webpage is updated as appropriate, but the Federal Register is the only official and complete listing of nonproliferation sanctions determinations.

FieldDescription
addressesArray of entity’s complete addresses.
     addressStreet address for addresses entry.
     cityCity for addresses entry.
     stateState for addresses entry.
     postal_codePostal code for addresses entry.
     countryCountry for addresses entry.
federal_register_noticeThe official source of information about the parties on this list.
nameEntity's name.
programsAgency programs related to the entity on the list.
remarksAdditional remarks or notes regarding the company, entity or person on the list.
sourceNonproliferation Sanctions (ISN) - State Department.
source_information_urlInformation from the Source agency about the list.
source_list_urlLocation of the original list.
start_dateThe effective date of the entity on the list as defined by the Federal Register Notice.

Department of State – Directorate of Defense Trade Controls

ITAR Debarred List (DTC)

Entities and individuals prohibited from participating directly or indirectly in the export of defense articles, including technical data and defense services. Pursuant to the Arms Export Control Act (AECA) and the International Traffic in Arms Regulations (ITAR), the AECA Debarred List includes persons convicted in court of violating or conspiring to violate the AECA and subject to “statutory debarment” or persons established to have violated the AECA in an administrative proceeding and subject to “administrative debarment.”

This list does not have a country field. As such, any query where country is specified will not search this list.

FieldDescription
alt_namesAlias names used by the entity.
federal_register_noticeThe official source of information about the parties on this list.
nameEntity's name.
sourceITAR Debarred (DTC) - State Department.
source_information_urlInformation from the Source agency about the list.
source_list_urlLocation of the original list.
start_dateThe effective date of the entity on the list as defined by the Federal Register Notice.

Department of the Treasury – Office of Foreign Assets Control (OFAC)

Correspondent Account or Payable-Through Account Sanctions (CAPTA)

The List of Foreign Financial Institutions Subject to Correspondent Account or Payable-Through Account Sanctions (the “CAPTA List”) is intended to include foreign financial institutions subject to correspondent or payable-through account sanctions pursuant to specific sanctions.

Foreign Sanctions Evaders List (FSE)

Foreign individuals and entities determined to have violated, attempted to violate, conspired to violate, or caused a violation of U.S. sanctions on Syria or Iran, as well as foreign persons who have facilitated deceptive transactions for or on behalf of persons subject to U.S. Sanctions. Transactions by U.S. persons or within the United States involving Foreign Sanctions Evaders (FSEs) are prohibited.

Palestinian Legislative Council List (PLC)

The individuals in this list are Palestinian Legislative Council members who were elected on the party slate of a Foreign Terrorist Organization, Specially Designated Terrorist, or Specially Designated Global Terrorist. They do not, however, appear on the SDN List. Transactions involving these individuals must be rejected.

Sectoral Sanctions Identifications List (SSI)

This Sectoral Sanctions Identifications List includes persons determined by OFAC to be operating in sectors of the Russian economy identified by the Secretary of the Treasury pursuant to Executive Order 13662. The prohibitions on dealings related to the persons identified on this list are described in the Sectoral Sanctions Identifications List circular.

Specially Designated Nationals List (SDN)

Parties who may be prohibited from export transactions based on OFAC’s regulations. The Export Administration Regulations (EAR) require a license for exports or re-exports to any party in any entry on this list that contains any of the suffixes "SDGT", "SDT", "FTO", "IRAQ2" or "NPWMD".”

Fields for all Treasury Lists:

FieldDescription
addressesArray of entity’s complete addresses.
     addressStreet address for addresses entry.
     cityCity for addresses entry.
     stateState for addresses entry.
     postal_codePostal code for addresses entry.
     countryCountry for addresses entry.
alt_namesAlias names used by the entity.
citizenshipsEntity's citizenships.
dates_of_birthEntity's dates of birth.
entity_numberUnique id assigned by the originating list.
idsAn array showing specific identification information of the entity. Array fields in italics.
     countryEntity's country .
     expiration_dateThe date on which the identification will expire.
     issue_dateThe effective date of the identification.
     numberUnique number assigned to the identification.
     typeDescribes the type of identification (i.e. passport, license, etc.).
nameEntity's name.
nationalitiesEntity's nationalities.
places_of_birthEntity's places of birth.
programsAgency programs related to the entity on the list.
remarksAdditional remarks or notes regarding the company, entity or person on the list.
sourceSpecially Designated Nationals (SDN) - Treasury Department.
source_information_urlInformation from the Source agency about the list.
source_list_urlLocation of the original list.
titleEntity's title.
typeClassification of the entity.

If the entity is a vessel, it will have the following additional fields:

FieldDescription
call_signCall sign of the vessel.
gross_registered_tonnageThe gross weight in tons registered for the vessel.
gross_tonnageThe gross weight in tons not-registered for the vessel.
vessel_flagCountry flag of the vessel.
vessel_ownerOwner/Operator of the vessel.
vessel_typeDescribes the type of vessel (ferry, bulk cargo, tug).

OFAC provides further documentation for the programs field.

ITA’s Process for Consolidating the Screening Lists

ITA’s data services platform imports each of the screening lists once every hour. It then consolidates the lists based on common field types such as name, federal_register_notice, and start_date. Not all lists contain the same fields so some search results may include more detail than others depending upon the Source agency. Once the data services platform consolidates the lists, it publishes the CSL API endpoint.

There can be a time lag of up to one hour between the time a Source has updated a screening list and when that update appears in the Consolidated Screening List API. Furthermore, the Consolidated Screening List API is not the system of record for these screening lists. Developers should strongly encourage users to refer to the website of the source agency for further instructions when finding a potential match. Links to these websites are found above as well as in the “Source List URL” and “Source Information URL” fields that accompany each party returned in the API.