This content is currently not Firefox compliant. Please access via Chrome or Internet Explorer.

Overview

The Entity Management API will allow users to request Public Entity Information based on various optional request parameters.

Key Features of the Entity Management API:

  • It offers several optional search parameters, filtering by sections, AND, OR, NOT conditions and a free text search q to obtain the desired data.
  • It returns synchronous responses directly in the browser.
  • It returns ten records per page in the JSON format.
  • It can return only the first 10,000 records.

Additional Features of the Entity Management API: It can serve as an Extract API with the addition of “format” parameter in the request. Following are the key features of the Entity Management Extract API:

  • It offers several optional search parameters, filtering by sections, AND, OR, NOT conditions and a free text search q to obtain the desired data.
  • It returns asynchronous responses by sending file downloadable links in the browser and in the user emails.
  • It returns data in the JSON or CSV format as selected by the user.
  • It can return only the first 1,000,000 records.

Back to top

Getting Started

Public Entity Details can be accessed from Beta or Alpha via the following end points:

  • Beta: https://api.sam.gov/prod/entity-information/v1/api/entities?api_key= < value >
  • Alpha: https://api-alpha.sam.gov/prodlike/entity-information/v1/api/entities?api_key= < value >

FOUO Entity Details can be accessed from Beta or Alpha via the following end points:

  • Beta: https://api.sam.gov/prod/entity-information/v1/api/entities?api_key= < value >
  • Alpha: https://api-alpha.sam.gov/prodlike/entity-information/v1/api/entities?api_key= < value >

Sensitive Entity Details can be accessed from Beta or Alpha via the following end points:

  • Beta: Coming soon
  • Alpha: https://api-alpha.sam.gov/prodlike/entity-information/v1/api/entities?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 beta.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.
  • 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:

  • Users registered with a non-government email address and associated with an entity OR users registered with a government email address may request a system account for public data access.
  • If a user satisfies the above registration criteria they will be able to access the System Accounts widget from their Workspace page after logging in.
  • The user can then select “Go to System Accounts” from the widget and fill out the required sections.
  • The requested system account will then need to be approved. After approval the user will be notified via email and they can also see the updated status in the System Account widget.
  • The user can select ‘Go to System Accounts’ again in the widget from their workspace and enter a new system account password.
  • After setting up the password the user will see a new section for retrieving a system account API Key.
  • The user must enter their password again to retrieve the key.
  • NOTE: To obtain access to the FOUO/Sensitive Entity API data with a system account the user must be registered with a government email address.

Utilizing the Entity API as an extract:

  • To utilize this API as an Extract an additional parameter called ‘format’ has been implemented.
  • To retrieve Entity data in a CSV format, the parameter ‘&format=csv’ must be provided in the request.
  • To retrieve Entity data in a JSON format, the parameter ‘&format=json’ must be provided in the request.
  • If the requests that contain the ‘format’ parameter are executed successfully, then they will provide the user with a file downloadable URL in the response.
  • In the file downloadable URL, the phrase REPLACE_WITH_API_KEY must be deleted and replaced with a valid API Key and sent as another request.
  • If the file is ready for download, then the users can retrieve it. If the file is not ready for download, then the users will need to try again in some time.
  • Users can also provide another parameter, “emailId” with a valid email address if they choose to receive the file downloadable link in their emails.

Back to top

API Description

If you are using Chrome, subsections that can be expanded are denoted with an arrow.

Public API Information

Query String Parameters
Parameter Name Description Applicable Versions
samRegistered Allows Y or N or ALL.
Example: samRegistered=Y
NOTE: If not used the API will return SAM registrants only by default.
Applicable to non-SAM registrants.
v2
activationDate Allows a single Date or a 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
cageCode Allows exact 5 character value.
Example: cageCode=00000
May be applicable to non-SAM registrants.
v1
v2
dbaName Allows Partial or Complete value.
Example: dbaName=ALLTEL
v1
v2
debtSubjectToOffset Allows Y or N or null.
Example: debtSubjectToOffset=Y
v1
v2
dodaac Allows 9 character value.
Example: dodaac=DOD123456
v1
v2
ueiDUNS Unique Entity Identifier DUNS -Allows 9 digit value, a maximum of up to 100 values can be sent.
Example: ueiDUNS=025114695
Applicable to non-SAM registrants.
v1
v2
ueiSAM Unique Entity Identifier SAM - Allow 12 digit value, alphanumeric (ueiSAM values not yet available for search).
Example: ueiSAM=025114695AST
Applicable to non-SAM registrants.
v1
v2
entityStructureCode Allows 2 character code or null.
Example: entityStructureCode=Z1
v1
v2
entityStructureDesc Allows Description or null.
Example: entityStructureDesc=Partnership or Limited Liability Partnership
v1
v2
exclusionStatusFlag Allows D or null.
Example: exclusionStatusFlag=D
v1
v2
expirationDate -->
registrationExpirationDate
Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: registrationExpirationDate=01/01/2019, registrationExpirationDate=[01/01/2019,05/29/2019]
NOTE: This parameter is being renamed. expirationDate is in V1 and registrationExpirationDate will be V2.
v1
v2
legalBusinessName Allows Partial or Complete value.
Example: legalBusinessName=ALLTEL
Applicable to non-SAM registrants.
v1
v2
primaryNaics Allows 6 digit NAICS, accepts multiple NAICS.
Example: primaryNaics=513310
v1
v2
purposeOfRegistrationCode Allows 2 character code.
Example: purposeOfRegistrationCode=Z2
v1
v2
purposeOfRegistrationDesc Allows a text.
Example: purposeOfRegistrationDesc=All Awards
v1
v2
registrationDate Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: registrationDate=01/01/2019, registrationDate=[01/01/2019,05/29/2019]
v1
v2
ueiCreationDate Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: ueiCreationDate=01/01/2019, ueiCreationDate=[01/01/2019,05/29/2019]
Applicable to non-SAM registrants.
v2
updateDate Allows a single Date or a 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
physicalAddressCity Allows a text.
Example: physicalAddressCity=Herndon
Applicable to non-SAM registrants.
v1
v2
physicalAddressCongressionalDistrict Allows 2 characters.
Example: physicalAddressCongressionalDistrict=AR
Applicable to non-SAM registrants.
v1
v2
physicalAddressCountryCode Allows 3 character code.
Example: physicalAddressCountryCode=USA
Applicable to non-SAM registrants.
v1
v2
physicalAddressProvinceOrState Allows 2 character code.
Example: physicalAddressProvinceOrState=AR
Applicable to non-SAM registrants.
v1
v2
physicalAddressZipPostalCode Allows 5 digit zip code.
Example: physicalAddressZipPostalCode=02201
Applicable to non-SAM registrants.
v1
v2
samExtractCode Allows 1 character code (A or E).
Example: samExtractCode=A
v1
v2
businessTypeCode Allows 2 character code.
Example: businessTypeCode=2L
v1
v2
businessTypeDesc Allows a text.
Example: businessTypeDesc=Woman Owned Business
v1
v2
organizationStructureCode Allows 2 character code.
Example: organizationStructureCode=2L
v1
v2
organizationStructureDesc Allows 2 character code.
Example: organizationStructureDesc=Limited Liability Company
v1
v2
stateOfIncorporationCode Allows 2 character code.
Example: stateOfIncorporationCode=VA
v1
v2
stateOfIncorporationDesc Allows a text.
Example: stateOfIncorporationDesc=Virginia
v1
v2
countryOfIncorporationCode Allows 3 character code.
Example: countryOfIncorporationCode=USA
v1
v2
countryOfIncorporationDesc Allows a text.
Example: countryOfIncorporationDesc=United States Of America
v1
v2
naicsCode Allows 6 character code.
Example: naicsCode=513310
v1
v2
naicsDesc Allows a text.
Example: naicsDesc=Furniture Stores
v1
v2
naicsLimitedSB Allows 6 character code.
Example: naicsLimitedSB=513310
v1
v2
pscCode Allows 4 character code.
Example: pscCode=0989
v1
v2
pscDesc Allows a text.
Example: pscDesc=Screws
v1
v2
servedDisasterStateCode Allows 2 character code.
Example: servedDisasterStateCode=VA
v1
v2
servedDisasterStateName Allows Name or null.
Example: servedDisasterStateName=Virginia
v1
v2
servedDisasterCountyCode Allows text.
Example: servedDisasterCountyCode=12334
v1
v2
servedDisasterCountyName Allows a text.
Example: servedDisasterCountyName=FAIRFAX
v1
v2
servedDisasterMSA Allows text.
Example: servedDisasterMSA=86800730
v1
v2
includeSections Allows to filter data by sections, entityRegistration, coreData, assertions, repsAndCerts and pointsOfContact.
Example: includeSections=entityRegistration,coreData
Applicable to non-SAM registrants but only the sections entityRegistration and coreData are applicable.
v1
v2
format Allows user to download different file formats(csv and json are allowable values).
Example: format=csv<
Applicable to non-SAM registrants.
v1
v2
emailId Allows user to get file download links to email. Email Id should be provided in conjunction with format.
Example: emailId=test@gsa.gov
Applicable to non-SAM registrants.
v1
v2
Expected Result: There are a few placeholder elements that return ‘Currently Not Available’ until they are made available in the database.
entityRegistration Section
Field Name Type Description Applicable Versions
samRegistered string SAM Registered Entity
Applicable to non-SAM registrants.
v2
ueiSAM string Unique Entity Identifier SAM
Applicable to non-SAM registrants.
v1
v2
ueiDUNS string Unique Entity Identifier DUNS
Applicable to non-SAM registrants.
v1
v2
entityEFTIndicator string Entity EFT Indicator v1
v2
cageCode string CAGE Code
May be applicable to non-SAM registrants
v1
v2
dodaac string DoDAAC v1
v2
legalBusinessName string Legal Business Name
Applicable to non-SAM registrants.
v1
v2
dbaName string Doing Business As Name v1
v2
purposeOfRegistrationCode string Purpose of Registration Code v1
v2
purposeOfRegistrationDesc string Purpose of Registration Description v1
v2
registrationStatus string Registration Status v1
v2
registrationDate string Registration Date v1
v2
lastUpdateDate string Last Update Date v1
v2
expirationDate ->
registrationExpirationDate
string Registration Expiration Date
NOTE: This parameter is being renamed. expirationDate is in V1 and registrationExpirationDate will be V2.
v1
v2
activeDate string Active Date v1
v2
ueiStatus string Unique Entity Identifier Status
Applicable to non-SAM registrants.
v2
ueiExpirationDate string Unique Entity Identifier Expiration Date
Applicable to non-SAM registrants.
v2
ueiCreationDate string Unique Entity Identifier Creation Date
Applicable to non-SAM registrants.
v2
noPublicDisplayFlag string No Public Display Flag v1
v2
exclusionStatusFlag string Exclusion Status Flag v1
v2
exclusionURL string Active Exclusion URL v1
v2
dnbOpenData string Dun & Bradstreet Open Data
Applicable to non-SAM registrants.
v2
coreData Section
entityInformation Sub Section
Field Name Type Description Applicable Versions
entityURL string Entity URL v1
v2
entityDivisionName string Entity Division Name v1
v2
entityDivisionNumber string Entity Division Number v1
v2
entityStartDate string Entity Start Date v1
v2
fiscalYearEndCloseDate string Fiscal Year End Close Date v1
v2
submissionDate string Submission Date v1
v2
correspondenceFlag string Correspondence Flag v1
v2
physicalAddress, mailingAddress Sub Sections
Field Name Type Description Applicable Versions
addressLine1 string Physical Address Line 1 and Mailing Address Line 1.
Only Physical Address Line 1 is applicable to non-SAM registrants.
v1
v2
addressLine2 string Physical Address Line 2 and Mailing Address Line 2.
Only Physical Address Line 2 is applicable to non-SAM registrants.
v1
v2
city string Physical Address City and Mailing Address City.
Only Physical Address City is applicable to non-SAM registrants.
v1
v2
stateOrProvinceCode string Physical Address State or Province Code and Mailing Address State or Province Code.
Only Physical Address State or Province Code is applicable to non-SAM registrants.
v1
v2
zipCode string Physical Address Zip and Mailing Address Zip.
Only Physical Address Zip is applicable to non-SAM registrants.
v1
v2
zipCodePlus4 string Physical Address Zip Plus4 and Mailing Address Zip Plus4.
Only Physical Address Zip Plus4 is applicable to non-SAM registrants.
v1
v2
countryCode string Physical Address Country Code and Mailing Address Country Code.
Only Physical Address Country Code is applicable to non-SAM registrants.
v1
v2
Field Name Type Description Applicable Versions
congressionalDistrict string Physical Address Congressional District v1
v2
generalInformation Sub Section
Field Name Type Description Applicable Versions
entityStructureCode string Entity Structure Code v1
v2
entityStructureDesc string Entity Structure Description v1
v2
entityTypeCode string Entity Type Code v1
v2
entityTypeDesc string Entity Type Description v1
v2
profitStructureCode string Profit Structure Code v1
v2
profitStructureDesc string Profit Structure Description v1
v2
organizationStructureCode string Organization Structure Code v1
v2
organizationStructureDesc string Organization Structure Description v1
v2
stateOfIncorporationCode string State Of Incorporation Code v1
v2
stateOfIncorporationDesc string State Of Incorporation Description v1
v2
countryOfIncorporationCode string Country Of Incorporation Code v1
v2
countryOfIncorporationDesc string Country Of Incorporation Description v1
v2
businessTypes Sub Section
Field Name Type Description Applicable Versions
businessTypeList list businessTypeList contains these fields
Field Name Type Description
businessTypeCode string Business Type Code
businessTypeDesc string Business Type Description
v1
v2
sbaBusinessTypeList list sbaBusinessTypeList contains these fields
Field Name Type Description
sbaBusinessTypeCode string SBA Business Type Code
sbaBusinessTypeDesc string SBA Business Type Description
certificationEntryDate string Certification Entry Date
certificationExitDate string Certification Exit Date
v1
v2
Financial Information Sub Section
Field Name Type Description Applicable Versions
creditCardUsage string Credit Card Usage v1
v2
debtSubjectToOffset string Debt Subject to Offset Flag v1
v2
assertions Section
goodsAndServices Sub Section
Field Name Type Description Applicable Versions
primaryNaics string Primary NAICS v1
v2
naicsList list
naicsList contains these fields
Field Name Type Description
naicsCode string NAICS Code
naicsDescription string NAICS Description
sbaSmallBusiness string Whether or not the NAICS Code is indicated as an SBA small business
naicsException string Whether or not the NAICS Code is an exception
v1
v2
pscList List
pscList contains these fields
Field Name Type Description
pscCode string PSC Code
pscDescription string PSC Description
v1
v2
disasterReliefData Sub Section
Field Name Type Description Applicable Versions
disasterRegistryFlag string Disaster Registry Flag v1
v2
bondingFlag string Bonding Flag v1
v2
geographicalAreaServed list
geographicalAreaServed contains these fields
Field Name Type Description
geographicalAreaServedStateCode string State code
geographicalAreaServedStateName string State name
geographicalAreaServedCountyCode string County code
geographicalAreaServedCountyName string County name
geographicalAreaServedmetropolitanStatisticalAreaCode string Metropolitan Statistical Area Code
geographicalAreaServedmetropolitanStatisticalAreaName string Metropolitan Statistical Area Name
v1
v2
ediInformation Sub Section
Field Name Type Description Applicable Versions
ediInformationFlag string EDI Information Flag v1
v2
repsAndCerts Section
certifications Sub Section
Field Name Type Description Applicable Versions
fARResponses list
fARResponses contains below fields
Field Name Type Description
listOfProvisions list
listOfProvisions contains below fields
Field Name Type Description
provisionId string Provision Id
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
answerType string Answer Type
answerId string Answer ID
answerText string Answer Text
businessObjectType string Business Object Type
businessObjectId string Business Object ID
firstName string First Name
lastName string First Name
hasSizeProtest string Has Size Protest
title string Title
section string Section
organizationType string Organization Type
endProductName string End Product Name
endProductType string End Product Type
endProductCountry string End Product Country
placeOfManufacture string Place of Manufacture
fscCode string FSC Code
environmentURL string Environment URL
facilityStreetAddress1 string Facility Street Address1
facilityStreetAddress2 string Facility Street Address2
facilityCity string Facility City
facilityPostalCode string Facility Postal Code
facilityState string Facility State
facilityCountry string Facility Country
facilityOwner string Facility Owner
facilityOwner
StreetAddress1
string Facility Owner
Street Address1
facilityOwner
StreetAddress2
string Facility Owner
Street Address2
facilityOwnerCity string Facility Owner City
facilityOwnerPostalCode string Facility Owner Postal Code
facilityOwnerState string Facility Owner State
facilityOwnerCountry string Facility Owner Country
immediateOwner
LegalBusinessName
string Immediate Owner
Legal Business Name
immediateOwnerCageCode string Immediate Owner Cage Code
highestOwnerLegalBusinessName string Highest Owner Legal Business Name
highestOwnerCageCode string Highest Owner Cage Code
firstPredecessor
LegalBusinessName
string First Predecessor Legal
Business Name
secondPredecessorCageCode string Second Predecessor Cage Code
thirdPredecessorLegal
BusinessName
string Third Predecessor Legal
Business Name
thirdPredecessorCageCode string Third Predecessor Cage Code
primaryNaics string Primary Naics
naicsCode string Naics Code
sbaSmallBusiness string SBA Small Business
smallBusiness string Small Business
veteranOwnedSmallBusiness string Veteran Owned Small Business
serviceDisabledVet
OwnedSmallBusiness
string Service Disabled Veteran
Owned Small Business
womenOwned
SmallBusinessConcern
string Women Owned Small
Business Concern
womenOwnedSmallBusiness string Women Owned Small Business
economicallyDisadv
WomenOwnedSmallBusiness
string Economically Disadvantage
Women Owned Small Business
sbaCertifiedSmall
BusinessDisadvBusiness
string SBA Certified Small
Business Disadvantage Business
sbaCertifiedSmallBusinessDisadv
BusinessNotSubmitted
string SBA Certified Small Business Disadvantage
Business Not Submitted
hubZoneSmall
BusinessConcern
string Hub Zone Small
Business Concern
blackAmericanOwned string Black American
hispanicAmericanOwned string Hispanic American
nativeAmericanOwned string Native American
asianPacificAmericanOwned string Asian Pacific American
subcontinentAsian
IndianAmericanOwned
string Sub Continent
Asian Indian American
historicallyBlack
CollegeOrUniversity
string Historically Black
College Or University
minorityInstitution string Minority Institution
linkForFARReportPDF string Link For FAR Report PDF
linkForFARReportHTML string Link For FAR Report HTML
v1
v2
dFARResponses list
dFARResponses can contains below fields
Field Name Type Description
listOfProvisions list
List of Provisions contains below fields
Field Name Type Description
provisionId string Provision Id
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
answerType string Answer Type
answerId string Answer ID
answerText string Answer Text
businessObjectType string Business Object Type
businessObjectId string Business Object ID
section string Section
foreignGovernment
OwnershipFirstName
string Foreign Government Ownership
First Name
foreignGovernment
OwnershipMiddleInitial
string Foreign Government Ownership
Middle Initial
foreignGovernment
OwnershipLastName
string Foreign Government
Ownership Last Name
foreignGovernment
OwnershipLastName
string Foreign Government
Ownership Last Name
foreignGovernment
OwnershipPhoneNum
string Foreign Government
Ownership Phone Number
foreignGovernment
OwnershipPhoneExt
string Foreign Government
Ownership Phone Extension
foreignGovernment
OwnershipInternationalNum
string Foreign Government
Ownership International Number
foreignGovernment
ControlCountry
string Foreign Government
Control Country
foreignEndProductName string Foreign End Product Name
foreignEndProductCountry string Foreign End Product Country
linkForDFARSReportPDF string Link For DFARS Report PDF
linkForDFARSReportHTML string Link For DFARS Report HTML
v1
v2
qualifications Sub Section
Field Name Type Description Applicable Versions
architectEngineerResponses List
architectEngineerResponses contains below fields
Field Name Type Description
listOfProvisions list
listOfProvisions contains below fields
Field Name Type Description
provisionId string Provision Id
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
answerType string Answer Type
answerId string Answer Id
answerText string Answer Text
businessObjectType string Business Object Type
businessObjectId string Business Object Id
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
companyName string Company Name
companyEstablishedYear string Company Established Year
companyDUNS string Company DUNS
companyIsReference string Company Is Reference
firmNumOfEmployees string Number of Employees in the Firm
branchNumOfEmployees string Number of Employees in the Branch
experienceCode string Experience Code
annualAvgRevenueCode string Annual Average Revenue Code
federalRevenueCode string Federal Revenue Code
nonFedRevenueCode string Non-Federal Revenue Code
totalRevenueCode string Total Revenue Code
qualificationURLPDF string Qualification URL PDF
qualificationURLHTML string Qualification URL HTML
v1
v2
financialAssistanceCertifications Sub Section
Field Name Type Description Applicable Versions
financialAssistanceResponse string Financial Assistance Response v1
v2
pointsOfContact Section
governmentBusinessPOC Sub section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
electronicBusinessPOC Sub section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
governmentBusinessAlternatePOC Sub section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
electronicBusinessAlternatePOC Sub Section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
pastPerformancePOC Sub Section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
pastPerformanceAlternatePOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2

FOUO API Information

Query String Parameters
Parameter Name Description Applicable Versions
samRegistered Allows Y or N or ALL.
Example: samRegistered=Y
NOTE: If not used the API will return SAM registrants only by default.
Applicable to non-SAM registrants.
v2
activationDate Allows a single Date or a 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
cageCode Allows exact 5 character value.
Example: cageCode=00000
May be applicable to non-SAM registrants.
v1
v2
dbaName Allows Partial or Complete value.
Example: dbaName=ALLTEL
v1
v2
debtSubjectToOffset Allows Y or N or null.
Example: debtSubjectToOffset=Y
v1
v2
dodaac Allows 9 character value.
Example: dodaac=DOD123456
v1
v2
ueiDUNS Unique Entity Identifier DUNS -Allows 9 digit value, a maximum of up to 100 values can be sent.
Example: ueiDUNS=025114695
Applicable to non-SAM registrants.
v1
v2
ueiSAM Unique Entity Identifier SAM - Allow 12 digit value, alphanumeric (ueiSAM values not yet available for search).
Example: ueiSAM=025114695AST
Applicable to non-SAM registrants.
v1
v2
entityStructureCode Allows 2 character code or null.
Example: entityStructureCode=Z1
v1
v2
entityStructureDesc Allows Description or null.
Example: entityStructureDesc=Partnership or Limited Liability Partnership
v1
v2
exclusionStatusFlag Allows D or null.
Example: exclusionStatusFlag=D
v1
v2
expirationDate -->
registrationExpirationDate
Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: registrationExpirationDate=01/01/2019, registrationExpirationDate=[01/01/2019,05/29/2019]
NOTE: This parameter is being renamed. expirationDate is in V1 and registrationExpirationDate will be V2.
v1
v2
legalBusinessName Allows Partial or Complete value.
Example: legalBusinessName=ALLTEL
Applicable to non-SAM registrants.
v1
v2
primaryNaics Allows 6 digit NAICS, accepts multiple NAICS.
Example: primaryNaics=513310
v1
v2
purposeOfRegistrationCode Allows 2 character code.
Example: purposeOfRegistrationCode=Z2
v1
v2
purposeOfRegistrationDesc Allows a text.
Example: purposeOfRegistrationDesc=All Awards
v1
v2
registrationDate Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: registrationDate=01/01/2019, registrationDate=[01/01/2019,05/29/2019]
v1
v2
ueiCreationDate Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: ueiCreationDate=01/01/2019, ueiCreationDate=[01/01/2019,05/29/2019]
Applicable to non-SAM registrants.
v2
updateDate Allows a single Date or a 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
physicalAddressCity Allows a text.
Example: physicalAddressCity=Herndon
Applicable to non-SAM registrants.
v1
v2
physicalAddressCongressionalDistrict Allows 2 characters.
Example: physicalAddressCongressionalDistrict=AR
Applicable to non-SAM registrants.
v1
v2
physicalAddressCountryCode Allows 3 character code.
Example: physicalAddressCountryCode=USA
Applicable to non-SAM registrants.
v1
v2
physicalAddressProvinceOrState Allows 2 character code.
Example: physicalAddressProvinceOrState=AR
Applicable to non-SAM registrants.
v1
v2
physicalAddressZipPostalCode Allows 5 digit zip code.
Example: physicalAddressZipPostalCode=02201
Applicable to non-SAM registrants.
v1
v2
samExtractCode Allows 1 character code (A or E).
Example: samExtractCode=A
v1
v2
businessTypeCode Allows 2 character code.
Example: businessTypeCode=2L
v1
v2
businessTypeDesc Allows a text.
Example: businessTypeDesc=Woman Owned Business
v1
v2
organizationStructureCode Allows 2 character code.
Example: organizationStructureCode=2L
v1
v2
organizationStructureDesc Allows 2 character code.
Example: organizationStructureDesc=Limited Liability Company
v1
v2
stateOfIncorporationCode Allows 2 character code.
Example: stateOfIncorporationCode=VA
v1
v2
stateOfIncorporationDesc Allows a text.
Example: stateOfIncorporationDesc=Virginia
v1
v2
countryOfIncorporationCode Allows 3 character code.
Example: countryOfIncorporationCode=USA
v1
v2
countryOfIncorporationDesc Allows a text.
Example: countryOfIncorporationDesc=United States Of America
v1
v2
naicsCode Allows 6 character code.
Example: naicsCode=513310
v1
v2
naicsDesc Allows a text.
Example: naicsDesc=Furniture Stores
v1
v2
naicsLimitedSB Allows 6 character code.
Example: naicsLimitedSB=513310
v1
v2
pscCode Allows 4 character code.
Example: pscCode=0989
v1
v2
pscDesc Allows a text.
Example: pscDesc=Screws
v1
v2
servedDisasterStateCode Allows 2 character code.
Example: servedDisasterStateCode=VA
v1
v2
servedDisasterStateName Allows Name or null.
Example: servedDisasterStateName=Virginia
v1
v2
servedDisasterCountyCode Allows text.
Example: servedDisasterCountyCode=12334
v1
v2
servedDisasterCountyName Allows a text.
Example: servedDisasterCountyName=FAIRFAX
v1
v2
servedDisasterMSA Allows text.
Example: servedDisasterMSA=86800730
v1
v2
includeSections Allows to filter data by sections, entityRegistration, coreData, assertions, repsAndCerts and pointsOfContact.
Example: includeSections=entityRegistration,coreData
Applicable to non-SAM registrants but only the sections entityRegistration and coreData are applicable.
v1
v2
format Allows user to download different file formats(csv and json are allowable values).
Example: format=csv<
Applicable to non-SAM registrants.
v1
v2
emailId Allows user to get file download links to email. Email Id should be provided in conjunction with format.
Example: emailId=test@gsa.gov
Applicable to non-SAM registrants.
v1
v2
edi Allows text.
Example: edi=YES/NO
v1
v2
companySecurityLevelCode Allows 2 character code.
Example: companySecurityLevelCode=92
v1
v2
highestEmployeeSecurityLevelCode Allows 2 character code .
Example: highestEmployeeSecurityLevelCode=90
v1
v2
ultimateParentUEIDUNS Allows text.
Example: ultimateParentUEIDUNS=090123451
v1
v2
ultimateParentUEISAM Allows text.
Example: ultimateParentUEISAM=090123451
v1
v2
agencyBusinessPurposeCode Allows text, Determines Agency Business Purpose Code.
Example: agencyBusinessPurposeCode=1
v1
v2
sensitivity Allows a text, Determines Sensitivity Level of Data.
Example: sensitivity=public
v1
v2
Expected Result: There are a few placeholder elements that return ‘Currently Not Available’ until they are made available in the database.
entityRegistration Section
Field Name Type Description Applicable Versions
samRegistered string SAM Registered Entity
Applicable to non-SAM registrants.
v2
ueiSAM string Unique Entity Identifier SAM
Applicable to non-SAM registrants.
v1
v2
ueiDUNS string Unique Entity Identifier DUNS
Applicable to non-SAM registrants.
v1
v2
entityEFTIndicator string Entity EFT Indicator v1
v2
cageCode string CAGE Code
May be applicable to non-SAM registrants.
v1
v2
dodaac string DoDAAC v1
v2
legalBusinessName string Legal Business Name
Applicable to non-SAM registrants.
v1
v2
dbaName string Doing Business As Name v1
v2
purposeOfRegistrationCode string Purpose of Registration Code v1
v2
purposeOfRegistrationDesc string Purpose of Registration Description v1
v2
registrationStatus string Registration Status v1
v2
registrationDate string Registration Date v1
v2
lastUpdateDate string Last Update Date v1
v2
expirationDate ->
registrationExpirationDate
string Registration Expiration Date
NOTE: This parameter is being renamed. expirationDate is in V1 and registrationExpirationDate will be V2.
v1
v2
activeDate string Active Date v1
v2
ueiStatus string Unique Entity Identifier Status
Applicable to non-SAM registrants.
v2
ueiExpirationDate string Unique Entity Identifier Expiration Date
Applicable to non-SAM registrants.
v2
ueiCreationDate string Unique Entity Identifier Creation Date
Applicable to non-SAM registrants.
v2
noPublicDisplayFlag string No Public Display Flag v1
v2
exclusionStatusFlag string Exclusion Status Flag v1
v2
exclusionURL string Active Exclusion URL v1
v2
dnbOpenData string Dun & Bradstreet Open Data
Applicable to non-SAM registrants.
v2
core Data Section
entityHierarchyInformation Sub Section
Field Name Type Description
immediateParentEntity object
immediateParentEntity contains below fields
Field Name Type Description Applicable Versions
ueiSAM string Unique Entity Identifier SAM v1
v2
ueiDUNS string Unique Entity Identifier DUNS v1
v2
legalBusinessName string Legal Business Name v1
v2
physicalAddress object
physicalAddress contains below fields
Field Name Type Description
addressLine1 string Physical Address Line 1
addressLine2 string Physical Address Line 2
city string Physical Address City
stateOrProvinceCode string Physical Address State or Province Code
zipCode string Physical Address Zip
zipCodePlus4 string Physical Address Zip Plus4
countryCode string Physical Address Country
v1
v2
phoneNumber string Phone Number v1
v2
intermediateParentEntities List
intermediateParentEntities contains below fields
Field Name Type Description Applicable Versions
domesticParent object
domesticParent contains below fields
Field Name Type Description
ueiSAM string Unique Entity Identifier SAM
ueiDUNS string Unique Entity Identifier DUNS
legalBusinessName string Legal Business Name
physicalAddress object
physicalAddress contains below fields
Field Name Type Description
addressLine1 string Physical Address Line 1
addressLine2 string Physical Address Line 2
city string Physical Address City
stateOrProvinceCode string Physical Address State or Province Code
zipCode string Physical Address Zip
zipCodePlus4 string Physical Address Zip Plus4
countryCode string Physical Address Country
phoneNumber string Phone Number
v1
v2
hqParent object
hqParent contains below fields
Field Name Type Description
ueiSAM string Unique Entity Identifier SAM
ueiDUNS string Unique Entity Identifier DUNS
legalBusinessName string Legal Business Name
physicalAddress object
physicalAddress contains below fields
Field Name Type Description
addressLine1 string Physical Address Line 1
addressLine2 string Physical Address Line 2
city string Physical Address City
stateOrProvinceCode string Physical Address State or Province Code
zipCode string Physical Address Zip
zipCodePlus4 string Physical Address Zip Plus4
countryCode string Physical Address Country
phoneNumber string Phone Number
v1
v2
ultimateParentEntity object
ultimateParentEntity contains below fields
Field Name Type Description Applicable Versions
ueiSAM string Unique Entity Identifier SAM v1
v2
ueiDUNS string Unique Entity Identifier DUNS v1
v2
legalBusinessName string Legal Business Name v1
v2
physicalAddress object
physicalAddress contains below fields
Field Name Type Description
addressLine1 string Physical Address Line 1
addressLine2 string Physical Address Line 2
city string Physical Address City
stateOrProvinceCode string Physical Address State or Province Code
zipCode string Physical Address Zip
zipCodePlus4 string Physical Address Zip Plus4
countryCode string Physical Address Country
v1
v2
phoneNumber string Phone Number v1
v2
evsMonitoring object
evsMonitoring contains below fields
Field Name Type Description Applicable Versions
dnbMonitoring object
dnbMonitoring contains below fields
Field Name Type Description
legalBusinessName string Legal Business Name
dbaName string DBA Name
outOfBusinessFlag string Out Of Business Flag
monitoringStatus string Monitoring Status
lastUpdated string Last Updated
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
postalCode string Postal Code
stateOrProvinceCode string State or Province Code
countryCode string Country Code
v1
samMonitoring object
samMonitoring contains below fields
Field Name Type Description
legalBusinessName string Legal Business Name
dbaName string DBA Name
outOfBusinessFlag string Out Of Business Flag
monitoringStatus string Monitoring Status
lastUpdated string Last Updated
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
postalCode string Postal Code
stateOrProvinceCode string State or Province Code
countryCode string Country Code
v1
legalBusinessName string Legal Business Name v2
dbaName string DBA Name v2
outOfBusinessFlag string Out Of Business Flag v2
lastUpdated string Last Updated v2
addressLine1 string Address Line 1 v2
addressLine2 string Address Line 2 v2
city string City v2
postalCode string Postal Code v2
stateOrProvinceCode string State or Province Code v2
countryCode string Country Code v2
federalHierarchy Sub Section
Field Name Type Description Applicable Versions
source string Source v1
v2
hierarchyDepartmentCode string Hierarchy Department Code v1
v2
hierarchyDepartmentName string Hierarchy Department Name v1
v2
hierarchyAgencyCode string Hierarchy Agency Code v1
v2
hierarchyAgencyName string Hierarchy Agency Name v1
v2
hierarchyOfficeCode string Hierarchy Office Code v1
v2
entityInformation Sub Section
Field Name Type Description Applicable Versions
entityURL string Entity URL v1
v2
entityDivisionName string Entity Division Name v1
v2
entityDivisionNumber string Entity Division Number v1
v2
entityStartDate string Entity Start Date v1
v2
fiscalYearEndCloseDate string Fiscal Year End Close Date v1
v2
submissionDate string Submission Date v1
v2
correspondenceFlag string Correspondence Flag v1
v2
physicalAddress, mailingAddress Sub Sections
Field Name Type Description Applicable Versions
addressLine1 string Physical Address Line 1 and Mailing Address Line 1.
Only Physical Address Line 1 is applicable to non-SAM registrants.
v1
v2
addressLine2 string Physical Address Line 2 and Mailing Address Line 2.
Only Physical Address Line 2 is applicable to non-SAM registrants.
v1
v2
city string Physical Address City and Mailing Address City.
Only Physical Address City is applicable to non-SAM registrants.
v1
v2
stateOrProvinceCode string Physical Address State or Province Code and Mailing Address State or Province Code.
Only Physical Address State or Province Code is applicable to non-SAM registrants.
v1
v2
zipCode string Physical Address Zip and Mailing Address Zip.
Only Physical Address Zip is applicable to non-SAM registrants.
v1
v2
zipCodePlus4 string Physical Address Zip Plus4 and Mailing Address Zip Plus4.
Only Physical Address Zip Plus4 is applicable to non-SAM registrants.
v1
v2
countryCode string Physical Address Country Code and Mailing Address Country Code.
Only Physical Address Country Code is applicable to non-SAM registrants.
v1
v2
Field Name Type Description Applicable Versions
congressionalDistrict string Physical Address Congressional District v1
v2
generalInformation Sub Section
Field Name Type Description Applicable Versions
agencyBusinessPurposeCode string Agency Business Purpose Code v1
v2
agencyBusinessPurposeDesc string Agency Business Purpose Desc v1
v2
entityStructureCode string Entity Structure Code v1
v2
entityStructureDescription string Entity Structure Description v1
v2
entityTypeCode string Entity Type Code v1
v2
entityTypeDesc string Entity Type Description v1
v2
profitStructureCode string Profit Structure Code v1
v2
profitStructureDesc string Profit Structure Description v1
v2
organizationStructureCode string Organization Structure Code v1
v2
organizationStructureDesc string Organization Structure Description v1
v2
stateOfIncorporationCode string State Of Incorporation Code v1
v2
stateOfIncorporationDesc string State Of Incorporation Description v1
v2
countryOfIncorporationCode string Country Of IncorporationCode v1
v2
countryOfIncorporationDesc string Country Of IncorporationDescription v1
v2
companySecurityLevelCode string Company Security Level Code v1
v2
companySecurityLevelDesc string Company Security Level Description v1
v2
highestEmployeeSecurityLevelCode string Highest Employee Security Level Code v1
v2
highestEmployeeSecurityLevelDesc string Highest Employee Security Level Description v1
v2
businessTypes Sub Section
Field Name Type Description Applicable Versions
businessTypeList list businessTypeList contains these fields
Field Name Type Description
businessTypeCode string Business Type Code
businessTypeDescription string Business Type Description
v1
v2
sbaBusinessTypeList list sbaBusinessTypeList contains these fields
Field Name Type Description
sbaBusinessTypeCode string SBA Business Type Code
sbaBusinessTypeDesc string SBA Business Type Description
certificationEntryDate string Certification Entry Date
certificationExitDate string Certification Exit Date
v1
v2
Financial Information Sub Section
Field Name Type Description Applicable Versions
creditCardUsage string Credit Card Usage v1
v2
debtSubjectToOffset string Debt Subject to Offset Flag v1
v2
assertions Section
goodsAndServices Sub Section
Field Name Type Description Applicable Versions
primaryNaics string Primary NAICS v1
v2
naicsList list
naicsList contains these fields
Field Name Type Description
naicsCode string NAICS Code
naicsDesc string NAICS Description
sbaSmallBusiness string Whether or not the NAICS Code is indicated as an SBA small business
naicsException string Whether or not the NAICS Code is an exception
v1
v2
pscList List
pscList contains these fields
Field Name Type Description
pscCode string PSC Code
pscDescription string PSC Description
v1
v2
disasterReliefData Sub Section
Field Name Type Description Applicable Versions
disasterRegistryFlag string Disaster Registry Flag v1
v2
bondingFlag string Bonding Flag v1
v2
bondingLevels list
Bonding Levels contains these fields
Field Name Type Description
type string Type of bonding level
value string Value of bonding level
v1
v2
geographicalAreaServed list
geographicalAreaServed contains these fields
Field Name Type Description
geographicalAreaServedStateCode string State code
geographicalAreaServedStateName string State name
geographicalAreaServedCountyCode string County Code
geographicalAreaServedCountyName string County name
geographicalAreaServedmetropolitanStatisticalAreaCode string Metropolitan Statistical Area Code
geographicalAreaServedmetropolitanStatisticalAreaName string Metropolitan Statistical Area Name
v1
v2
sizeMetrics Sub Section
Field Name Type Description Applicable Versions
averageAnnualRevenue string Average Annual Revenue v1
v2
averageNumberOfEmployees string Average Number Of Employees v1
v2
sizeMetricDetails Sub Section
Field Name Type Description Applicable Versions
employeesLocation string Employees Location v1
v2
receiptsLocation string Receipts Location v1
v2
industrySpecificSizeMetrics Sub Section
Field Name Type Description Applicable Versions
barrelsCapacity string Barrels Capacity v1
v2
totalAssets string Total Assets v1
v2
megawattHours string Mega Watt Hours v1
v2
ediInformation Sub Section
Field Name Type Description Applicable Versions
ediInformationFlag string EDI Information Flag v1
v2
vanProvider string Van Provider v1
v2
isaQualifier string ISA Qualifier v1
v2
isaIdentifier string ISA Identifier v1
v2
functionalGroupIdentifier string Functional Group Identifier v1
v2
requestFlag820s string Request Flag 820s v1
v2
repsAndCerts Section
certifications Sub Section
Field Name Type Description Applicable Versions
fARResponses list
fARResponses contains below fields
Field Name Type Description
listOfProvisions list
listOfProvisions contains below fields
Field Name Type Description
provisionId string Provision Id
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
answerType string Answer Type
answerId string Answer ID
answerText string Answer Text
businessObjectType string Business Object Type
businessObjectId string Business Object ID
firstName string First Name
lastName string First Name
hasSizeProtest string Has Size Protest
title string Title
section string Section
organizationType string Organization Type
endProductName string End Product Name
endProductType string End Product Type
endProductCountry string End Product Country
placeOfManufacture string Place of Manufacture
fscCode string FSC Code
environmentURL string Environment URL
facilityStreetAddress1 string Facility Street Address1
facilityStreetAddress2 string Facility Street Address2
facilityCity string Facility City
facilityPostalCode string Facility Postal Code
facilityState string Facility State
facilityCountry string Facility Country
facilityOwner string Facility Owner
facilityOwner
StreetAddress1
string Facility Owner
Street Address1
facilityOwner
StreetAddress2
string Facility Owner
Street Address2
facilityOwnerCity string Facility Owner City
facilityOwnerPostalCode string Facility Owner Postal Code
facilityOwnerState string Facility Owner State
facilityOwnerCountry string Facility Owner Country
immediateOwner
LegalBusinessName
string Immediate Owner
Legal Business Name
immediateOwnerCageCode string Immediate Owner Cage Code
highestOwnerLegalBusinessName string Highest Owner Legal Business Name
highestOwnerCageCode string Highest Owner Cage Code
firstPredecessor
LegalBusinessName
string First Predecessor Legal
Business Name
secondPredecessorCageCode string Second Predecessor Cage Code
thirdPredecessorLegal
BusinessName
string Third Predecessor Legal
Business Name
thirdPredecessorCageCode string Third Predecessor Cage Code
primaryNaics string Primary Naics
naicsCode string Naics Code
sbaSmallBusiness string SBA Small Business
smallBusiness string Small Business
veteranOwnedSmallBusiness string Veteran Owned Small Business
serviceDisabledVet
OwnedSmallBusiness
string Service Disabled Veteran
Owned Small Business
womenOwned
SmallBusinessConcern
string Women Owned Small
Business Concern
womenOwnedSmallBusiness string Women Owned Small Business
economicallyDisadv
WomenOwnedSmallBusiness
string Economically Disadvantage
Women Owned Small Business
sbaCertifiedSmall
BusinessDisadvBusiness
string SBA Certified Small
Business Disadvantage Business
sbaCertifiedSmallBusinessDisadv
BusinessNotSubmitted
string SBA Certified Small Business Disadvantage
Business Not Submitted
hubZoneSmall
BusinessConcern
string Hub Zone Small
Business Concern
blackAmericanOwned string Black American
hispanicAmericanOwned string Hispanic American
nativeAmericanOwned string Native American
asianPacificAmericanOwned string Asian Pacific American
subcontinentAsian
IndianAmericanOwned
string Sub Continent
Asian Indian American
historicallyBlack
CollegeOrUniversity
string Historically Black
College Or University
minorityInstitution string Minority Institution
linkForFARReportPDF string Link For FAR Report PDF
linkForFARReportHTML string Link For FAR Report HTML
v1
v2
dFARResponses list
dFARResponses contains below fields
Field Name Type Description
listOfProvisions list
listOfProvisions contains below fields
Field Name Type Description
provisionId string Provision Id
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
answerType string Answer Type
answerId string Answer ID
answerText string Answer Text
businessObjectType string Business Object Type
businessObjectId string Business Object ID
section string Section
foreignGovernment
OwnershipFirstName
string Foreign Government Ownership
First Name
foreignGovernment
OwnershipMiddleInitial
string Foreign Government Ownership
Middle Initial
foreignGovernment
OwnershipLastName
string Foreign Government
Ownership Last Name
foreignGovernment
OwnershipLastName
string Foreign Government
Ownership Last Name
foreignGovernment
OwnershipPhoneNum
string Foreign Government
Ownership Phone Number
foreignGovernment
OwnershipPhoneExt
string Foreign Government
Ownership Phone Extension
foreignGovernment
OwnershipInternationalNum
string Foreign Government
Ownership International Number
foreignGovernment
ControlCountry
string Foreign Government
Control Country
foreignEndProductName string Foreign End Product Name
foreignEndProductCountry string Foreign End Product Country
linkForDFARSReportPDF string Link For DFARS Report PDF
linkForDFARSReportHTML string Link For DFARS Report HTML
v1
v2
qualifications Sub Section
Field Name Type Description Applicable Versions
architectEngineerResponses List
architectEngineerResponses contains below fields
Field Name Type Description
listOfProvisions list
listOfProvisions contains below fields
Field Name Type Description
provisionId string Provision Id
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
answerType string Answer Type
answerId string Answer Id
answerText string Answer Text
businessObjectType string Business Object Type
businessObjectId string Business Object Id
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
companyName string Company Name
companyEstablishedYear string Company Established Year
companyDUNS string Company DUNS
companyIsReference string Company Is Reference
firmNumOfEmployees string Number of Employees in the Firm
branchNumOfEmployees string Number of Employees in the Branch
experienceCode string Experience Code
annualAvgRevenueCode string Annual Average Revenue Code
federalRevenueCode string Federal Revenue Code
nonFedRevenueCode string Non-Federal Revenue Code
totalRevenueCode string Total Revenue Code
qualificationURLPDF string Qualification URL PDF
qualificationURLHTML string Qualification URL HTML
v1
v2
financialAssistanceCertifications Sub Section
Field Name Type Description Applicable Versions
financialAssistanceResponse string Financial Assistance Response v1
v2
pointsOfContact Section
governmentBusinessPOC Sub section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
electronicBusinessPOC Sub section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
governmentBusinessAlternatePOC Sub section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
electronicBusinessAlternatePOC Sub Section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
pastPerformancePOC Sub Section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
pastPerformanceAlternatePOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
partyPerformingCertificationPOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
soleProprietorshipPOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
accountsReceivablePOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
accountsPayablePOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
ediPOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
eliminationsPOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
salesPOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2

Sensitive API Information

Query String Parameters
Parameter Name Description Applicable Versions
samRegistered Allows Y or N or ALL.
Example: samRegistered=Y
NOTE: If not used the API will return SAM registrants only by default.
Applicable to non-SAM registrants.
v2
activationDate Allows a single Date or a 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
cageCode Allows exact 5 character value.
Example: cageCode=00000
May be applicable to non-SAM registrants.
v1
v2
dbaName Allows Partial or Complete value.
Example: dbaName=ALLTEL
v1
v2
debtSubjectToOffset Allows Y or N or null.
Example: debtSubjectToOffset=Y
v1
v2
dodaac Allows 9 character value.
Example: dodaac=DOD123456
v1
v2
ueiDUNS Unique Entity Identifier DUNS -Allows 9 digit value, a maximum of up to 100 values can be sent.
Example: ueiDUNS=025114695
Applicable to non-SAM registrants.
v1
v2
ueiSAM Unique Entity Identifier SAM - Allow 12 digit value, alphanumeric (ueiSAM values not yet available for search).
Example: ueiSAM=025114695AST
Applicable to non-SAM registrants.
v1
v2
entityStructureCode Allows 2 character code or null.
Example: entityStructureCode=Z1
v1
v2
entityStructureDesc Allows Description or null.
Example: entityStructureDesc=Partnership or Limited Liability Partnership
v1
v2
exclusionStatusFlag Allows D or null.
Example: exclusionStatusFlag=D
v1
v2
expirationDate -->
registrationExpirationDate
Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: registrationExpirationDate=01/01/2019, registrationExpirationDate=[01/01/2019,05/29/2019]
NOTE: This parameter is being renamed. expirationDate is in V1 and registrationExpirationDate will be V2.
v1
v2
legalBusinessName Allows Partial or Complete value.
Example: legalBusinessName=ALLTEL
Applicable to non-SAM registrants.
v1
v2
primaryNaics Allows 6 digit NAICS, accepts multiple NAICS.
Example: primaryNaics=513310
v1
v2
purposeOfRegistrationCode Allows 2 character code.
Example: purposeOfRegistrationCode=Z2
v1
v2
purposeOfRegistrationDesc Allows a text.
Example: purposeOfRegistrationDesc=All Awards
v1
v2
registrationDate Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: registrationDate=01/01/2019, registrationDate=[01/01/2019,05/29/2019]
v1
v2
ueiCreationDate Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: ueiCreationDate=01/01/2019, ueiCreationDate=[01/01/2019,05/29/2019]
Applicable to non-SAM registrants.
v2
updateDate Allows a single Date or a 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
physicalAddressCity Allows a text.
Example: physicalAddressCity=Herndon
Applicable to non-SAM registrants.
v1
v2
physicalAddressCongressionalDistrict Allows 2 characters.
Example: physicalAddressCongressionalDistrict=AR
Applicable to non-SAM registrants.
v1
v2
physicalAddressCountryCode Allows 3 character code.
Example: physicalAddressCountryCode=USA
Applicable to non-SAM registrants.
v1
v2
physicalAddressProvinceOrState Allows 2 character code.
Example: physicalAddressProvinceOrState=AR
Applicable to non-SAM registrants.
v1
v2
physicalAddressZipPostalCode Allows 5 digit zip code.
Example: physicalAddressZipPostalCode=02201
Applicable to non-SAM registrants.
v1
v2
samExtractCode Allows 1 character code (A or E).
Example: samExtractCode=A
v1
v2
businessTypeCode Allows 2 character code.
Example: businessTypeCode=2L
v1
v2
businessTypeDesc Allows a text.
Example: businessTypeDesc=Woman Owned Business
v1
v2
organizationStructureCode Allows 2 character code.
Example: organizationStructureCode=2L
v1
v2
organizationStructureDesc Allows 2 character code.
Example: organizationStructureDesc=Limited Liability Company
v1
v2
stateOfIncorporationCode Allows 2 character code.
Example: stateOfIncorporationCode=VA
v1
v2
stateOfIncorporationDesc Allows a text.
Example: stateOfIncorporationDesc=Virginia
v1
v2
countryOfIncorporationCode Allows 3 character code.
Example: countryOfIncorporationCode=USA
v1
v2
countryOfIncorporationDesc Allows a text.
Example: countryOfIncorporationDesc=United States Of America
v1
v2
naicsCode Allows 6 character code.
Example: naicsCode=513310
v1
v2
naicsDesc Allows a text.
Example: naicsDesc=Furniture Stores
v1
v2
naicsLimitedSB Allows 6 character code.
Example: naicsLimitedSB=513310
v1
v2
pscCode Allows 4 character code.
Example: pscCode=0989
v1
v2
pscDesc Allows a text.
Example: pscDesc=Screws
v1
v2
servedDisasterStateCode Allows 2 character code.
Example: servedDisasterStateCode=VA
v1
v2
servedDisasterStateName Allows Name or null.
Example: servedDisasterStateName=Virginia
v1
v2
servedDisasterCountyCode Allows text.
Example: servedDisasterCountyCode=12334
v1
v2
servedDisasterCountyName Allows a text.
Example: servedDisasterCountyName=FAIRFAX
v1
v2
servedDisasterMSA Allows text.
Example: servedDisasterMSA=86800730
v1
v2
includeSections Allows to filter data by sections, entityRegistration, coreData, assertions, repsAndCerts and pointsOfContact.
Example: includeSections=entityRegistration,coreData
Applicable to non-SAM registrants but only the sections entityRegistration and coreData are applicable.
v1
v2
format Allows user to download different file formats(csv and json are allowable values).
Example: format=csv<
Applicable to non-SAM registrants.
v1
v2
emailId Allows user to get file download links to email. Email Id should be provided in conjunction with format.
Example: emailId=test@gsa.gov
Applicable to non-SAM registrants.
v1
v2
edi Allows text.
Example: edi=YES/NO
v1
v2
companySecurityLevelCode Allows 2 character code.
Example: companySecurityLevelCode=92
v1
v2
highestEmployeeSecurityLevelCode Allows 2 character code .
Example: highestEmployeeSecurityLevelCode=90
v1
v2
ultimateParentUEIDUNS Allows text.
Example: ultimateParentUEIDUNS=090123451
v1
v2
ultimateParentUEISAM Allows text.
Example: ultimateParentUEISAM=090123451
v1
v2
agencyBusinessPurposeCode Allows text, Determines Agency Business Purpose Code.
Example: agencyBusinessPurposeCode=1
v1
v2
routingNumber Allows a text.
Example: routingNumber=0123456
v1
v2
bankName Allows a text.
Example: bankName=TEST
v1
v2
accountNumber Allows a text.
Example: accountNumber=012323456
v1
v2
eftWaiverFlag Allows a text.
Example: eftWaiverFlag=Y
v1
v2
agencyLocationCode Allows a text.
Example: agencyLocationCode=1
v1
v2
disbursingOfficeSymbol Allows a text.
Example: disbursingOfficeSymbol=1093
v1
v2
taxpayerName Allows a text.
Example: taxpayerName=test
v1
v2
taxpayerIdentificationNumber Allows a text.
Example: taxpayerIdentificationNumber=01234
v1
v2
sensitivity Allows a text, Determines Sensitivity Level of Data.
Example: sensitivity=public
v1
v2
Expected Result: There are a few placeholder elements that return ‘Currently Not Available’ until they are made available in the database.
entityRegistration Section
Field Name Type Description Applicable Versions
samRegistered string SAM Registered Entity
Applicable to non-SAM registrants.
v2
ueiSAM string Unique Entity Identifier SAM
Applicable to non-SAM registrants.
v1
v2
ueiDUNS string Unique Entity Identifier DUNS
Applicable to non-SAM registrants.
v1
v2
entityEFTIndicator string Entity EFT Indicator v1
v2
cageCode string CAGE Code
May be applicable to non-SAM registrants.
v1
v2
dodaac string DoDAAC v1
v2
legalBusinessName string Legal Business Name
Applicable to non-SAM registrants.
v1
v2
dbaName string Doing Business As Name v1
v2
purposeOfRegistrationCode string Purpose of Registration Code v1
v2
purposeOfRegistrationDesc string Purpose of Registration Description v1
v2
registrationStatus string Registration Status v1
v2
registrationDate string Registration Date v1
v2
lastUpdateDate string Last Update Date v1
v2
expirationDate ->
registrationExpirationDate
string Registration Expiration Date
NOTE: This parameter is being renamed. expirationDate is in V1 and registrationExpirationDate will be V2.
v1
v2
activeDate string Active Date v1
v2
ueiStatus string Unique Entity Identifier Status
Applicable to non-SAM registrants.
v2
ueiExpirationDate string Unique Entity Identifier Expiration Date
Applicable to non-SAM registrants.
v2
ueiCreationDate string Unique Entity Identifier Creation Date
Applicable to non-SAM registrants.
v2
noPublicDisplayFlag string No Public Display Flag v1
v2
exclusionStatusFlag string Exclusion Status Flag v1
v2
exclusionURL string Active Exclusion URL v1
v2
dnbOpenData string Dun & Bradstreet Open Data
Applicable to non-SAM registrants.
v2
core Data Section
entityHierarchyInformation
Field Name Type Description
immediateParentEntity object
immediateParentEntity contains below fields
Field Name Type Description Applicable Versions
ueiSAM string Unique Entity Identifier SAM v1
v2
ueiDUNS string Unique Entity Identifier DUNS v1
v2
legalBusinessName string Legal Business Name v1
v2
physicalAddress object
physicalAddress contains below fields
Field Name Type Description
addressLine1 string Physical Address Line 1
addressLine2 string Physical Address Line 2
city string Physical Address City
stateOrProvinceCode string Physical Address State or Province
zipCode string Physical Address Zip
zipCodePlus4 string Physical Address Zip Plus4
countryCode string Physical Address Country
v1
v2
phoneNumber string Phone Number v1
v2
intermediateParentEntities object
ultimateDomesticParent contains below fields
Field Name Type Description Applicable Versions
ueiSAM string Unique Entity Identifier SAM v1
v2
ueiDUNS string Unique Entity Identifier DUNS v1
v2
legalBusinessName string Legal Business Name v1
v2
physicalAddress object
physicalAddress contains below fields
Field Name Type Description
addressLine1 string Physical Address Line 1
addressLine2 string Physical Address Line 2
city string Physical Address City
stateOrProvinceCode string Physical Address State or Province
zipCode string Physical Address Zip
zipCodePlus4 string Physical Address Zip Plus4
countryCode string Physical Address Country
v1
v2
phoneNumber string Phone Number v1
v2
ultimateParentEntity object
ultimateParentEntity contains below fields
Field Name Type Description Applicable Versions
ueiSAM string Unique Entity Identifier SAM v1
v2
ueiDUNS string Unique Entity Identifier DUNS v1
v2
legalBusinessName string Legal Business Name v1
v2
physicalAddress object
physicalAddress contains below fields
Field Name Type Description
addressLine1 string Physical Address Line 1
addressLine2 string Physical Address Line 2
city string Physical Address City
stateOrProvinceCode string Physical Address State or Province
zipCode string Physical Address Zip
zipCodePlus4 string Physical Address Zip Plus4
countryCode string Physical Address Country
v1
v2
phoneNumber string Phone Number v1
v2
evsMonitoring object
evsMonitoring contains below fields
Field Name Type Description Applicable Versions
dnbMonitoring object
dnbMonitoring contains below fields
Field Name Type Description
legalBusinessName string Legal Business Name
dbaName string DBA Name
outOfBusinessFlag string Out Of Business Flag
monitoringStatus string Monitoring Status
lastUpdated string Last Updated
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
postalCode string Postal Code
stateOrProvinceCode string State or Province Code
countryCode string Country Code
v1
samMonitoring object
samMonitoring contains below fields
Field Name Type Description
legalBusinessName string Legal Business Name
dbaName string DBA Name
outOfBusinessFlag string Out Of Business Flag
monitoringStatus string Monitoring Status
lastUpdated string Last Updated
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
postalCode string Postal Code
stateOrProvinceCode string State or Province Code
countryCode string Country Code
v1
legalBusinessName string Legal Business Name v2
dbaName string DBA Name v2
outOfBusinessFlag string Out Of Business Flag v2
lastUpdated string Last Updated v2
addressLine1 string Address Line 1 v2
addressLine2 string Address Line 2 v2
city string City v2
postalCode string Postal Code v2
stateOrProvinceCode string State or Province Code v2
countryCode string Country Code v2
federalHierarchy Sub Section
Field Name Type Description Applicable Versions
source string Source v1
v2
hierarchyDepartmentCode string Hierarchy Department Code v1
v2
hierarchyDepartmentName string Hierarchy Department Name v1
v2
hierarchyAgencyCode string Hierarchy Agency Code v1
v2
hierarchyAgencyName string Hierarchy Agency Name v1
v2
hierarchyOfficeCode string Hierarchy Office Code v1
v2
tinInformation Sub Section
Field Name Type Description Applicable Versions
taxpayerName string Taxpayer Name v1
v2
taxpayerIdentificationType string Taxpayer Identification Type v1
v2
taxpayerIdentificationNumber string Taxpayer Identification Number v1
v2
entityInformation Sub Section
Field Name Type Description Applicable Versions
entityURL string Entity URL v1
v2
entityDivisionName string Entity Division Name v1
v2
entityDivisionNumber string Entity Division Number v1
v2
entityStartDate string Entity Start Date v1
v2
fiscalYearEndCloseDate string Fiscal Year End Close Date v1
v2
submissionDate string Submission Date v1
v2
correspondenceFlag string Correspondence Flag v1
v2
physicalAddress, mailingAddress Sub Sections
Field Name Type Description Applicable Versions
addressLine1 string Physical Address Line 1 and Mailing Address Line 1.
Only Physical Address Line 1 is applicable to non-SAM registrants.
v1
v2
addressLine2 string Physical Address Line 2 and Mailing Address Line 2.
Only Physical Address Line 2 is applicable to non-SAM registrants.
v1
v2
city string Physical Address City and Mailing Address City.
Only Physical Address City is applicable to non-SAM registrants.
v1
v2
stateOrProvinceCode string Physical Address State or Province Code and Mailing Address State or Province Code.
Only Physical Address State or Province Code is applicable to non-SAM registrants.
v1
v2
zipCode string Physical Address Zip and Mailing Address Zip.
Only Physical Address Zip is applicable to non-SAM registrants.
v1
v2
zipCodePlus4 string Physical Address Zip Plus4 and Mailing Address Zip Plus4.
Only Physical Address Zip Plus4 is applicable to non-SAM registrants.
v1
v2
countryCode string Physical Address Country Code and Mailing Address Country Code.
Only Physical Address Country Code is applicable to non-SAM registrants.
v1
v2
Field Name Type Description Applicable Versions
congressionalDistrict string Physical Address Congressional District v1
v2
generalInformation Sub Section
Field Name Type Description Applicable Versions
agencyBusinessPurposeCode string Agency Business Purpose Code v1
v2
agencyBusinessPurposeDesc string Agency Business Purpose Desc v1
v2
entityStructureCode string Entity Structure Code v1
v2
entityStructureDesc string Entity Structure Desc v1
v2
entityTypeCode string Entity Type Code v1
v2
entityTypeDesc string Entity Type Desc v1
v2
profitStructureCode string Profit Structure Code v1
v2
profitStructureDesc string Profit Structure Desc v1
v2
organizationStructureCode string Organization StructureCode v1
v2
organizationStructureDesc string Organization StructureDesc v1
v2
stateOfIncorporationCode string State Of Incorporation Code v1
v2
stateOfIncorporationDesc string State Of Incorporation Desc v1
v2
countryOfIncorporationCode string Country Of Incorporation Code v1
v2
countryOfIncorporationDesc string Country Of Incorporation Desc v1
v2
companySecurityLevelCode string Company Security Level Code v1
v2
companySecurityLevelDesc string Company Security Level Description v1
v2
highestEmployeeSecurityLevelCode string Highest Employee Security Level Code v1
v2
highestEmployeeSecurityLevelDesc string Highest Employee Security Level Description v1
v2
businessTypes Sub Section
Field Name Type Description Applicable Versions
businessTypeList list businessTypeList contains these fields
Field Name Type Description
businessTypeCode string Business Type Code
businessTypeDesc string Business Type Description
v1
v2
sbaBusinessTypeList list sbaBusinessTypeList contains these fields
Field Name Type Description
sbaBusinessTypeCode string SBA Business Type Code
sbaBusinessTypeDescription string SBA Business Type Description
certificationEntryDate string Certification Entry Date
certificationExitDate string Certification Exit Date
v1
v2
financialInformation Sub Section
Field Name Type Description Applicable Versions
creditCardUsage string Credit Card Usage v1
v2
debtSubjectToOffset string Debt Subject to Offset Flag v1
v2
financialAccount object
financialAccount contains below fields
Field Name Type Description
authorizationDate string Authorization Date
eftInformation string EFT Information
accountType string Account Type
accountNumber string Account Number
abaRoutingNumber string ABA Routing Number
eftWaiver string EFT Waiver
lockboxNumber string Lock box Number
merchantID1 string Merchant ID1
merchantID2 string Merchant ID2
departmentCode string Department Code
agencyLocationCode string Agency Location Code
disbursingOfficeSymbol string Disbursing Office Symbol
accountingStation string Accounting Station
v1
v2
achInformation object
ACH Information below fields
Field Name Type Description
usPhone string US Phone
nonUSPhone string Non US Phone
faxNumber string Fax Number
email string Email
v1
v2
remittanceInformation object
Remittance Information below fields
Field Name Type Description
name string Name
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string ZipCode
zipCodePlus4 string ZipCode Plus4
countryCode string Country Code
v1
v2
assertions Section
goodsAndServices Sub Section
Field Name Type Description Applicable Versions
primaryNaics string Primary NAICS v1
v2
naicsList list
naicsList contains these fields
Field Name Type Description
naicsCode string NAICS Code
naicsDescription string NAICS Description
sbaSmallBusiness string Whether or not the NAICS Code is indicated as an SBA small business
naicsException string Whether or not the NAICS Code is an exception
v1
v2
pscList List
pscList contains these fields
Field Name Type Description
pscCode string PSC Code
pscDescription string PSC Description
v1
v2
disasterReliefData Sub Section
Field Name Type Description Applicable Versions
disasterRegistryFlag string Disaster Registry Flag v1
v2
bondingFlag string Bonding Flag v1
v2
bondingLevels string Bonding Flag v1
v2
geographicalAreaServed list
geographicalAreaServed contains these fields
Field Name Type Description
geographicalAreaServedStateCode string State code
geographicalAreaServedStateName string State name
geographicalAreaServedCountyCode string County code
geographicalAreaServedCountyName string County name
geographicalAreaServedmetropolitanStatisticalAreaCode string Metropolitan Statistical Area Code
geographicalAreaServedmetropolitanStatisticalAreaName string Metropolitan Statistical Area Name
v1
v2
sizeMetrics Sub Section
Field Name Type Description Applicable Versions
averageAnnualRevenue string Average Annual Revenue v1
v2
averageNumberOfEmployees string Average Number Of Employees v1
v2
sizeMetricDetails Sub Section
Field Name Type Description Applicable Versions
employeesLocation string Employees Location v1
v2
receiptsLocation string Receipts Location v1
v2
industrySpecificSizeMetrics Sub Section
Field Name Type Description Applicable Versions
barrelsCapacity string Barrels Capacity v1
v2
totalAssets string Total Assets v1
v2
megawattHours string Mega Watt Hours v1
v2
ediInformation Sub Section
Field Name Type Description Applicable Versions
ediInformationFlag string EDI Information Flag v1
v2
vanProvider string Van Provider v1
v2
isaQualifier string ISA Qualifier v1
v2
isaIdentifier string ISA Identifier v1
v2
functionalGroupIdentifier string Functional Group Identifier v1
v2
requestFlag820s string Request Flag 820s v1
v2
repsAndCerts Section
certifications Sub Section
Field Name Type Description Applicable Versions
fARResponses list
fARResponses contains below fields
Field Name Type Description
listOfProvisions list
listOfProvisions contains below fields
Field Name Type Description
provisionId string Provision Id
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
answerType string Answer Type
answerId string Answer ID
answerText string Answer Text
businessObjectType string Business Object Type
businessObjectId string Business Object ID
firstName string First Name
lastName string First Name
hasSizeProtest string Has Size Protest
title string Title
section string Section
organizationType string Organization Type
endProductName string End Product Name
endProductType string End Product Type
endProductCountry string End Product Country
placeOfManufacture string Place of Manufacture
fscCode string FSC Code
environmentURL string Environment URL
facilityStreetAddress1 string Facility Street Address1
facilityStreetAddress2 string Facility Street Address2
facilityCity string Facility City
facilityPostalCode string Facility Postal Code
facilityState string Facility State
facilityCountry string Facility Country
facilityOwner string Facility Owner
facilityOwner
StreetAddress1
string Facility Owner
Street Address1
facilityOwner
StreetAddress2
string Facility Owner
Street Address2
facilityOwnerCity string Facility Owner City
facilityOwnerPostalCode string Facility Owner Postal Code
facilityOwnerState string Facility Owner State
facilityOwnerCountry string Facility Owner Country
immediateOwner
LegalBusinessName
string Immediate Owner
Legal Business Name
immediateOwnerCageCode string Immediate Owner Cage Code
highestOwnerLegalBusinessName string Highest Owner Legal Business Name
highestOwnerCageCode string Highest Owner Cage Code
firstPredecessor
LegalBusinessName
string First Predecessor Legal
Business Name
secondPredecessorCageCode string Second Predecessor Cage Code
thirdPredecessorLegal
BusinessName
string Third Predecessor Legal
Business Name
thirdPredecessorCageCode string Third Predecessor Cage Code
primaryNaics string Primary Naics
naicsCode string Naics Code
sbaSmallBusiness string SBA Small Business
smallBusiness string Small Business
veteranOwnedSmallBusiness string Veteran Owned Small Business
serviceDisabledVet
OwnedSmallBusiness
string Service Disabled Veteran
Owned Small Business
womenOwned
SmallBusinessConcern
string Women Owned Small
Business Concern
womenOwnedSmallBusiness string Women Owned Small Business
economicallyDisadv
WomenOwnedSmallBusiness
string Economically Disadvantage
Women Owned Small Business
sbaCertifiedSmall
BusinessDisadvBusiness
string SBA Certified Small
Business Disadvantage Business
sbaCertifiedSmallBusinessDisadv
BusinessNotSubmitted
string SBA Certified Small Business Disadvantage
Business Not Submitted
hubZoneSmall
BusinessConcern
string Hub Zone Small
Business Concern
blackAmericanOwned string Black American
hispanicAmericanOwned string Hispanic American
nativeAmericanOwned string Native American
asianPacificAmericanOwned string Asian Pacific American
subcontinentAsian
IndianAmericanOwned
string Sub Continent
Asian Indian American
historicallyBlack
CollegeOrUniversity
string Historically Black
College Or University
minorityInstitution string Minority Institution
linkForFARReportPDF string Link For FAR Report PDF
linkForFARReportHTML string Link For FAR Report HTML
v1
v2
dFARResponses list
dFARResponses contains below fields
Field Name Type Description
listOfProvisions list
listOfProvisions contains below fields
Field Name Type Description
provisionId string Provision Id
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
answerType string Answer Type
answerId string Answer ID
answerText string Answer Text
businessObjectType string Business Object Type
businessObjectId string Business Object ID
section string Section
foreignGovernment
OwnershipFirstName
string Foreign Government Ownership
First Name
foreignGovernment
OwnershipMiddleInitial
string Foreign Government Ownership
Middle Initial
foreignGovernment
OwnershipLastName
string Foreign Government
Ownership Last Name
foreignGovernment
OwnershipLastName
string Foreign Government
Ownership Last Name
foreignGovernment
OwnershipPhoneNum
string Foreign Government
Ownership Phone Number
foreignGovernment
OwnershipPhoneExt
string Foreign Government
Ownership Phone Extension
foreignGovernment
OwnershipInternationalNum
string Foreign Government
Ownership International Number
foreignGovernment
ControlCountry
string Foreign Government
Control Country
foreignEndProductName string Foreign End Product Name
foreignEndProductCountry string Foreign End Product Country
linkForDFARSReportPDF string Link For DFARS Report PDF
linkForDFARSReportHTML string Link For DFARS Report HTML
v1
v2
qualifications Sub Section
Field Name Type Description Applicable Versions
architectEngineerResponses List
architectEngineerResponses contains below fields
Field Name Type Description
listOfProvisions list
listOfProvisions contains below fields
Field Name Type Description
provisionId string Provision Id
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
answerType string Answer Type
answerId string Answer Id
answerText string Answer Text
businessObjectType string Business Object Type
businessObjectId string Business Object Id
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
companyName string Company Name
companyEstablishedYear string Company Established Year
companyDUNS string Company DUNS
companyIsReference string Company Is Reference
firmNumOfEmployees string Number of Employees in the Firm
branchNumOfEmployees string Number of Employees in the Branch
experienceCode string Experience Code
annualAvgRevenueCode string Annual Average Revenue Code
federalRevenueCode string Federal Revenue Code
nonFedRevenueCode string Non-Federal Revenue Code
totalRevenueCode string Total Revenue Code
qualificationURLPDF string Qualification URL PDF
qualificationURLHTML string Qualification URL HTML
v1
v2
financialAssistanceCertifications Sub Section
Field Name Type Description Applicable Versions
financialAssistanceResponse string Financial Assistance Response v1
v2
pointsOfContact Section
governmentBusinessPOC Sub section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
electronicBusinessPOC Sub section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
governmentBusinessAlternatePOC Sub section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
electronicBusinessAlternatePOC Sub Section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
pastPerformancePOC Sub Section
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
pastPerformanceAlternatePOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
partyPerformingCertificationPOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
soleProprietorshipPOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
accountsReceivablePOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
accountsPayablePOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
ediPOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
eliminationsPOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2
salesPOC Sub Sections
Field Name Type Description Applicable Versions
firstName string First Name v1
v2
middleInitial string Middle Initial v1
v2
lastName string Last Name v1
v2
title string Title v1
v2
USPhone string US Phone v1
v2
USPhoneExtension string US Phone Extension v1
v2
nonUSPhone string Non-US Phone v1
v2
fax string Fax v1
v2
email string Email v1
v2
addressLine1 string Address Line 1 v1
v2
addressLine2 string Address Line 2 v1
v2
city string City v1
v2
stateOrProvinceCode string State or Province Code v1
v2
zipCode string Zip Code v1
v2
zipCodePlus4 string Zip Code Plus 4 v1
v2
countryCode string Country Code v1
v2

Back to top

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 Entity Management API

Back to top

HTTP Response Codes

The API will return one of the following responses:

HTTP Response Code Description
400 Application Level Error Messages:

* You are not authorized to access this functionality.

* User does not exist.

* Date should be specified in the format: MM/dd/YYYY.

* ueiDUNS can only be 9 digits.

* ueiDUNS Should Contain Only Numeric value.

* Invalid Input Parameters.

* The parameters: ‘includeSections’,’emailId’ are not permitted inside Query Param(q)

* A maximum of 100 ueiDUNS is allowed.

* A maximum of 100 CAGE Codes is allowed.

* The parameter emailId must be provided in conjunction with the parameter format.

Back to top

Explanation of the API using Examples

Functionality of the Entity API has been explained with the following examples:

User requirement: To get only the entityRegistration, coreData and assertions sections for the Entity records whose entityStructureCode is 2J or 8H, physicalAddressCountryCode is USA, countryOfIncorporationCode is USA, registrationDate is from 01/01/2018 to 04/23/2019, servedDisasterStateCode is
NE or LA or TX, cageCode is not null, dodaac is null, and primaryNaics is 812112 or 484121 or 336411.

API Request: https://api.sam.gov/prod/entity-information/v1/api/entities?api_key=&q=((entityStructureCode=2J OR entityStructureCode=8H) AND physicalAddressCountryCode=USA AND countryOfIncorporationCode=USA)&registrationDate=[01/01/2018,04/23/2019]&servedDisasterStateCode=[NE~LA~TX]&cageCode=!"" &dodaac=""&primaryNaics=[812112~484121~336411]&includeSections=entityRegistration,coreData,assertions
OR
https://api.sam.gov/prod/entity-information/v1/api/entities?api_key=&entityStructureCode=[2J~8H]&physicalAddressCountryCode=USA &countryOfIncorporationCode=USA&registrationDate=[01/01/2018,04/23/2019]&servedDisasterStateCode=[NE~LA~TX]&cageCode=!""&dodaac=""&primaryNaics=[812112~484121~336411] &includeSections=entityRegistration,coreData,assertions

User requirement: To get a CSV file of active Entity records that have a DBAN and that cater to GEOPHYSICAL SURVEYING AND MAPPING SERVICES.

API request: https://api.sam.gov/prod/entity-information/v1/api/entities?api_key=&samExtractCode=A&q=”GEOPHYSICAL SURVEYING AND MAPPING SERVICES”&dbaName=!””&format=CSV

Back to top

Additional Information

You can view the full details of the differences between the SAM legacy API and Beta API
available here: Variance Document

Disclaimer: Limitation on Permissible Use of Dun & Bradstreet, Inc. (D&B) Data

  • This website contains data supplied by third party information suppliers, one of which is D&B. For the purposes of the following limitation on permissible use of D&B data, which includes each entity’s DUNS Number and its associated business information, “D&B Open Data” is defined as the following data elements: Business Name, Street Address, City Name, State/Province Name, Country Name, County Code, State/Province Code, State/Province Abbreviation, ZIP/Postal Code, Country Name and Country Code.
  • D&B hereby grants you, the user, a license for a limited, non-exclusive right to use D&B Open Data within the limitations set forth herein. By using this website you agree that you shall not use D&B Open Data without giving written attribution to the source of such data (i.e., D&B) and shall not access, use or disseminate D&B Open Data in bulk, (i.e., in amounts sufficient for use as an original source or as a substitute for the product and/or service being licensed hereunder).
  • Except for data elements identified above as D&B Open Data, under no circumstances are you authorized to use any other D&B data for commercial, resale or marketing purposes (e.g., identifying, quantifying, segmenting and/or analyzing customers and prospective customers). Systematic access (electronic harvesting) or extraction of content from the website, including the use of “bots” or “spiders”, is prohibited. Federal government entities are authorized to use the D&B data for purposes of acquisition as defined in FAR 2.101 and for the purpose of managing Federal awards, including sub-awards, or reporting Federal award information.
  • GSA assumes no liability for the use of the D&B data once it is downloaded or accessed. The D&B data is provided “as is” without warranty of any kind. The D&B data is the intellectual property of D&B. In no event will D&B or any third party information supplier be liable in any way with regard to the use of the D&B data. For more information about the scope of permissible use of D&B data licensed hereunder, please contact D&B at datause_govt@dnb.com.

Back to top

Contact Us

Back to top

Change Log

Date Version Description
06/03/2019 v0.9 Base Version
07/03/2019 v1.0 * Alpha endpoint for the Sensitive version of the API has been added.

* agencyBusinessPurposeCode, agencyBusinessPurposeDesc, bondingLevels, companySecurityLevelCode, companySecurityLevelDesc, highestEmployeeSecurityLevelCode, highestEmployeeSecurityLevelDesc were added to FOUO and Sensitive api’s schema.

* New Filters agencyBusinessPurposeCode, companySecurityLevelCode and highestEmployeeSecurityLevelCode have been added for FOUO and Sensitive api’s.

* country and stateOrProvince were updated to countryCode and stateOrProvinceCode across all versions of api.

* ediInformationFlag was added across all versions of api.

* geographicalAreaServedmetropolitanStatisticalAreaCode, geographicalAreaServedmetropolitanStatisticalAreaName were added across all versions of api instead of geographicalAreaServedMSAName.

* certificationEntryDate, certificationExitDate were added to SBA Business Types across all versions of api instead of expirationDate.

* updateDate was added as a filter across all versions of api.
08/15/2019 v1.1 * Alpha endpoints for public and FOUO API were updated from version 0.9 to version 1.0.

* Warning message added under Getting Started to inform users of API version changes.

*Added Beta.SAM.Gov to the page title.
09/25/2019 v1.2 Beta endpoints for public and FOUO API were updated from version 0.9 to version 1.0.
11/25/2019 v1.3 * Added D&B Disclaimer in the Additional Information section.

* Updated the specifications to include parameters and fields that will be included in v2 of the API.

Back to top