Exclusions Data Dictionary¶
This document describes the fields available on the Exclusions API endpoint (/api/exclusions/). For filtering, ordering, and pagination, see the Exclusions API Reference.
Overview¶
Exclusions are SAM.gov exclusion records — debarments, suspensions, and other exclusions from federal awards. Data is sourced from SAM.gov and normalized in Tango. Whether a record is in force is derived at query time from its dates rather than stored: see is_currently_excluded below and the currency rules in the API reference.
Note: Exclusions are a flat resource with no expandable relations. The full field set is available via the shape query parameter. See Response Shaping for details.
Identity¶
The primary key and detail-lookup value is exclusion_key — a 64-character SHA-256 hex digest computed from the record's normalized identity. It is stable across refreshes for the same underlying exclusion.
Fields¶
| Field | Type | Description | Source |
|---|---|---|---|
exclusion_key | String | Primary key; 64-char SHA-256 hex digest over the record's identity. | Tango |
classification_type | String | Classification (e.g. Firm, Individual, Special Entity Designation). | SAM.gov |
exclusion_type | String | Type of exclusion (e.g. Ineligible (Proceedings Pending), Prohibition/Restriction). | SAM.gov |
exclusion_program | String | Exclusion program (e.g. Reciprocal, Procurement, Non-Procurement). | SAM.gov |
excluding_agency_code | String | Code of the agency that created the exclusion. | SAM.gov |
excluding_agency_name | String | Name of the excluding agency. | SAM.gov |
uei | String | SAM.gov Unique Entity Identifier on the exclusion record. | SAM.gov |
cage_code | String | CAGE code on the exclusion record. | SAM.gov |
npi | String | National Provider Identifier. | SAM.gov |
dnb_open_data | String | Dun & Bradstreet open-data indicator. | SAM.gov |
prefix | String | Name prefix (individuals). | SAM.gov |
first_name | String | First name (individuals). | SAM.gov |
middle_name | String | Middle name (individuals). | SAM.gov |
last_name | String | Last name (individuals). | SAM.gov |
suffix | String | Name suffix (individuals). | SAM.gov |
entity_name | String | Legal business name (firms). | SAM.gov |
display_name | String | Computed display name — entity_name for firms, assembled name parts for individuals. | Tango |
is_currently_excluded | Boolean | Computed: whether the exclusion is in force today (from delisted_at, activate_date, termination_date). | Tango |
create_date | Date | SAM.gov record creation date. | SAM.gov |
update_date | Date | SAM.gov last-update date. | SAM.gov |
activate_date | Date | Date the exclusion took effect. | SAM.gov |
termination_date | Date | Date the exclusion ends; year 2227 is SAM's INDEFINITE sentinel. | SAM.gov |
termination_type | String | How the exclusion terminates. | SAM.gov |
delisted_at | Date | Date Tango observed the record drop out of the SAM catalog (exclusion lifted); null while still listed. | Tango |
primary_address | Object | Primary address (flattened JSON). | SAM.gov |
secondary_address | Object | Secondary address (flattened JSON). | SAM.gov |
more_locations | Object | Additional locations (JSON). | SAM.gov |
additional_comments | String | Free-text comments. | SAM.gov |
ct_code | String | Cross-reference / control code. | SAM.gov |
evs_investigation_status | String | EVS investigation status. | SAM.gov |
is_fascsa_order | Boolean | Whether the record is a FASCSA order. | SAM.gov |
references | Object | Related exclusion references (JSON). Maps to the underlying exclusion_references payload. | SAM.gov |
entity_uei | String | UEI of the resolved Tango entity, when the exclusion links to a registered entity (soft link, not an FK). | Tango |
vessel_call_sign | String | Vessel call sign (maritime exclusions). | SAM.gov |
vessel_type | String | Vessel type. | SAM.gov |
vessel_tonnage | String | Vessel tonnage. | SAM.gov |
vessel_grt | String | Vessel gross registered tonnage. | SAM.gov |
vessel_flag | String | Vessel flag. | SAM.gov |
vessel_owner | String | Vessel owner. | SAM.gov |
Default shapes¶
- List returns:
exclusion_key,classification_type,exclusion_type,excluding_agency_name,entity_name,display_name,activate_date,termination_date,termination_type,is_currently_excluded. - Detail returns every field above, including the sparse vessel block, addresses, and free text.
Not exposed¶
Provenance and index-only columns are not part of the API: record_status, row_hash, search_vector. Address state / country live inside the primary_address JSON and are not separately filterable.
Usage Notes¶
- Currency is derived — filter with
?active=truefor records in force today; every result also carriesis_currently_excluded. A record simply reaching itstermination_datedoes not change the stored row (and does not fire a webhook alert). - Lifted exclusions — filter with
?delisted=true;delisted_atcarries the date Tango observed the removal. - Linking to entities —
entity_ueiis a soft scalar link to the entities dataset, set when the exclusion's CAGE/UEI matches a registered entity. There is noentity(*)expansion.