diff --git a/_apidocs/exclusions-api.md b/_apidocs/exclusions-api.md index 36cd57733..994d989c2 100644 --- a/_apidocs/exclusions-api.md +++ b/_apidocs/exclusions-api.md @@ -4,7 +4,7 @@ banner-heading: SAM.gov Exclusions API --- ## Overview -The Exclusions API will allow users to request Public Exclusion Information based on various optional request parameters. +The Exclusions API will allow users to request Public Exclusion Information based on various optional request parameters. The response will be provided in the JSON format in a paginated manner. **Key Features of the Exclusion API:** @@ -30,15 +30,16 @@ Exclusions API can be accessed from Production or Alpha via the following versio * Production Version 1: https://api.sam.gov/entity-information/v1/exclusions?api_key=< value > * Production Version 2: https://api.sam.gov/entity-information/v2/exclusions?api_key=< value > * Production Version 3: https://api.sam.gov/entity-information/v3/exclusions?api_key=< value > +* Production Version 4: https://api.sam.gov/entity-information/v4/exclusions?api_key=< value > * Alpha Version 1: https://api-alpha.sam.gov/entity-information/v1/exclusions?api_key=< value > * Alpha Version 2: https://api-alpha.sam.gov/entity-information/v2/exclusions?api_key=< value > -* Alpha Version 3: https://api-alpha.sam.gov/entity-information/v3/exclusions?api_key=< value >

- +* Alpha Version 3: https://api-alpha.sam.gov/entity-information/v3/exclusions?api_key=< value > +* Alpha Version 4: https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=< value >

Generating a personal API Key: * Registered users can request for a public API on 'Account Details' page. This page can be accessed here: Account Details page on sam.gov -* Users must enter their password on ‘Account Details’ page to view the API Key information. If an incorrect password is entered, an error will be returned. -* After the API Key is generated on ‘Account Details’ page, the API Key can be viewed on the Account Details page immediately. The API Key is visible until users navigate to a different page. +* Users must enter their password on ‘Account Details’ page to view the API Key information. If an incorrect password is entered, an error will be returned. +* After the API Key is generated on ‘Account Details’ page, the API Key can be viewed on the Account Details page immediately. The API Key is visible until users navigate to a different page. * If an error is encountered during the API Key generation/retrieval, then users will receive an error message and they can try again. Generating a System Account API Key: @@ -99,129 +100,131 @@ Utilizing the Exclusion API as an extract: **Query String Parameters** -| Parameter Name | Description | Applicable Versions | -| ---- | ----------- | ----------- | -| classification | Allows a partial text or a complete text (Individual, Firm, Vessel, Special Entity Designation).

This parameter can be used inside the 'q' parameter.

Example: 'classification=Firm', 'classification=!INDIVIDUAL', 'classification=[Vessel~Special]', 'q=((classification:Vessel) OR (classification:Special))' | v1
v2
v3 | -| exclusionName | Allows a partial text or a complete text.

This parameter must not be used inside the 'q' parameter.

This parameter accepts multi-text values in any order and in any case, and will apply the AND operator between the texts.

Examples: 'exclusionName=J Roy', 'exclusionName=ROY j' | v1
v2
v3 | -| exclusionType | Allows a partial text or a complete text (a string).

Allowable values are: Ineligible (Proceedings Pending), Ineligible (Proceedings Completed), Prohibition/Restriction and Voluntary Exclusion.

This parameter can be used inside the 'q' parameter. When not used inside the 'q' parameter, this parameter will apply the AND operator if a multi-text value is provided in any order and in any case.

Examples: 'q=exclusionType:Ineligible (Proceedings Pending)', 'exclusionType=Ineligible PENDING', 'exclusionType=[Pending~Voluntary]' | v1
v2
v3 | -| exclusionProgram | Allows a complete text (a string).

Allowable values are: Reciprocal, NonProcurement and Procurement.

This parameter can be used inside the 'q' parameter.

Examples: 'q=((exclusionProgram:Reciprocal) OR (exclusionProgram:Procurement))', 'exclusionProgram=[NonProcurement~RECIPROCAL]', 'exclusionProgram=!NonProcurement'| v1
v2
v3 | -| addressLine1 | Mainly used to search Individuals with their address. Allows a partial text, a complete text and null.

This parameter must not be used inside the 'q' parameter.

Examples: 'addressLine1=""', 'addressLine1="7th Floor, Buraengdang Building 530-14"'

NOTE: If addressLine1 is used in a request with exclusionName, it must match 85% of an Individual's address in order for the address information to be returned in the response (not case sensitive). | v1
v2
v3 | -| addressLine2 | Mainly used to search Individuals with their address. Allows a partial text, a complete text and null.

This parameter must not be used inside the 'q' parameter.

Examples: 'addressLine2=""', 'addressLine2="Dapsipri, 5 Dong, Dongdaemun-K"'

NOTE: If addressLine2 is used in a request with exclusionName, it must match 85% of an Individual's address in order for the address information to be returned in the response (not case sensitive). | v1
v2
v3 | -| stateProvince | Allows 2-character codes for the USA, names for foreign countries and null (a string).

Examples: 'stateProvince=AR', 'stateProvince=[VA~MICHOACÁN]', 'stateProvince=""' | v1
v2
v3 | -| country | Allows 3-character codes, numerical values and null (a string).

Examples: 'country=USA' 'country=[RUS~292~mex]', 'country=!""', 'q=((country:RUS) OR (country:292) OR (country:mex))' | v1
v2
v3 | -| zipCode | Allows 5-digit values for the USA, any value as it was provided for foreign countries and null (a string).

Example: 'zipCode=20171', 'zipCode=[901-2132~V3M 5P8~C.P. 44890]', 'zipCode=""', 'q=((zipCode:901-2132) OR (zipCode:20147))' | v1
v2
v3 | -| ueiSAM | Denotes Unique Entity Identifier SAM.

Allows 12-character values, null and also wildcard searches.

Examples: 'ueiSAM=""', 'ueiSAM=!""', 'ueiSAM=P*X*1', 'q=((ueiSAM:PMC9YQMXJZU1) OR (ueiSAM:PG4XZ77WRC21))' | v1
v2
v3 | -| excludingAgencyCode | Allows a partial text, a complete text and null (a string).

Examples: 'excludingAgencyCode=ICE', 'excludingAgencyCode=DHS-ICE', 'excludingAgencyCode=[AF~HUD~""]', 'q=((excludingAgencyCode:AF) OR (excludingAgencyCode:HUD))' | v1
v2
v3 | -| excludingAgencyName | Allows a partial text, a complete text and null (a string).

This parameter can be used inside the 'q' parameter. When not used inside the 'q' parameter, this parameter will apply the AND operator if a multi-text value is provided in any order and in any case

Examples: 'excludingAgencyName=Of URBAN housing', 'excludingAgencyName=[Geological~Navy]', q=((excludingAgencyName:Geological) OR (excludingAgencyName:Navy)) | v1
v2
v3 | -| ctCode | Allows a complete text, null and also wild card searches (a string).

Examples: 'ctCode=*SDN*', 'ctCode=[AA~""], 'q=((ctCode:AA) OR (ctCode:03-SDN-01))' | v1
v2
v3 | -| activationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'activationDate=01/01/2019', 'activationDate=[01/01/2019,05/29/2019]' | v1
v2
v3 | -| creationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'creationDate=01/01/2019', 'creationDate=[01/01/2019,05/29/2019]' | v1
v2
v3 | -| updateDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'updateDate=01/01/2019', 'updateDate=[01/01/2019,05/29/2019]'' | v1
v2
v3 | -| terminationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'terminationDate=01/01/2019', 'terminationDate=[01/01/2019,05/29/2019]' | v1
v2
v3 | -| cageCode | Allows a complete value, null and also wild card searches (a string).

Examples: 'cageCode=0*0', 'cageCode=[0XLE0~1CM51~""]', 'q=((cageCode:0XLE0) OR (cageCode:1CM51))' | v1
v2
v3 | -| npi | Allows 1234567890 (this is masked data) and null (a string).

Examples: 'npi=1234567890', 'npi=""', 'npi=!""' | v1
v2
v3 | -| recordStatus | The API returns only Active records.

Allows a complete text (a string).

Allowable value is: Active, active

Example: 'recordStatus=active' | v1
v2
v3 | -| page | Denotes a page number.

Allowable values are 0 to 999.

Example: 'page=0' | v1
v2
v3 | -| size | Denotes the number of records returned per page.

Allowable values are 1 to 10.

Example: 'size=1' | v1
v2
v3 | -| includeSections | Allows to filter data by sections, exclusionDetails, exclusionIdentification, exclusionActions, exclusionAddress, exclusionOtherInformation and vesselDetails.

Example: 'includeSections=exclusionOtherInformation,exclusionDetails' | v1
v2
v3 | -| format | Allows user to download different file formats(csv and json are allowable values) .

Example: 'format=csv' | v1
v2
v3 | -| emailId | Allows user to get file download links sent to the email address associated to the API key used in the request. Email ID must be provided in conjunction with the format parameter.
Example: emailId= Yes
Applicable to non-SAM registrants. | v1
v2
v3 | -| ssnOrTinOrEin | Allows a 9-digit value or null.

This parameter must not be used inside the 'q' parameter.

This parameter must be used in conjunction with the exclusionName parameter.

Example: 'ssnOrTinOrEin=123456789' | v1
v2
v3 | +| Parameter Name | Description | Applicable Versions | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| classification | Allows a partial text or a complete text (Individual, Firm, Vessel, Special Entity Designation).

This parameter can be used inside the 'q' parameter.

Example: 'classification=Firm', 'classification=!INDIVIDUAL', 'classification=[Vessel~Special]', 'q=((classification:Vessel) OR (classification:Special))' | v1
v2
v3
v4 | +| exclusionName | Allows a partial text or a complete text.

This parameter must not be used inside the 'q' parameter.

This parameter accepts multi-text values in any order and in any case, and will apply the AND operator between the texts.

Examples: 'exclusionName=J Roy', 'exclusionName=ROY j' | v1
v2
v3
v4 | +| exclusionType | Allows a partial text or a complete text (a string).

Allowable values are: Ineligible (Proceedings Pending), Ineligible (Proceedings Completed), Prohibition/Restriction and Voluntary Exclusion.

This parameter can be used inside the 'q' parameter. When not used inside the 'q' parameter, this parameter will apply the AND operator if a multi-text value is provided in any order and in any case.

Examples: 'q=exclusionType:Ineligible (Proceedings Pending)', 'exclusionType=Ineligible PENDING', 'exclusionType=[Pending~Voluntary]' | v1
v2
v3
v4 | +| exclusionProgram | Allows a complete text (a string).

Allowable values are: Reciprocal, NonProcurement and Procurement.

This parameter can be used inside the 'q' parameter.

Examples: 'q=((exclusionProgram:Reciprocal) OR (exclusionProgram:Procurement))', 'exclusionProgram=[NonProcurement~RECIPROCAL]', 'exclusionProgram=!NonProcurement' | v1
v2
v3
v4 | +| addressLine1 | Mainly used to search Individuals with their address. Allows a partial text, a complete text and null.

This parameter must not be used inside the 'q' parameter.

Examples: 'addressLine1=""', 'addressLine1="7th Floor, Buraengdang Building 530-14"'

NOTE: If addressLine1 is used in a request with exclusionName, it must match 85% of an Individual's address in order for the address information to be returned in the response (not case sensitive). | v1
v2
v3
v4 | +| addressLine2 | Mainly used to search Individuals with their address. Allows a partial text, a complete text and null.

This parameter must not be used inside the 'q' parameter.

Examples: 'addressLine2=""', 'addressLine2="Dapsipri, 5 Dong, Dongdaemun-K"'

NOTE: If addressLine2 is used in a request with exclusionName, it must match 85% of an Individual's address in order for the address information to be returned in the response (not case sensitive). | v1
v2
v3
v4 | +| stateProvince | Allows 2-character codes for the USA, names for foreign countries and null (a string).

Examples: 'stateProvince=AR', 'stateProvince=[VA~MICHOACÁN]', 'stateProvince=""' | v1
v2
v3
v4 | +| country | Allows 3-character codes, numerical values and null (a string).

Examples: 'country=USA' 'country=[RUS~292~mex]', 'country=!""', 'q=((country:RUS) OR (country:292) OR (country:mex))' | v1
v2
v3
v4 | +| zipCode | Allows 5-digit values for the USA, any value as it was provided for foreign countries and null (a string).

Example: 'zipCode=20171', 'zipCode=[901-2132~V3M 5P8~C.P. 44890]', 'zipCode=""', 'q=((zipCode:901-2132) OR (zipCode:20147))' | v1
v2
v3
v4 | +| ueiSAM | Denotes Unique Entity Identifier SAM.

Allows 12-character values, null and also wildcard searches.

Examples: 'ueiSAM=""', 'ueiSAM=!""', 'ueiSAM=P*X*1', 'q=((ueiSAM:PMC9YQMXJZU1) OR (ueiSAM:PG4XZ77WRC21))' | v1
v2
v3
v4 | +| excludingAgencyCode | Allows a partial text, a complete text and null (a string).

Examples: 'excludingAgencyCode=ICE', 'excludingAgencyCode=DHS-ICE', 'excludingAgencyCode=[AF~HUD~""]', 'q=((excludingAgencyCode:AF) OR (excludingAgencyCode:HUD))' | v1
v2
v3
v4 | +| excludingAgencyName | Allows a partial text, a complete text and null (a string).

This parameter can be used inside the 'q' parameter. When not used inside the 'q' parameter, this parameter will apply the AND operator if a multi-text value is provided in any order and in any case

Examples: 'excludingAgencyName=Of URBAN housing', 'excludingAgencyName=[Geological~Navy]', q=((excludingAgencyName:Geological) OR (excludingAgencyName:Navy)) | v1
v2
v3
v4 | +| ctCode | Allows a complete text, null and also wild card searches (a string).

Examples: 'ctCode=*SDN*', 'ctCode=[AA~""], 'q=((ctCode:AA) OR (ctCode:03-SDN-01))' | v1
v2
v3
v4 | +| activationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'activationDate=01/01/2019', 'activationDate=[01/01/2019,05/29/2019]' | v1
v2
v3
v4 | +| creationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'creationDate=01/01/2019', 'creationDate=[01/01/2019,05/29/2019]' | v1
v2
v3
v4 | +| updateDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'updateDate=01/01/2019', 'updateDate=[01/01/2019,05/29/2019]'' | v1
v2
v3
v4 | +| terminationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'terminationDate=01/01/2019', 'terminationDate=[01/01/2019,05/29/2019]' | v1
v2
v3
v4 | +| cageCode | Allows a complete value, null and also wild card searches (a string).

Examples: 'cageCode=0*0', 'cageCode=[0XLE0~1CM51~""]', 'q=((cageCode:0XLE0) OR (cageCode:1CM51))' | v1
v2
v3
v4 | +| npi | Allows 1234567890 (this is masked data) and null (a string).

Examples: 'npi=1234567890', 'npi=""', 'npi=!""' | v1
v2
v3
v4 | +| recordStatus | The API returns only Active records.

Allows a complete text (a string).

Allowable value is: Active, active

Example: 'recordStatus=active' | v1
v2
v3
v4 | +| page | Denotes a page number.

Allowable values are 0 to 999.

Example: 'page=0' | v1
v2
v3
v4 | +| size | Denotes the number of records returned per page.

Allowable values are 1 to 10.

Example: 'size=1' | v1
v2
v3
v4 | +| includeSections | Allows to filter data by sections, exclusionDetails, exclusionIdentification, exclusionActions, exclusionAddress, exclusionOtherInformation and vesselDetails.

Example: 'includeSections=exclusionOtherInformation,exclusionDetails' | v1
v2
v3
v4 | +| format | Allows user to download different file formats(csv and json are allowable values) .

Example: 'format=csv' | v1
v2
v3
v4 | +| emailId | Allows user to get file download links sent to the email address associated to the API key used in the request. Email ID must be provided in conjunction with the format parameter.
Example: emailId= Yes
Applicable to non-SAM registrants. | v1
v2
v3
v4 | +| ssnOrTinOrEin | Allows a 9-digit value or null.

This parameter must not be used inside the 'q' parameter.

This parameter must be used in conjunction with the exclusionName parameter.

Example: 'ssnOrTinOrEin=123456789' | v1
v2
v3
v4 | +| fascsaOrder | Allows Yes and No.

This parameter accepts either value, in any case.

Examples: fascsaOrder=Yes, fascsaOrder=yes, fascsaOrder=No, fascsaOrder=no | v4 | **Expected Result** API response consists of Sections, Sub-sections and Tags underneath each of the Sections or Sub-sections. There are a few placeholder elements that return ‘Currently Not Available’ until they are made available in the database. Additionally, -| Section/Sub-section/Tag | Type | Description | Applicable Versions | -|----------------------------------------------------------------------| ---- |---------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Section/Sub-section/Tag | Type | Description | Applicable Versions | +|----------------------------------------------------------------------| ---- |--------------------------------------------------------------------------------------------------------------------------------------------|----------------------| | **exclusionDetails** | -| classificationType | string | Classification Type | v1
v2
v3 | -| exclusionType | string | Exclusion Type | v1
v2
v3 | -| exclusionProgram | string | Exclusion Program | v1
v2
v3 | -| excludingAgencyCode | string | Excluding Agency Code | v1
v2
v3 | -| excludingAgencyName | string | Excluding Agency Name | v1
v2
v3 | +| classificationType | string | Classification Type | v1
v2
v3
v4 | +| exclusionType | string | Exclusion Type | v1
v2
v3
v4 | +| exclusionProgram | string | Exclusion Program | v1
v2
v3
v4 | +| excludingAgencyCode | string | Excluding Agency Code | v1
v2
v3
v4 | +| excludingAgencyName | string | Excluding Agency Name | v1
v2
v3
v4 | | **exclusionIdentification** | -| ueiSAM | string | Unique Entity Identifier SAM | v1
v2
v3 | -| cageCode | string | CAGE Code | v1
v2
v3 | -| npi | string| NPI | v1
v2
v3 | -| prefix | string | Prefix | v1
v2
v3 | -| firstName | string | First Name | v1
v2
v3 | -| middleName | string | Middle Name | v1
v2
v3 | -| lastName | string | Last Name | v1
v2
v3 | -| suffix | string | Suffix | v1
v2
v3 | -| name/entityName | string | Firm Name

NOTE: This parameter is being renamed. name is in V1 and entityName will be V2. | v1
v2
v3 | -| dnbOpenData | string | DNB Open Data | v2
v3 | +| ueiSAM | string | Unique Entity Identifier SAM | v1
v2
v3
v4 | +| cageCode | string | CAGE Code | v1
v2
v3
v4 | +| npi | string| NPI | v1
v2
v3
v4 | +| prefix | string | Prefix | v1
v2
v3
v4 | +| firstName | string | First Name | v1
v2
v3
v4 | +| middleName | string | Middle Name | v1
v2
v3
v4 | +| lastName | string | Last Name | v1
v2
v3
v4 | +| suffix | string | Suffix | v1
v2
v3
v4 | +| name/entityName | string | Firm Name

NOTE: This parameter is being renamed. name is in V1 and entityName will be V2. | v1
v2
v3
v4 | +| dnbOpenData | string | DNB Open Data | v2
v3
v4 | | **exclusionActions --> listOfActions** | -| createDate | string | Create Date | v1
v2
v3 | -| updateDate | string | Update Date | v1
v2
v3 | -| activateDate | string | Activate Date | v1
v2
v3 | -| terminationDate | string | Termination Date | v1
v2
v3 | -| terminationType | string | Termination Type | v1
v2
v3 | -| recordStatus | string | Record Status | v1
v2
v3 | -| **exclusionAddress/exclusionPrimaryAddress** | | NOTE: This section is being renamed. It is exclusionAddress in V1 and will be exclusionPrimaryAddress in V2. | | -| addressLine1 | string | Address Line 1 | v1
v2
v3 | -| addressLine2 | string | Address Line 2 | v1
v2
v3 | -| city | string | Address City | v1
v2
v3 | -| stateOrProvinceCode | string | Address State or Province Code | v1
v2
v3 | -| zipCode | string | Address Zip OR Postal Code | v1
v2
v3 | -| zipCodePlus4 | string | Address Zip Plus 4 | v1
v2
v3 | -| countryCode | string | Country Code | v1
v2
v3 | +| createDate | string | Create Date | v1
v2
v3
v4 | +| updateDate | string | Update Date | v1
v2
v3
v4 | +| activateDate | string | Activate Date | v1
v2
v3
v4 | +| terminationDate | string | Termination Date | v1
v2
v3
v4 | +| terminationType | string | Termination Type | v1
v2
v3
v4 | +| recordStatus | string | Record Status | v1
v2
v3
v4 | +| **exclusionAddress/exclusionPrimaryAddress** | | NOTE: This section is being renamed. It is exclusionAddress in V1 and will be exclusionPrimaryAddress in V2. | | +| addressLine1 | string | Address Line 1 | v1
v2
v3
v4 | +| addressLine2 | string | Address Line 2 | v1
v2
v3
v4 | +| city | string | Address City | v1
v2
v3
v4 | +| stateOrProvinceCode | string | Address State or Province Code | v1
v2
v3
v4 | +| zipCode | string | Address Zip OR Postal Code | v1
v2
v3
v4 | +| zipCodePlus4 | string | Address Zip Plus 4 | v1
v2
v3
v4 | +| countryCode | string | Country Code | v1
v2
v3
v4 | | **exclusionSecondaryAddress** | -| addressLine1 | string | Address Line 1 | v2
v3 | -| addressLine2 | string | Address Line 2 | v2
v3 | -| city | string | Address City | v2
v3 | -| stateOrProvinceCode | string | Address State or Province Code | v2
v3 | -| zipCode | string | Address Zip OR Postal Code | v2
v3 | -| zipCodePlus4 | string | Address Zip Plus 4 | v2
v3 | -| countryCode | string | Country Code | v2
v3 | +| addressLine1 | string | Address Line 1 | v2
v3
v4 | +| addressLine2 | string | Address Line 2 | v2
v3
v4 | +| city | string | Address City | v2
v3
v4 | +| stateOrProvinceCode | string | Address State or Province Code | v2
v3
v4 | +| zipCode | string | Address Zip OR Postal Code | v2
v3
v4 | +| zipCodePlus4 | string | Address Zip Plus 4 | v2
v3
v4 | +| countryCode | string | Country Code | v2
v3
v4 | | **exclusionOtherInformation** | -| additionalComments | string | Additional Comments | v1
v2
v3 | -| ctCode | string | CT Code | v1
v2
v3 | -| dnbInvestigationStatus/evsInvestigationStatus | string | EVS Investigation Status

NOTE: This parameter is being renamed. dnbInvestigationStatus is in V1 and evsInvestigationStatus will be V2. | v1
v2
v3 | +| isFASCSAOrder | string | FASCSA Order Exclusion Indicator | v4 | +| additionalComments | string | Additional Comments | v1
v2
v3
v4 | +| ctCode | string | CT Code | v1
v2
v3
v4 | +| dnbInvestigationStatus/evsInvestigationStatus | string | EVS Investigation Status

NOTE: This parameter is being renamed. dnbInvestigationStatus is in V1 and evsInvestigationStatus will be V2. | v1
v2
v3
v4 | | **exclusionOtherInformation --> references --> referencesList** | -| name/exclusionName | string | Exclusion Name

NOTE: This parameter is being renamed. name is in V1 and exclusionName will be V2. | v1
v2
v3 | -| type | string | Type | v1
v2
v3 | +| name/exclusionName | string | Exclusion Name

NOTE: This parameter is being renamed. name is in V1 and exclusionName will be V2. | v1
v2
v3
v4 | +| type | string | Type | v1
v2
v3
v4 | | **exclusionOtherInformation --> moreLocations** | -| exclusionName | string | Exclusion Name | v2
v3 | -| duns | string | DUNS | v2 | -| ueiSAM | string | ueiSAM | v3 | -| cageCode | string | CAGE Code | v2
v3 | -| npi | string | NPI | v2
v3 | +| exclusionName | string | Exclusion Name | v2
v3
v4 | +| duns | string | DUNS | v2 | +| ueiSAM | string | ueiSAM | v3
v4 | +| cageCode | string | CAGE Code | v2
v3
v4 | +| npi | string | NPI | v2
v3
v4 | | **exclusionOtherInformation --> moreLocations --> primaryAddress** | -| addressLine1 | string | Address Line 1 | v2
v3 | -| addressLine2 | string | Address Line 2 | v2
v3 | -| city | string | City | v2
v3 | -| stateOrProvinceCode | string | State or Province Code | v2
v3 | -| zipCode | string | Zip Code | v2
v3 | -| zipCodePlus4 | string | Zip Code Plus 4 | v2
v3 | -| countryCode | string | Country Code | v2
v3 | +| addressLine1 | string | Address Line 1 | v2
v3
v4 | +| addressLine2 | string | Address Line 2 | v2
v3
v4 | +| city | string | City | v2
v3
v4 | +| stateOrProvinceCode | string | State or Province Code | v2
v3
v4 | +| zipCode | string | Zip Code | v2
v3
v4 | +| zipCodePlus4 | string | Zip Code Plus 4 | v2
v3
v4 | +| countryCode | string | Country Code | v2
v3
v4 | | **exclusionOtherInformation --> moreLocations --> secondaryAddress** | -| addressLine1 | string | Address Line 1 | v2
v3 | -| addressLine2 | string | Address Line 2 | v2
v3 | -| city | string | City | v2
v3 | -| stateOrProvinceCode | string | State or Province Code | v2
v3 | -| zipCode | string | Zip Code | v2
v3 | -| zipCodePlus4 | string | Zip Code Plus 4 | v2
v3 | -| countryCode | string | Country Code | v2
v3 | +| addressLine1 | string | Address Line 1 | v2
v3
v4 | +| addressLine2 | string | Address Line 2 | v2
v3
v4 | +| city | string | City | v2
v3
v4 | +| stateOrProvinceCode | string | State or Province Code | v2
v3
v4 | +| zipCode | string | Zip Code | v2
v3
v4 | +| zipCodePlus4 | string | Zip Code Plus 4 | v2
v3
v4 | +| countryCode | string | Country Code | v2
v3
v4 | | **vesselDetails** | -| callSign | string | Call Sign | v1
v2
v3 | -| type | string | Type | v1
v2
v3 | -| tonnage | string | Tonnage | v1
v2
v3 | -| grt | string | GRT | v1
v2
v3 | -| flag | string | Flag | v1
v2
v3 | -| owner | string | Owner | v1
v2
v3 | +| callSign | string | Call Sign | v1
v2
v3
v4 | +| type | string | Type | v1
v2
v3
v4 | +| tonnage | string | Tonnage | v1
v2
v3
v4 | +| grt | string | GRT | v1
v2
v3
v4 | +| flag | string | Flag | v1
v2
v3
v4 | +| owner | string | Owner | v1
v2
v3
v4 | | **vesselDetails --> secondaryAddress** | -| addressLine1 | string | Address Line 1 | v1
v2
v3 Production only | -| addressLine2 | string | Address Line 2 | v1
v2
v3 Production only | -| city | string | Address City | v1
v2
v3 Production only | -| stateOrProvinceCode | string | Address State or Province Code | v1
v2
v3 Production only | -| zipCode | string | Address Zip OR Postal Code | v1
v2
v3 Production only | -| zipCodePlus4 | string | Address Zip Plus 4 | v1
v2
v3 Production only | -| countryCode | string | Country Code | v1
v2
v3 Production only | +| addressLine1 | string | Address Line 1 | v1
v2
v3
v4 Production only | +| addressLine2 | string | Address Line 2 | v1
v2
v3
v4 Production only | +| city | string | Address City | v1
v2
v3
v4 Production only | +| stateOrProvinceCode | string | Address State or Province Code | v1
v2
v3
v4 Production only | +| zipCode | string | Address Zip OR Postal Code | v1
v2
v3
v4 Production only | +| zipCodePlus4 | string | Address Zip Plus 4 | v1
v2
v3
v4 Production only | +| countryCode | string | Country Code | v1
v2
v3
v4 Production only |

Back to top

-## OpenAPI Specification File +## OpenAPI Specification File You can view the full details of this API in the OpenAPI Specification file available here: Open API specification file for the Exclusion API @@ -243,18 +246,18 @@ The API will return one of the following responses: 400 - Application Level Error Messages:

1. Invalid "Date" format:
v1 or v2: Date should be specified in the format: MM/dd/YYYY.
v3: "message":"Dates must be specified in the MM/DD/YYYY format.", "detail":"Any Date parameter must be provided in the MM/DD/YYYY format.".

2. Invalid Input Parameters:
v1 or v2: "title":"Invalid Input Parameters","detail":"< user-provided invalid parameter >".
v3: "message":"The search parameter, < user-provided invalid parameter > does not exist.","detail":"Please refer to https://open.gsa.gov/api/exclusions-api/ for a list of allowable search parameters.".

3. If ‘includeSections’, ‘emailId’, ‘format’, ‘exclusionName’, ‘includeSections’, ‘addressLine1’, ‘addressLine2’, or ‘ssnOrTinOrEin’ is sent in the "q" parameter:
v1 or v2: The parameter: ‘emailId’, ‘format’, ‘exclusionName’, ‘includeSections’, ‘addressLine1’, ‘addressLine2’, or ‘ssnOrTinOrEin’ is not permitted inside Query Param(q).
v3: "message":"The search parameters 'emailId', 'format', 'exclusionName', 'includeSections', 'addressLine1', 'addressLine2', and 'ssnOrTinOrEin' are not permitted inside Query Param(q)","detail":"Please provide these parameters separately.".

4. A null or an empty value is sent in the "q" parameter:
v1 or v2: "title":"Invalid input","detail":"The value null/empty is not valid for parameter ‘Query Param (q)’"
v3: "message":"Invalid input","detail":"The value null/empty is not valid for parameter ‘Query Param (q)’".

5. More than 100 "cageCode" values are sent:
v1 or v2: A maximum of 100 CAGE Codes is allowed.
v3: "message":"More than 100 CAGE Codes are not allowed.","detail":"Please limit the number of CAGE Codes to 100."

6. If "emailId" is sent on its own:
v1 or v2: The Parameter emailId must be provided in conjunction with the parameter format.
v3: "message":"The search parameter 'emailId' must be provided in conjunction with the search parameter 'format'.","detail":"Users can opt for receiving the requested JSON/CSV files in their emails."

7. If "includeSections" contains an invalid value:
v1 or v2: includeSections contains invalid value.
v3: "message":"The search parameter 'includeSections' contains an invalid value - < user-provided invalid parameter >,"detail":"Please refer to https://open.gsa.gov/api/exclusions-api/ for a list of allowable values.".

8. If "ssnOrTinOrEin" is provided on its own:
v1 or v2: ssnOrTinOrEin filter must be provided in conjunction with exclusionName.
v3: "message":"The search parameter 'ssnOrTinOrEin' must be provided in conjunction with the search parameter 'exclusionName'.","detail":"The 'ssnOrTinOrEin' parameter cannot be provided on its own.".

9. Invalid "ssnOrTinOrEin" length or "ssnOrTinOrEin" has more than one value:
v1 or v2: The search parameter, 'ssnOrTinOrEin' will only accept one complete 9 digit value (e.g.: ssnOrTinOrEin=000000000).
v3: "message":"The search parameter 'ssnOrTinOrEin' will only accept one complete 9 digit value.","detail":"An example value is 000000000.".

10. More than one "exclusionName" value is provided with "addressLine1" and "addressLine2":
v1 or v2: exclusionName will only accept one value when it is provided in conjunction with addressLine1 and addressLine2.
v3: "message":"The search parameter 'exclusionName' will only accept one value when it is provided in conjunction with 'addressLine1' and 'addressLine2'.","detail":"Use 'exclusionName' on its own or in conjunction with non-address search parameters.".

11. Invalid "recordStatus" value:
v1 or v2: "title":"Invalid input","errorCode":"IIP","detail":"Invalid input for recordStatus"
v3: "message":"The search parameter 'recordStatus' will only accept Active as the value.","detail":"Only Active records are returned.

12. "Invalid "format" value:
v1 or v2: "title":"Invalid input","detail":"Invalid Input value for format".
v3: "message":"Invalid input value for format","detail":"The allowable values are JSON and CSV."13. JSON or CSV file generation is in-progress:
v1 or v2: "title":"Extract File Generation is Still in Progress","detail":"File Processing in Progress. Please check again later ".
v3: "message":"The requested JSON or CSV file is not generated yet. Please try again later.","detail":"Larger files will take some time to process.".

14. A non-existent token is used for downloading a JSON or a CSV file:
v1 or v2: "title":"Extract File Not Found and we are not able to process your request","detail":"We are not able to find the requested file".
v3: "message":"The requested JSON or CSV file token could not be found.","detail":"Please verify the token number."

15. An expired token is used for downloading a JSON or a CSV file:
v1 or v2: "title":"Requested File is Expired and cannot be downloaded","detail":"We are not able to process your request".
v3: "message":"The requested JSON or CSV file token is expired.","detail":"Please verify the token number." + Application Level Error Messages:

1. Invalid "Date" format:
v1 or v2: Date should be specified in the format: MM/dd/YYYY.
v3 or v4: "message":"Dates must be specified in the MM/DD/YYYY format.", "detail":"Any Date parameter must be provided in the MM/DD/YYYY format.".

2. Invalid Input Parameters:
v1 or v2: "title":"Invalid Input Parameters","detail":"< user-provided invalid parameter >".
v3 or v4: "message":"The search parameter, < user-provided invalid parameter > does not exist.","detail":"Please refer to https://open.gsa.gov/api/exclusions-api/ for a list of allowable search parameters.".

3. If ‘includeSections’, ‘emailId’, ‘format’, ‘exclusionName’, ‘includeSections’, ‘addressLine1’, ‘addressLine2’, or ‘ssnOrTinOrEin’ is sent in the "q" parameter:
v1 or v2: The parameter: ‘emailId’, ‘format’, ‘exclusionName’, ‘includeSections’, ‘addressLine1’, ‘addressLine2’, or ‘ssnOrTinOrEin’ is not permitted inside Query Param(q).
v3 or v4: "message":"The search parameters 'emailId', 'format', 'exclusionName', 'includeSections', 'addressLine1', 'addressLine2', and 'ssnOrTinOrEin' are not permitted inside Query Param(q)","detail":"Please provide these parameters separately.".

4. A null or an empty value is sent in the "q" parameter:
v1 or v2: "title":"Invalid input","detail":"The value null/empty is not valid for parameter ‘Query Param (q)’"
v3 or v4: "message":"Invalid input","detail":"The value null/empty is not valid for parameter ‘Query Param (q)’".

5. More than 100 "cageCode" values are sent:
v1 or v2: A maximum of 100 CAGE Codes is allowed.
v3 or v4: "message":"More than 100 CAGE Codes are not allowed.","detail":"Please limit the number of CAGE Codes to 100."

6. If "emailId" is sent on its own:
v1 or v2: The Parameter emailId must be provided in conjunction with the parameter format.
v3 or v4: "message":"The search parameter 'emailId' must be provided in conjunction with the search parameter 'format'.","detail":"Users can opt for receiving the requested JSON/CSV files in their emails."

7. If "includeSections" contains an invalid value:
v1 or v2: includeSections contains invalid value.
v3 or v4: "message":"The search parameter 'includeSections' contains an invalid value - < user-provided invalid parameter >,"detail":"Please refer to https://open.gsa.gov/api/exclusions-api/ for a list of allowable values.".

8. If "ssnOrTinOrEin" is provided on its own:
v1 or v2: ssnOrTinOrEin filter must be provided in conjunction with exclusionName.
v3 or v4: "message":"The search parameter 'ssnOrTinOrEin' must be provided in conjunction with the search parameter 'exclusionName'.","detail":"The 'ssnOrTinOrEin' parameter cannot be provided on its own.".

9. Invalid "ssnOrTinOrEin" length or "ssnOrTinOrEin" has more than one value:
v1 or v2: The search parameter, 'ssnOrTinOrEin' will only accept one complete 9 digit value (e.g.: ssnOrTinOrEin=000000000).
v3 or v4: "message":"The search parameter 'ssnOrTinOrEin' will only accept one complete 9 digit value.","detail":"An example value is 000000000.".

10. More than one "exclusionName" value is provided with "addressLine1" and "addressLine2":
v1 or v2: exclusionName will only accept one value when it is provided in conjunction with addressLine1 and addressLine2.
v3 or v4: "message":"The search parameter 'exclusionName' will only accept one value when it is provided in conjunction with 'addressLine1' and 'addressLine2'.","detail":"Use 'exclusionName' on its own or in conjunction with non-address search parameters.".

11. Invalid "recordStatus" value:
v1 or v2: "title":"Invalid input","errorCode":"IIP","detail":"Invalid input for recordStatus"
v3 or v4: "message":"The search parameter 'recordStatus' will only accept Active as the value.","detail":"Only Active records are returned.

12. "Invalid "format" value:
v1 or v2: "title":"Invalid input","detail":"Invalid Input value for format".
v3 or v4: "message":"Invalid input value for format","detail":"The allowable values are JSON and CSV."

13. JSON or CSV file generation is in-progress:
v1 or v2: "title":"Extract File Generation is Still in Progress","detail":"File Processing in Progress. Please check again later ".
v3 or v4: "message":"The requested JSON or CSV file is not generated yet. Please try again later.","detail":"Larger files will take some time to process.".

14. A non-existent token is used for downloading a JSON or a CSV file:
v1 or v2: "title":"Extract File Not Found and we are not able to process your request","detail":"We are not able to find the requested file".
v3 or v4: "message":"The requested JSON or CSV file token could not be found.","detail":"Please verify the token number."

15. An expired token is used for downloading a JSON or a CSV file:
v1 or v2: "title":"Requested File is Expired and cannot be downloaded","detail":"We are not able to process your request".
v3 or v4: "message":"The requested JSON or CSV file token is expired.","detail":"Please verify the token number." 403 - 1. Missing API Key:
v1, v2 or v3: No api_key was supplied in request body. Please submit with a valid API key.

2. An invalid API Key:
v1, v2 or v3: An invalid API key was supplied. Please submit with a valid API key. + 1. Missing API Key:
v1, v2, v3 or v4: No api_key was supplied in request body. Please submit with a valid API key.

2. An invalid API Key:
v1, v2, v3 or v4: An invalid API key was supplied. Please submit with a valid API key. 405 - If any method other than "GET" is used:
v1, v2 or v3: Method Not Allowed. + If any method other than "GET" is used:
v1, v2, v3 or v4: Method Not Allowed. - NOTE:
Error messages in v1 and v2 are returned in this fashion: httpStatus, title, detail, errorCode, source
Error messages in v3 are returned in this fashion: Status, timestamp, message, detail, errorCode, transaction_id + NOTE:
Error messages in v1 and v2 are returned in this fashion: httpStatus, title, detail, errorCode, source
Error messages in v3 and v4 are returned in this fashion: Status, timestamp, message, detail, errorCode, transaction_id @@ -266,10 +269,10 @@ The API will return one of the following responses:
Request URL v2 Production URL: https://api.sam.gov/entity-information/v2/exclusions?api_key=< PUBLIC API Key >&classification=Firm&stateProvince=VA
-v3 Production URL: COMING SOON
+v3 Production URL: https://api.sam.gov/entity-information/v3/exclusions?api_key=< PUBLIC API Key >&classification=Firm&stateProvince=VA

v2 Alpha URL: https://api-alpha.sam.gov/entity-information/v2/exclusions?api_key=< PUBLIC API Key >&classification=Firm&stateProvince=VA
-v3 Alpha URL: COMING SOON
+v3 Alpha URL: https://api-alpha.sam.gov/entity-information/v3/exclusions?api_key=< PUBLIC API Key >&classification=Firm&stateProvince=VA

@@ -483,10 +486,10 @@ v2 Response:
Request URL v2 Production URL: https://api.sam.gov/entity-information/v2/exclusions?api_key=< PUBLIC API Key >&classification=Firm&format=CSV
-v3 Production URL: COMING SOON
+v3 Production URL: https://api.sam.gov/entity-information/v3/exclusions?api_key=< PUBLIC API Key >&classification=Firm&format=CSV


v2 Alpha URL: https://api-alpha.sam.gov/entity-information/v2/exclusions?api_key=< PUBLIC API Key >&classification=Firm&format=CSV
-v3 Alpha URL: COMING SOON
+v3 Alpha URL: https://api-alpha.sam.gov/entity-information/v3/exclusions?api_key=< PUBLIC API Key >&classification=Firm&format=CSV

@@ -526,104 +529,104 @@ Note: Public Response for one record is provided as an example
A sample record is provided here: - "excludedEntity": [ - { - "exclusionDetails": { - "classificationType": "Individual", - "exclusionType": "Ineligible (Proceedings Completed)", - "exclusionProgram": "Reciprocal", - "excludingAgencyCode": "ARMY", - "excludingAgencyName": "DEPT OF THE ARMY" - }, - "exclusionIdentification": { - "ueiSAM": null, - "cageCode": null, - "npi": null, - "prefix": "Ms.", - "firstName": "Chong", - "middleName": "Sun", - "lastName": "Hwang", - "suffix": null, - "entityName": "Ms. Chong Sun Hwang", - "dnbOpenData": null - }, - "exclusionActions": { - "listOfActions": [ - { - "createDate": "07-27-2012", - "updateDate": "07-27-2012", - "activateDate": "12-12-2011", - "terminationDate": "11-08-2029", - "terminationType": "Definite", - "recordStatus": "Active" - } - ] - }, - "exclusionPrimaryAddress": { - "addressLine1": null, - "addressLine2": null, - "city": "Dongjak-gu, Seoul", - "stateOrProvinceCode": null, - "zipCode": null, - "zipCodePlus4": null, - "countryCode": "KOR" - }, - "exclusionSecondaryAddress": [], - "exclusionOtherInformation": { - "additionalComments": null, - "ctCode": "A", - "evsInvestigationStatus": null, - "references": { - "referencesList": [ - { - "exclusionName": null, - "type": null - } - ] - }, - "moreLocations": [ - { - "exclusionName": null, - "duns": null, - "cageCode": null, - "npi": null, - "primaryAddress": { - "addressLine1": null, - "addressLine2": null, - "city": null, - "stateOrProvinceCode": null, - "zipCode": null, - "zipCodePlus4": null, - "countryCode": null - }, - "secondaryAddress": [ - { - "addressLine1": null, - "addressLine2": null, - "city": null, - "stateOrProvinceCode": null, - "zipCode": null, - "zipCodePlus4": null, - "countryCode": null - } - ] - } - ] - }, - "vesselDetails": { - "callSign": null, - "type": null, - "tonnage": null, - "grt": null, - "flag": null, - "owner": null - } - }, - - "links": { - "selfLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&classification=[Individual~Special%20Entity%20Designation&excludingAgencyCode=!DOJ&country=KOR&q=CHONG&page=0&size=10", - - } +"excludedEntity": [ +{ +"exclusionDetails": { +"classificationType": "Individual", +"exclusionType": "Ineligible (Proceedings Completed)", +"exclusionProgram": "Reciprocal", +"excludingAgencyCode": "ARMY", +"excludingAgencyName": "DEPT OF THE ARMY" +}, +"exclusionIdentification": { +"ueiSAM": null, +"cageCode": null, +"npi": null, +"prefix": "Ms.", +"firstName": "Chong", +"middleName": "Sun", +"lastName": "Hwang", +"suffix": null, +"entityName": "Ms. Chong Sun Hwang", +"dnbOpenData": null +}, +"exclusionActions": { +"listOfActions": [ +{ +"createDate": "07-27-2012", +"updateDate": "07-27-2012", +"activateDate": "12-12-2011", +"terminationDate": "11-08-2029", +"terminationType": "Definite", +"recordStatus": "Active" +} +] +}, +"exclusionPrimaryAddress": { +"addressLine1": null, +"addressLine2": null, +"city": "Dongjak-gu, Seoul", +"stateOrProvinceCode": null, +"zipCode": null, +"zipCodePlus4": null, +"countryCode": "KOR" +}, +"exclusionSecondaryAddress": [], +"exclusionOtherInformation": { +"additionalComments": null, +"ctCode": "A", +"evsInvestigationStatus": null, +"references": { +"referencesList": [ +{ +"exclusionName": null, +"type": null +} +] +}, +"moreLocations": [ +{ +"exclusionName": null, +"duns": null, +"cageCode": null, +"npi": null, +"primaryAddress": { +"addressLine1": null, +"addressLine2": null, +"city": null, +"stateOrProvinceCode": null, +"zipCode": null, +"zipCodePlus4": null, +"countryCode": null +}, +"secondaryAddress": [ +{ +"addressLine1": null, +"addressLine2": null, +"city": null, +"stateOrProvinceCode": null, +"zipCode": null, +"zipCodePlus4": null, +"countryCode": null +} +] +} +] +}, +"vesselDetails": { +"callSign": null, +"type": null, +"tonnage": null, +"grt": null, +"flag": null, +"owner": null +} +}, + +"links": { +"selfLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&classification=[Individual~Special%20Entity%20Designation&excludingAgencyCode=!DOJ&country=KOR&q=CHONG&page=0&size=10", + +}

@@ -649,50 +652,175 @@ Note: Public Response for one record is provided as an example
A sample record is provided here: - "excludedEntity": [ - { - "exclusionDetails": { - "classificationType": "Firm", - "exclusionType": "Ineligible (Proceedings Completed)", - "exclusionProgram": "Reciprocal", - "excludingAgencyCode": "AF", - "excludingAgencyName": "DEPT OF THE AIR FORCE" - }, - "exclusionIdentification": { - "ueiSAM": "H2XFNNKK2NZ9", - "cageCode": null, - "npi": null, - "prefix": null, - "firstName": null, - "middleName": null, - "lastName": null, - "suffix": null, - "entityName": "Shenzhen Hongdark Electronics Co., Ltd.", - "dnbOpenData": null - }, - "exclusionPrimaryAddress": { - "addressLine1": null, - "addressLine2": null, - "city": "Shenzhen", - "stateOrProvinceCode": null, - "zipCode": null, - "zipCodePlus4": null, - "countryCode": "CHN" - }, - "exclusionSecondaryAddress": [] - }, +"excludedEntity": [ +{ +"exclusionDetails": { +"classificationType": "Firm", +"exclusionType": "Ineligible (Proceedings Completed)", +"exclusionProgram": "Reciprocal", +"excludingAgencyCode": "AF", +"excludingAgencyName": "DEPT OF THE AIR FORCE" +}, +"exclusionIdentification": { +"ueiSAM": "H2XFNNKK2NZ9", +"cageCode": null, +"npi": null, +"prefix": null, +"firstName": null, +"middleName": null, +"lastName": null, +"suffix": null, +"entityName": "Shenzhen Hongdark Electronics Co., Ltd.", +"dnbOpenData": null +}, +"exclusionPrimaryAddress": { +"addressLine1": null, +"addressLine2": null, +"city": "Shenzhen", +"stateOrProvinceCode": null, +"zipCode": null, +"zipCodePlus4": null, +"countryCode": "CHN" +}, +"exclusionSecondaryAddress": [] +}, "links": { - "selfLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&q=(country=KOR%20OR%20country=CHN%20OR%20country=DEU)&classification=Firm&exclusionType=[Ineligible%20(Proceedings%20Completed)~Prohibition/Restriction&includeSections=exclusionDetails,exclusionIdentification,exclusionAddress&page=0&size=10", - "nextLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&q=(country=KOR%20OR%20country=CHN%20OR%20country=DEU)&classification=Firm&exclusionType=[Ineligible%20(Proceedings%20Completed)~Prohibition/Restriction&includeSections=exclusionDetails,exclusionIdentification,exclusionAddress&page=1&size=10" - } +"selfLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&q=(country=KOR%20OR%20country=CHN%20OR%20country=DEU)&classification=Firm&exclusionType=[Ineligible%20(Proceedings%20Completed)~Prohibition/Restriction&includeSections=exclusionDetails,exclusionIdentification,exclusionAddress&page=0&size=10", +"nextLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&q=(country=KOR%20OR%20country=CHN%20OR%20country=DEU)&classification=Firm&exclusionType=[Ineligible%20(Proceedings%20Completed)~Prohibition/Restriction&includeSections=exclusionDetails,exclusionIdentification,exclusionAddress&page=1&size=10" +} +} + + +

+ + +### Example 5: Get details for FASCSA Order Exclusion records only. + +
+Request URL +v4 Production URL: https://api.sam.gov/entity-information/v4/exclusions?api_key=< a valid Public API Key >&fascsaOrder=Yes
+
+v4 Alpha URL: https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=< a valid Public API Key >&fascsaOrder=Yes
+
+
+ +
+Response (JSON Output) +Note: Public Response for one record is provided as an example
+

+ +

+{
+    "totalRecords": 16,
+
+A sample record is provided here:
+
+        {
+            "exclusionDetails": {
+                "classificationType": "Firm",
+                "exclusionType": "Prohibition/Restriction",
+                "exclusionProgram": "Reciprocal",
+                "excludingAgencyCode": "AF",
+                "excludingAgencyName": "DEPT OF THE AIR FORCE"
+            },
+            "exclusionIdentification": {
+                "ueiSAM": "J27QHBBBL1V3",
+                "cageCode": null,
+                "npi": null,
+                "prefix": null,
+                "firstName": null,
+                "middleName": null,
+                "lastName": null,
+                "suffix": null,
+                "entityName": "Foxtrot Research Corp",
+                "dnbOpenData": null
+            },
+            "exclusionActions": {
+                "listOfActions": [
+                    {
+                        "createDate": "10-31-2023",
+                        "updateDate": "10-31-2023",
+                        "activateDate": "10-30-2023",
+                        "terminationDate": null,
+                        "terminationType": "Indefinite",
+                        "recordStatus": "Active"
+                    }
+                ]
+            },
+            "exclusionPrimaryAddress": {
+                "addressLine1": null,
+                "addressLine2": null,
+                "city": null,
+                "stateOrProvinceCode": "FL",
+                "zipCode": null,
+                "zipCodePlus4": null,
+                "countryCode": "USA"
+            },
+            "exclusionSecondaryAddress": [],
+            "exclusionOtherInformation": {
+                "isFASCSAOrder": "Yes",
+                "additionalComments": null,
+                "ctCode": null,
+                "evsInvestigationStatus": null,
+                "references": {
+                    "referencesList": [
+                        {
+                            "exclusionName": null,
+                            "type": null
+                        }
+                    ]
+                },
+                "moreLocations": [
+                    {
+                        "exclusionName": null,
+                        "ueiSAM": null,
+                        "cageCode": null,
+                        "npi": null,
+                        "primaryAddress": {
+                            "addressLine1": null,
+                            "addressLine2": null,
+                            "city": null,
+                            "stateOrProvinceCode": null,
+                            "zipCode": null,
+                            "zipCodePlus4": null,
+                            "countryCode": null
+                        },
+                        "secondaryAddress": [
+                            {
+                                "addressLine1": null,
+                                "addressLine2": null,
+                                "city": null,
+                                "stateOrProvinceCode": null,
+                                "zipCode": null,
+                                "zipCodePlus4": null,
+                                "countryCode": null
+                            }
+                        ]
+                    }
+                ]
+            },
+            "vesselDetails": {
+                "callSign": null,
+                "type": null,
+                "tonnage": null,
+                "grt": null,
+                "flag": null,
+                "owner": null
+            }
+        },
+    ],
+    "links": {
+        "selfLink": "https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=REPLACE_WITH_API_KEY&fascsaOrder=Yes&page=0&size=10",
+        "nextLink": "https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=REPLACE_WITH_API_KEY&fascsaOrder=Yes&page=1&size=10"
+    }
 }

-### Example 5: To receive a file downloadable link in the email for the requested CSV results. +### Example 6: To receive a file downloadable link in the email for the requested CSV results.
Request URL Production URL: https://api.sam.gov/entity-information/v2/exclusions?api_key=< a valid Public API Key >&q=(country=KOR OR country=CHN OR country=DEU)&classification=Firm&exclusionType=[Ineligible (Proceedings Completed)~Prohibition/Restriction]&includeSections=exclusionDetails,exclusionIdentification,exclusionAddress&format=CSV&emailId=Y
@@ -709,7 +837,7 @@ Click to view CSV Response for one record Back to top

## Additional Information -You can view the full details of the differences between the SAM legacy API and SAM.gov API +You can view the full details of the differences between the SAM legacy API and SAM.gov API
available here: Variance Document
Disclaimer: @@ -724,46 +852,46 @@ Disclaimer: ## Contact Us * Reach out to the SAM.gov team at www.fsd.gov for inquiries and help desk support. - * Before contacting the help desk, conduct your own initial troubleshooting - * Conduct a recent review of the open.gsa.gov/api specifications - * Confirm you are using an API tool, not a browser to send the request. (FOUO & Sensitive Calls) - * Confirm you are using the username/password for the system account that created the API key in the authentication header. (Sensitive Calls) - * Confirm you used POST and not GET for this request (Sensitive Calls) - * Confirm that the API key is from a system account (FOUO & Sensitive Calls) - * Confirm that the API key being used is still active - * Confirm that the system account you are using has “read fouo” or “read sensitive” permissions as applicable (FOUO & Sensitive Calls) - * Confirm that the IP addresses registered with your system account are current - * When submitting help desk tickets for API or system connection issues, provide the following: - * The exact API requests that you were trying to send - * The exact error messages that you were receiving - * The exact dates and times when you received the errors - * Screenshots (with the actual API request and the error) [Attach to the ticket] - * The System Account ID/Name that was trying to make API calls - * Screenshots of the parameters used for API call [Attach to the ticket] - * Screenshots of the Headers used for the API call [Attach to the ticket] + * Before contacting the help desk, conduct your own initial troubleshooting + * Conduct a recent review of the open.gsa.gov/api specifications + * Confirm you are using an API tool, not a browser to send the request. (FOUO & Sensitive Calls) + * Confirm you are using the username/password for the system account that created the API key in the authentication header. (Sensitive Calls) + * Confirm you used POST and not GET for this request (Sensitive Calls) + * Confirm that the API key is from a system account (FOUO & Sensitive Calls) + * Confirm that the API key being used is still active + * Confirm that the system account you are using has “read fouo” or “read sensitive” permissions as applicable (FOUO & Sensitive Calls) + * Confirm that the IP addresses registered with your system account are current + * When submitting help desk tickets for API or system connection issues, provide the following: + * The exact API requests that you were trying to send + * The exact error messages that you were receiving + * The exact dates and times when you received the errors + * Screenshots (with the actual API request and the error) [Attach to the ticket] + * The System Account ID/Name that was trying to make API calls + * Screenshots of the parameters used for API call [Attach to the ticket] + * Screenshots of the Headers used for the API call [Attach to the ticket] * Users requesting access to the test site (alpha.sam.gov) should follow the below steps. These steps ONLY apply to alpha.sam.gov access requests. - 1. Navigate to www.fsd.gov - 2. Sign into the FSD platform using your FSD credentials - 3. Select "Create an Incident" - 4. Create an Incident -
    -
  1. System Name: System for Award Management (SAM)
    2. -
  2. Is this related to the American Rescue Plan Act?: No
    3. -
  3. Issue Type: Other
    4. -
  4. Business Type: Other
    5. -
  5. Subject (select 1): -
      -
    1. Option A: I need a role to test in alpha.sam.gov.
      2. -
    2. Option B: System account approval in alpha.sam.gov
      3. -
    -
    6. -
  6. Please describe the issue: (Copy and paste the below information into the ticket, filling in your information within the brackets) -
      -
    1. Option A: I have already navigated to alpha.sam.gov and created a user account, following the same steps for creating an account in sam.gov. I would like to conduct testing but do not have the necessary role(s) in alpha.sam.gov. The account that needs role assignment is associated with [EMAIL ADDRESS]. I request a [ROLE] role for the [DOMAIN] domain in alpha.sam.gov.
      2. -
    2. Option B: I am creating/editing a system account and have submitted my account in alpha.sam.gov for approval. I would like to request alpha.sam.gov system account review and approval for [Name of the alpha.sam.gov system account].
      3. -
    -
    7. -
+ 1. Navigate to www.fsd.gov + 2. Sign into the FSD platform using your FSD credentials + 3. Select "Create an Incident" + 4. Create an Incident +
    +
  1. System Name: System for Award Management (SAM)
    2. +
  2. Is this related to the American Rescue Plan Act?: No
    3. +
  3. Issue Type: Other
    4. +
  4. Business Type: Other
    5. +
  5. Subject (select 1): +
      +
    1. Option A: I need a role to test in alpha.sam.gov.
      2. +
    2. Option B: System account approval in alpha.sam.gov
      3. +
    +
    6. +
  6. Please describe the issue: (Copy and paste the below information into the ticket, filling in your information within the brackets) +
      +
    1. Option A: I have already navigated to alpha.sam.gov and created a user account, following the same steps for creating an account in sam.gov. I would like to conduct testing but do not have the necessary role(s) in alpha.sam.gov. The account that needs role assignment is associated with [EMAIL ADDRESS]. I request a [ROLE] role for the [DOMAIN] domain in alpha.sam.gov.
      2. +
    2. Option B: I am creating/editing a system account and have submitted my account in alpha.sam.gov for approval. I would like to request alpha.sam.gov system account review and approval for [Name of the alpha.sam.gov system account].
      3. +
    +
    7. +

Back to top

@@ -792,5 +920,6 @@ Date | Version | Description 10/21/2021 | v2.8 | * Updated Examples - Added Example 1 and Example 2 to indicate the post April 3rd, 2022 behavior.

* Added notes in the Query String Parameters, Expected Result and HTTP Response Codes sections to highlight the until and after April 3rd, 2022 behavior. 02/01/2022 | v2.9 | * Added exclusions V3 endpoint information to the Getting Started section.

* Updated the Query String Parameters and Expected Results sections to reflect available parameters and response fields in V3.

* Updated the Example 1 and Example 2 to indicate the V3 behavior.

* Updated the section, "HTTP Response Codes" to indicate the v3 behavior.

* Update the OpenAPI Specification File to include the V3 endpoints. 04/04/2022 | v3.0 | * Provided the v3 end point for Production.

* Removed ueiDUNS occurrences from the sections, Query String Parameters, Expected Result, HTTP Response Codes and Examples. +12/01/2023 | v3.1 | A new V4 Exclusions API has been created, enabling the search and response for FASCSA Order Exclusion records. As part of this change, below are the associated changes made to this OpenGSA page:

* Added exclusions V4 endpoint information to the Getting Started section.

* Updated the Query String Parameters and Expected Results sections to reflect available parameters and response fields in V4.

* Moved the existing Example 5 to Example 6; inserted a new Example 5 to indicate V4 behavior.

* Updated the section, “HTTP Response Codes” to indicate the v4 behavior.

* Updated the OpenAPI Specification File to include the V4 endpoints.

Back to top

diff --git a/_apidocs/exclusions-api/v1/openapi.yaml b/_apidocs/exclusions-api/v1/openapi.yaml index 7997b8065..a8b362a03 100644 --- a/_apidocs/exclusions-api/v1/openapi.yaml +++ b/_apidocs/exclusions-api/v1/openapi.yaml @@ -19,6 +19,8 @@ tags: description: Exclusions Api Controller V 2 - name: exclusions-api-controller-v-3 description: Exclusions Api Controller V 3 +- name: exclusions-api-controller-v-4 + description: Exclusions Api Controller V 4 - name: file-download-controller description: File Download Controller paths: @@ -842,4 +844,292 @@ paths: description: The resource you were trying to reach is not found content: {} deprecated: false + /entity-information/v4/download-exclusions: + get: + tags: + - exclusions-api-controller-v-4 + summary: ' download V4 exclusion extract file' + operationId: getFileFromS3UsingGET + requestBody: + description: token to download specific file + content: + '*/*': + schema: + type: string + required: false + responses: + 200: + description: Successfully downloaded file + content: + application/hal+json: + 401: + description: You are not authorized to view the resource + content: {} + 403: + description: Accessing the resource you were trying to reach is forbidden + content: {} + 404: + description: The resource you were trying to reach is not found + content: {} + deprecated: false + x-codegen-request-body-name: token + /entity-information/v4/exclusions: + get: + tags: + - exclusions-api-controller-v-4 + summary: ' get Exclusions Details' + operationId: getExclusionsDataUsingGET_2 + parameters: + - name: activationDate + in: query + description: A single Date or Date range in the format MM/DD/YYYY + schema: + type: string + - name: activationDateFrom + in: query + schema: + type: string + - name: activationDateTo + in: query + schema: + type: string + - name: addressLine1 + in: query + description: A String (1234 test Dr) + schema: + type: string + - name: addressLine2 + in: query + description: A String (1234 test Dr) + schema: + type: string + - name: cageCode + in: query + description: A String (0Y5L9, null) + schema: + type: string + - name: city + in: query + schema: + type: string + - name: cityState + in: query + schema: + type: string + - name: cityStateZipCongFlag + in: query + schema: + type: boolean + - name: classification + in: query + description: A String (Individual, Firm, Vessel, Special Entity Designation, + null) + schema: + type: string + - name: country + in: query + description: A String (USA, CAN, ARE, null) + schema: + type: string + - name: createDateFrom + in: query + schema: + type: string + - name: createDateTo + in: query + schema: + type: string + - name: creationDate + in: query + description: A single Date or Date range in the format MM/DD/YYYY + schema: + type: string + - name: ctCode + in: query + description: A String (A, ZZ, XXX, 03-SDNTK-01, null) + schema: + type: string + - name: emailId + in: query + description: Email ID + schema: + type: string + - name: exactMatch + in: query + schema: + type: boolean + - name: excludedPartyName + in: query + schema: + type: string + - name: excludingAgencyCode + in: query + description: A String (AF, DOJ, FEMA-IOD, null) + schema: + type: string + - name: excludingAgencyName + in: query + description: A String (FEDERAL, FEDERAL EMERGENCY MANAGEMENT AGENCY, null) + schema: + type: string + - name: exclusionName + in: query + description: A partial text or a complete text + schema: + type: string + - name: exclusionProgram + in: query + description: A String (Reciprocal, Non-Procurement, Procurement) + schema: + type: string + - name: exclusionType + in: query + description: A String (Ineligible (Proceedings Pending), Ineligible (Proceedings + Completed), Prohibition/Restriction, Voluntary Exclusion) + schema: + type: string + - name: format + in: query + description: Parameter used to download csv or json files + schema: + type: string + - name: includeSections + in: query + description: Schema Filtering Paramter + schema: + type: string + - name: isActive + in: query + description: A String (Y, N) + schema: + type: string + - name: isDisasterResponseParticipant + in: query + schema: + type: string + - name: legalBusinessName + in: query + schema: + type: string + - name: naicsCode + in: query + schema: + type: string + - name: npi + in: query + description: A String (1053373266, null) + schema: + type: string + - name: organizationId + in: query + schema: + type: string + - name: page + in: query + description: Page number + schema: + type: string + - name: pscCode + in: query + schema: + type: string + - name: q + in: query + description: Free text, All the above filters and their acceptable values + can be used + schema: + type: string + - name: qMode + in: query + schema: + type: string + - name: recordStatus + in: query + description: Record Status (Active, Inactive) + schema: + type: string + - name: registrationStatus + in: query + schema: + type: string + - name: size + in: query + description: Record size per page + schema: + type: string + - name: sort + in: query + schema: + type: string + - name: sortOrder + in: query + schema: + type: string + enum: + - asc + - desc + - name: ssnOrTinOrEin + in: query + description: 9 digit number or null (XXXXXXXXX, null) + schema: + type: string + - name: stateProvince + in: query + description: A String (NC, XX, null, 470105, YAMALO-NENETSKI OKR.) + schema: + type: string + - name: terminationDate + in: query + description: A single Date or Date range in the format MM/DD/YYYY + schema: + type: string + - name: terminationDateFrom + in: query + schema: + type: string + - name: terminationDateTo + in: query + schema: + type: string + - name: title + in: query + schema: + type: string + - name: ueiSAM + in: query + description: Unique Entity Identifier SAM- 12 digit value - Replacement + for ueiSAM + schema: + type: string + - name: updateDate + in: query + description: A single Date or Date range in the format MM/DD/YYYY + schema: + type: string + - name: zipCode + in: query + description: A String (0, 41722, 21453935, 752435120, 75602-1112, null, C.P. + 44890, oo957, TQ13 9SE, Zimbabwe, P.O. Box Beirut-Hamra) + schema: + type: string + - name: fascsaOrder + in: query + description: This field is used to filter out FASCSA Orders. It accepts Yes or No and is case-insensitive. + schema: + type: string + responses: + 200: + description: Successfully retrieved list + content: + application/hal+json: + 401: + description: You are not authorized to view the resource + content: {} + 403: + description: Accessing the resource you were trying to reach is forbidden + content: {} + 404: + description: The resource you were trying to reach is not found + content: {} + deprecated: false components: {} diff --git a/_apidocs/sam-entity-extracts-api.md b/_apidocs/sam-entity-extracts-api.md index 5c07f6ebe..7eb89c5b3 100644 --- a/_apidocs/sam-entity-extracts-api.md +++ b/_apidocs/sam-entity-extracts-api.md @@ -93,6 +93,25 @@ E.g.: The file generated on 04/05/2022 will show 2022095. E.g.: The file for 04/06/2022 would be SAM_Exclusions_Public_Extract_V2_22096.ZIP. + + +Daily FASCSA Exclusion Extracts + + + + @@ -233,7 +252,9 @@ Curl request with username and password: curl -X POST "https://api.sam.gov/data- fileName This parameter must be used on its own. It allows users to provide the extract file name.
-Examples: fileName=SAM_PUBLIC_MONTHLY_V2_20220406.ZIP; fileName= SAM_Exclusions_Public_Extract_V2_22096.ZIP +Examples: fileName=SAM_PUBLIC_MONTHLY_V2_20220406.ZIP;
+fileName= SAM_Exclusions_Public_Extract_V2_22096.ZIP;
+fileName= FASCSAOrders23277.CSV
@@ -311,6 +332,10 @@ Permitted values: V2 for the Public, FOUO and Exclusion extracts; V3 for the Sen Exclusions Extract Layout
+
  • FASCSA Exclusions Public extract layout with the UEI data:
    +FASCSA Exclusions Extract Layout
    +
    • +
    @@ -343,6 +368,12 @@ Permitted values: V2 for the Public, FOUO and Exclusion extracts; V3 for the Sen + +
  • FASCSA Exclusions files:
    • + @@ -367,6 +398,7 @@ Permitted values: V2 for the Public, FOUO and Exclusion extracts; V3 for the Sen
  • https://api.sam.gov/data-services/v1/extracts?fileType=ENTITY&sensitivity=SENSITIVE&frequency=MONTHLY&date=04/2022&charset=UTF8
  • https://api.sam.gov/data-services/v1/extracts?api_key={API KEY}&fileName=SAM_Exclusions_Public_Extract_V2_22097.ZIP
  • https://api.sam.gov/data-services/v1/extracts?api_key={API KEY}&fileType=EXCLUSION&date=04/07/2022
    • +
  • https://api.sam.gov/data-services/v1/extracts?api_key={API KEY}&fileName=FASCSAOrders23306.CSV
    • @@ -386,6 +418,7 @@ Extract files with UEI Information: * Click to view FOUO Monthly V2 Extract File * Click to view Sensitive Monthly V3 Extract File * Click to view Exclusions Public V2 Extract File
    +* Click to view FASCSA Order Exclusions Public V2 Extract File

    Back to top

    @@ -477,5 +510,6 @@ Date | Version | Description 03/13/2023 | v3.2 | * Deleted the MPIN row from the "SAM Master Extract Mapping" file.

    * Updated row # 288 (which used to track MPIN) in the "Sensitive Extract Layout" file to indicate that the field is deprecated.

    * Removed the MPIN value from the sample "Sensitive Monthly V3 Extract File".

    06/27/2023 | v3.3 | * Updated "Effective April 2022" to "Effective June 2023".

    * Updated the "June 2023 release: SAM Master Extract Mapping" STRING Clarification tab to include the following updates:
     1. NAICS Exception String table updated to reflect January 2023
     changes
     2. SBA Business Types String table updated to include new value:
     "A4- SBA Certified Small Disadvantaged Business"

    09/11/2023 | v3.4 | * Removed "SAM Master Extract Mapping document".

    +12/01/2023 | v3.5 | A new FASCSA Order Exclusions Extract has been created, and the V1 Extracts Download API is now enabled to download this extract. As part of this change, below are the associated changes made to this OpenGSA page:

    * Updated the Extract Calendar to include information on the new FASCSA extract.

    * Updated the Query String Parameters section to reflect an example FASCSA extract file name.

    * Updated the Extract Mapping Document and Layouts section with a new FASCSA Exclusions extract layout document.

    * Updated the Sample Extract File Names with sample FASCSA Exclusions File Names.

    * Updated the Extract Download API Sample Requests section with a sample request for a FASCSA extract.

    * Updated the Sample Extract Files section with a new FASCSA Order Exclusions Public extract file.

    Back to top

    diff --git a/_apidocs/sam-entity-extracts-api/v1/SAM_Exclusions_Public_FASCSA_Orders_Extract_Layout_V2.pdf b/_apidocs/sam-entity-extracts-api/v1/SAM_Exclusions_Public_FASCSA_Orders_Extract_Layout_V2.pdf new file mode 100644 index 000000000..4d4b9e99e Binary files /dev/null and b/_apidocs/sam-entity-extracts-api/v1/SAM_Exclusions_Public_FASCSA_Orders_Extract_Layout_V2.pdf differ diff --git a/_apidocs/sam-entity-extracts-api/v1/openapi.yaml b/_apidocs/sam-entity-extracts-api/v1/openapi.yaml index a4fdda3cf..9aab733b6 100644 --- a/_apidocs/sam-entity-extracts-api/v1/openapi.yaml +++ b/_apidocs/sam-entity-extracts-api/v1/openapi.yaml @@ -49,7 +49,7 @@ paths: - name: frequency in: query description: >- - Specifies desired Frequecy level of the extract that they wish to + Specifies desired Frequency level of the extract that they wish to download required: false schema: @@ -116,7 +116,7 @@ paths: - name: frequency in: query description: >- - Specifies desired Frequecy level of the extract that they wish to + Specifies desired Frequency level of the extract that they wish to download required: false schema: diff --git a/_apidocs/sam-entity-extracts-api/v1/sample-files/FASCSAOrders23306.csv b/_apidocs/sam-entity-extracts-api/v1/sample-files/FASCSAOrders23306.csv new file mode 100644 index 000000000..ab3104cf6 --- /dev/null +++ b/_apidocs/sam-entity-extracts-api/v1/sample-files/FASCSAOrders23306.csv @@ -0,0 +1,7 @@ +Classification,Name,Prefix,First,Middle,Last,Suffix,Address 1,Address 2,City,State / Province,Country,Zip Code,Unique Entity ID,CAGE,Excluding Agency,Additional Comments,Active Date,Termination Date,Creation Date,Update Date,Exclusion Type,FASCSA Order Flag +Individual,,,SAM,A,SMITH,,,,CC,DC,USA,20008,,,,,3/2/2000,Indefinite,10/30/2023,10/30/2023,Ineligible (Proceedings Completed),Y +Individual,,,TEST,,TEST,,,,WASHINGTON,DC,USA,,,,,,10/30/2023,Indefinite,10/30/2023,10/30/2023,Prohibition/Restriction,Y +Special Entity Designation,ALPHA SED TEST 032522 1,,,,,,1 FIRST ST,,CUMBERLAND,MD,USA,21532,XKL8N41334B1,,,,2/2/2002,Indefinite,3/25/2022,10/30/2023,Ineligible (Proceedings Pending),Y +Special Entity Designation,APPLE CO,,,,,,CC,,CC,DC,USA,20008,SDYRXUJT7XA5,,,"This is an exclusion record with type of ""Prohibition/Restriction"".",3/2/2000,Indefinite,10/30/2023,10/30/2023,Prohibition/Restriction,Y +Firm,FOXTROT RESEARCH CORP,,,,,,,,,FL,USA,,J27QHBBBL1V3,,AF,,10/30/2023,Indefinite,10/31/2023,10/31/2023,Prohibition/Restriction,Y +Vessel,SHIPCC,,,,,,CC,,CC,DC,USA,20008,,,,This is a voluntary exclusion.,3/2/2000,Indefinite,10/30/2023,10/30/2023,Voluntary Exclusion,Y