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
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]
cageCode Allows exact 5 character value.
Example: cageCode=00000
dbaName Allows Partial or Complete value.
Example: dbaName=ALLTEL
debtSubjectToOffset Allows Y or N or null.
Example: debtSubjectToOffset=Y
dodaac Allows 9 character value.
Example: dodaac=DOD123456
ueiDUNS Unique Entity Identifier DUNS -Allows 9 digit value, a maximum of up to 100 values can be sent.
Example: ueiDUNS=025114695
ueiSAM TBD
entityStructureCode Allows 2 character code or null.
Example: entityStructureCode=Z1
entityStructureDesc Allows Description or null.
Example: entityStructureDesc=Partnership or Limited Liability Partnership
exclusionStatusFlag Allows D or null.
Example: exclusionStatusFlag=D
expirationDate Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: expirationDate=01/01/2019, expirationDate=[01/01/2019,05/29/2019]
legalBusinessName Allows Partial or Complete value.
Example: legalBusinessName=ALLTEL
primaryNaics Allows 6 digit NAICS, accepts multiple NAICS.
Example: primaryNaics=513310
purposeOfRegistrationCode Allows 2 character code.
Example: purposeOfRegistrationCode=Z2
purposeOfRegistrationDesc Allows a text.
Example: purposeOfRegistrationDesc=All Awards
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]
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]
physicalAddressCity Allows a text.
Example: physicalAddressCity=Herndon
physicalAddressCongressionalDistrict Allows 2 characters.
Example: physicalAddressCongressionalDistrict=AR
physicalAddressCountryCode Allows 3 character code.
Example: physicalAddressCountryCode=USA
physicalAddressProvinceOrState Allows 2 character code.
Example: physicalAddressProvinceOrState=AR
physicalAddressZipPostalCode Allows 5 digit zip code.
Example: physicalAddressZipPostalCode=02201
samExtractCode Allows 1 character code (A or E).
Example: samExtractCode=A
businessTypeCode Allows 2 character code.
Example: businessTypeCode=2L
businessTypeDesc Allows a text.
Example: businessTypeDesc=Woman Owned Business
organizationStructureCode Allows 2 character code.
Example: organizationStructureCode=2L
organizationStructureDesc Allows 2 character code.
Example: organizationStructureDesc=Limited Liability Company
stateOfIncorporationCode Allows 2 character code.
Example: stateOfIncorporationCode=VA
stateOfIncorporationDesc Allows a text.
Example: stateOfIncorporationDesc=Virginia
countryOfIncorporationCode Allows 3 character code.
Example: countryOfIncorporationCode=USA
countryOfIncorporationDesc Allows a text.
Example: countryOfIncorporationDesc=United States Of America
naicsCode Allows 6 character code.
Example: naicsCode=513310
naicsDesc Allows a text.
Example: naicsDesc=Furniture Stores
naicsLimitedSB Allows 6 character code.
Example: naicsLimitedSB=513310
pscCode Allows 4 character code.
Example: pscCode=0989
pscDesc Allows a text.
Example: pscDesc=Screws
servedDisasterStateCode Allows 2 character code.
Example: servedDisasterStateCode=VA
servedDisasterStateName Allows Name or null.
Example: servedDisasterStateName=Virginia
servedDisasterCountyCode Allows text.
Example: servedDisasterCountyCode=12334
servedDisasterCountyName Allows a text.
Example: servedDisasterCountyName=FAIRFAX
servedDisasterMSA Allows text.
Example: servedDisasterMSA=86800730
includeSections Allows to filter data by sections, entityRegistration, coreData, assertions, repsAndCerts and pointsOfContact.
Example: includeSections=entityRegistration,coreData
format Allows user to download different file formats(csv and json are allowable values).
Example: format=csv
emailId Allows user to get file download links to email. Email Id should be provided in conjunction with format.
Example: emailId=test@gsa.gov
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
ueiSAM string Unique Entity Identifier SAM
ueiDUNS string Unique Entity Identifier DUNS
entityEFTIndicator string Entity EFT Indicator
cageCode string CAGE Code
dodaac string DoDAAC
legalBusinessName string Legal Business Name
dbaName string Doing Business As Name
purposeOfRegistrationCode string Purpose of Registration Code
purposeOfRegistrationDesc string Purpose of Registration Description
registrationStatus string Registration Status
registrationDate string Registration Date
lastUpdateDate string Last Update Date
expirationDate string Expiration Date
activeDate string Active Date
noPublicDisplayFlag string No Public Display Flag
exclusionStatusFlag string Exclusion Status Flag
exclusionURL string Active Exclusion URL
coreData Section
entityInformation Sub Section
Field Name Type Description
entityURL string Entity URL
entityDivisionName string Entity Division Name
entityDivisionNumber string Entity Division Number
entityStartDate string Entity Start Date
fiscalYearEndCloseDate string Fiscal Year End Close Date
submissionDate string Submission Date
correspondenceFlag string Correspondence Flag
physicalAddress, mailingAddress Sub Sections
Field Name Type Description
addressLine1 string Physical Address Line 1 and Mailing Address Line 1
addressLine2 string Physical Address Line 2 and Mailing Address Line 2
city string Physical Address City and Mailing Address City
stateOrProvinceCode string Physical Address State or Province Code and Mailing Address State or Province Code
zipCode string Physical Address Zip and Mailing Address Zip
zipCodePlus4 string Physical Address Zip Plus4 and Mailing Address Zip Plus4
countryCode string Physical Address Country Code and Mailing Address Country Code
Field Name Type Description
congressionalDistrict string Physical Address Congressional District
generalInformation Sub Section
Field Name Type Description
entityStructureCode string Entity Structure Code
entityStructureDesc string Entity Structure Description
entityTypeCode string Entity Type Code
entityTypeDesc string Entity Type Description
profitStructureCode string Profit Structure Code
profitStructureDesc string Profit Structure Description
organizationStructureCode string Organization Structure Code
organizationStructureDesc string Organization Structure Description
stateOfIncorporationCode string State Of Incorporation Code
stateOfIncorporationDesc string State Of Incorporation Description
countryOfIncorporationCode string Country Of Incorporation Code
countryOfIncorporationDesc string Country Of Incorporation Description
businessTypes Sub Section
Field Name Type Description
businessTypeList list businessTypeList contains these fields
Field Name Type Description
businessTypeCode string Business Type Code
businessTypeDesc string Business Type Description
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
Financial Information Sub Section
Field Name Type Description
creditCardUsage string Credit Card Usage
debtSubjectToOffset string Debt Subject to Offset Flag
assertions Section
goodsAndServices Sub Section
Field Name Type Description
primaryNaics string Primary NAICS
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
pscList List
pscList contains these fields
Field Name Type Description
pscCode string PSC Code
pscDescription string PSC Description
disasterReliefData Sub Section
Field Name Type Description
disasterRegistryFlag string Disaster Registry Flag
bondingFlag string Bonding Flag
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
ediInformation Sub Section
Field Name Type Description
ediInformationFlag string EDI Information Flag
repsAndCerts Section
certifications Sub Section
Field Name Type Description
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
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
qualifications Sub Section
Field Name Type Description
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
financialAssistanceCertifications Sub Section
Field Name Type Description
financialAssistanceResponse string Financial Assistance Response
pointsOfContact Section
governmentBusinessPOC Sub section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
electronicBusinessPOC Sub section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
governmentBusinessAlternatePOC Sub section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
electronicBusinessAlternatePOC Sub Section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
pastPerformancePOC Sub Section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
pastPerformanceAlternatePOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code

FOUO API Information

Query String Parameters
Parameter Name Description
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]
cageCode Allows exact 5 character value.
Example: cageCode=00000
dbaName Allows Partial or Complete value.
Example: dbaName=ALLTEL
debtSubjectToOffset Allows Y or N or null.
Example: debtSubjectToOffset=Y
dodaac Allows 9 character value.
Example: dodaac=DOD123456
ueiDUNS Unique Entity Identifier DUNS -Allows 9 digit value, a maximum of up to 100 values can be sent.
Example: ueiDUNS=025114695
ueiSAM TBD
entityStructure Allows 2 character code or null.
Example: entityStructure=Z1
entityStructureDesc Allows Description or null.
Example: entityStructureDesc=Partnership or Limited Liability Partnership
exclusionStatusFlag Allows D or null.
Example: exclusionStatusFlag=D
expirationDate Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: expirationDate=01/01/2019, expirationDate=[01/01/2019,05/29/2019]
legalBusinessName Allows Partial or Complete value.
Example: legalBusinessName=ALLTEL
primaryNaics Allows 6 digit NAICS, accepts multiple NAICS.
Example: primaryNaics=513310
purposeOfRegistrationCode Allows 2 character code.
Example: purposeOfRegistrationCode=Z2
purposeOfRegistrationDesc Allows a text.
Example: purposeOfRegistrationDesc=All Awards
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]
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]
physicalAddressCity Allows a text.
Example: physicalAddressCity=Herndon
physicalAddressCongressionalDistrict Allows 2 characters.
Example: physicalAddressCongressionalDistrict=AR
physicalAddressCountryCode Allows 3 character code.
Example: physicalAddressCountryCode=USA
physicalAddressProvinceOrState Allows 2 character code.
Example: physicalAddressProvinceOrState=AR
physicalAddressZipPostalCode Allows 5 digit zip code.
Example: physicalAddressZipPostalCode=02201
samExtractCode Allows 1 character code (A or E).
Example: samExtractCode=A
organizationStructureCode Allows 2 character code.
Example: organizationStructureCode=2L
organizationStructureDesc Allows 2 character code.
Example: organizationStructureDesc=Limited Liability Company
stateOfIncorporationCode Allows 2 character code.
Example: stateOfIncorporationCode=VA
stateOfIncorporationDesc Allows a text.
Example: stateOfIncorporationDesc=Virginia
countryOfIncorporationCode Allows 3 character code.
Example: countryOfIncorporationCode=USA
countryOfIncorporationDesc Allows Name or null Unites States.
Example: countryOfIncorporationDesc=United States Of America
naicsCode Allows 6 character code.
Example: naicsCode=513310
naicsDesc Allows a text.
Example: naicsDesc=Furniture Stores
naicsLimitedSB Allows 6 character code.
Example: naicsLimitedSB=513310
pscCode Allows 4 character code.
Example: pscCode=0989
pscDesc Allows a text.
Example: pscDesc=Screws
servedDisasterStateCode Allows 2 character code.
Example: servedDisasterStateCode=VA
servedDisasterStateName Allows a text.
Example: servedDisasterStateName=Virginia
servedDisasterCountyCode Allows a text.
Example: servedDisasterCountyCode=32324
servedDisasterCountyName Allows Name or null Virginia.
Example: servedDisasterCountyName=FAIRFAX
servedDisasterMSA Allows a text.
Example: servedDisasterMSA=86800730
includeSections Allows to filter data by sections, entityRegistration, coreData, assertions, repsAndCerts and pointsOfContact.
Example: includeSections=entityRegistration,coreData
format Allows user to download different file formats(csv and json are allowable values).
Example: format=csv
emailId Allows user to get file download links to email. Email Id should be provided in conjunction with format.
Example: emailId=test@gsa.gov
edi Allows text.
Example: edi=YES/NO
companySecurityLevelCode Allows 2 character code.
Example: companySecurityLevelCode=92
highestEmployeeSecurityLevelCode Allows 2 character code .
Example: highestEmployeeSecurityLevelCode=90
ultimateParentUEIDUNS Allows text.
Example: ultimateParentUEIDUNS=090123451
ultimateParentUEISAM Allows text.
Example: ultimateParentUEISAM=090123451
agencyBusinessPurposeCode Allows text, Determines Agency Business Purpose Code.
Example: agencyBusinessPurposeCode=1
sensitivity Allows a text, Determines Sensitivity Level of Data.
Example: sensitivity=public
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
ueiSAM string Unique Entity Identifier SAM
ueiDUNS string Unique Entity Identifier DUNS
entityEFTIndicator string Entity EFT Indicator
cageCode string CAGE Code
dodaac string DoDAAC
legalBusinessName string Legal Business Name
dbaName string Doing Business As Name
purposeOfRegistrationCode string Purpose of Registration Code
purposeOfRegistrationDesc string Purpose of Registration Description
registrationStatus string Registration Status
registrationDate string Registration Date
lastUpdateDate string Last Update Date
expirationDate string Expiration Date
activeDate string Active Date
noPublicDisplayFlag string No Public Display Flag
exclusionStatusFlag string Exclusion Status Flag
exclusionURL string Active Exclusion URL
core Data Section
Field Name Type Description
congressionalDistrict string Physical Address Congressional District
entityHierarchyInformation Sub Section
Field Name Type Description
immediateParentEntity object
immediateParentEntity 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
intermediateParentEntities List
intermediateParentEntities contains below fields
Field Name Type Description
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
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
ultimateParentEntity object
ultimateParentEntity 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
evsMonitoring object
evsMonitoring contains below fields
Field Name Type Description
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
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
federalHierarchy Sub Section
Field Name Type Description
source string Source
hierarchyDepartmentCode string Hierarchy Department Code
hierarchyDepartmentName string Hierarchy Department Name
hierarchyAgencyCode string Hierarchy Agency Code
hierarchyAgencyName string Hierarchy Agency Name
hierarchyOfficeCode string Hierarchy Office Code
entityInformation Sub Section
Field Name Type Description
entityURL string Entity URL
entityDivisionName string Entity Division Name
entityDivisionNumber string Entity Division Number
entityStartDate string Entity Start Date
fiscalYearEndCloseDate string Fiscal Year End Close Date
submissionDate string Submission Date
correspondenceFlag string Correspondence Flag
physicalAddress, mailingAddress Sub Sections
Field Name Type Description
addressLine1 string Physical Address Line 1 and Mailing Address Line 1
addressLine2 string Physical Address Line 2 and Mailing Address Line 2
city string Physical Address City and Mailing Address City
stateOrProvinceCode string Physical Address State or Province Code and Mailing Address State or Province Code
zipCode string Physical Address Zip and Mailing Address Zip
zipCodePlus4 string Physical Address Zip Plus4 and Mailing Address Zip Plus4
countryCode string Physical Address Country Code and Mailing Address Country Code
generalInformation Sub Section
Field Name Type Description
agencyBusinessPurposeCode string Agency Business Purpose Code
agencyBusinessPurposeDesc string Agency Business Purpose Desc
entityStructureCode string Entity Structure Code
entityStructureDescription string Entity Structure Description
entityTypeCode string Entity Type Code
entityTypeDesc string Entity Type Description
profitStructureCode string Profit Structure Code
profitStructureDesc string Profit Structure Description
organizationStructureCode string Organization Structure Code
organizationStructureDesc string Organization Structure Description
stateOfIncorporationCode string State Of Incorporation Code
stateOfIncorporationDesc string State Of Incorporation Description
countryOfIncorporationCode string Country Of IncorporationCode
countryOfIncorporationDesc string Country Of IncorporationDescription
companySecurityLevelCode string Company Security Level Code
companySecurityLevelDesc string Company Security Level Description
highestEmployeeSecurityLevelCode string Highest Employee Security Level Code
highestEmployeeSecurityLevelDesc string Highest Employee Security Level Description
businessTypes Sub Section
Field Name Type Description
businessTypeList list businessTypeList contains these fields
Field Name Type Description
businessTypeCode string Business Type Code
businessTypeDescription string Business Type Description
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
Financial Information Sub Section
Field Name Type Description
creditCardUsage string Credit Card Usage
debtSubjectToOffset string Debt Subject to Offset Flag
assertions Section
goodsAndServices Sub Section
Field Name Type Description
primaryNaics string Primary NAICS
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
pscList List
pscList contains these fields
Field Name Type Description
pscCode string PSC Code
pscDescription string PSC Description
disasterReliefData Sub Section
Field Name Type Description
disasterRegistryFlag string Disaster Registry Flag
bondingFlag string Bonding Flag
bondingLevels list
Bonding Levels contains these fields
Field Name Type Description
type string Type of bonding level
value string Value of bonding level
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
sizeMetrics Sub Section
Field Name Type Description
averageAnnualRevenue string Average Annual Revenue
averageNumberOfEmployees string Average Number Of Employees
sizeMetricDetails Sub Section
Field Name Type Description
employeesLocation string Employees Location
receiptsLocation string Receipts Location
industrySpecificSizeMetrics Sub Section
Field Name Type Description
barrelsCapacity string Barrels Capacity
totalAssets string Total Assets
megawattHours string Mega Watt Hours
ediInformation Sub Section
Field Name Type Description
ediInformationFlag string EDI Information Flag
vanProvider string Van Provider
isaQualifier string ISA Qualifier
isaIdentifier string ISA Identifier
functionalGroupIdentifier string Functional Group Identifier
requestFlag820s string Request Flag 820s
repsAndCerts Section
certifications Sub Section
Field Name Type Description
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
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
qualifications Sub Section
Field Name Type Description
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
financialAssistanceCertifications Sub Section
Field Name Type Description
financialAssistanceResponse string Financial Assistance Response
pointsOfContact Section
governmentBusinessPOC Sub section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
electronicBusinessPOC Sub section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
governmentBusinessAlternatePOC Sub section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
electronicBusinessAlternatePOC Sub Section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
pastPerformancePOC Sub Section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
pastPerformanceAlternatePOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
partyPerformingCertificationPOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
soleProprietorshipPOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
accountsReceivablePOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
accountsPayablePOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
ediPOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
eliminationsPOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
salesPOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code

Sensitive API Information

Query String Parameters
Parameter Name Description
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]
cageCode Allows exact 5 character value.
Example: cageCode=00000
dbaName Allows Partial or Complete value.
Example: dbaName=ALLTEL
debtSubjectToOffset Allows Y or N or null.
Example: debtSubjectToOffset=Y
dodaac Allows 9 character value.
Example: dodaac=DOD123456
ueiDUNS Unique Entity Identifier DUNS -Allows 9 digit value, a maximum of up to 100 values can be sent.
Example: ueiDUNS=025114695
ueiSAM TBD
entityStructureCode Allows 2 character code or null.
Example: entityStructureCode=Z1
entityStructureDesc Allows Description or null.
Example: entityStructureDesc=Partnership or Limited Liability Partnership
exclusionStatusFlag Allows D or null.
Example: exclusionStatusFlag=D
expirationDate Allows a single Date or a Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]
Examples: expirationDate=01/01/2019, expirationDate=[01/01/2019,05/29/2019]
legalBusinessName Allows Partial or Complete value.
Example: legalBusinessName=ALLTEL
primaryNaics Allows 6 digit NAICS, accepts multiple NAICS.
Example: primaryNaics=513310
purposeOfRegistrationCode Allows 2 character code.
Example: purposeOfRegistrationCode=Z2
purposeOfRegistrationDesc Allows a text.
Example: purposeOfRegistrationDesc=All Awards
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]
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]
physicalAddressCity Allows a text.
Example: physicalAddressCity=Herndon
physicalAddressCongressionalDistrict Allows 2 characters.
Example: physicalAddressCongressionalDistrict=AR
physicalAddressCountryCode Allows 3 character code.
Example: physicalAddressCountryCode=USA
physicalAddressProvinceOrState Allows 2 character code.
Example: physicalAddressProvinceOrState=AR
physicalAddressZipPostalCode Allows 5 digit zip code.
Example: physicalAddressZipPostalCode=02201
samExtractCode Allows 1 character code (A or E).
Example: samExtractCode=A
businessTypeCode Allows 2 character code.
Example: businessTypeCode=2L
businessTypeDesc Allows a text.
Example: businessTypeDesc=Woman Owned Business
organizationStructureCode Allows 2 character code.
Example: organizationStructureCode=2L
organizationStructureDesc Allows 2 character code.
Example: organizationStructureDesc=Limited Liability Company
stateOfIncorporationCode Allows 2 character code.
Example: stateOfIncorporationCode=VA
stateOfIncorporationDesc Allows a text.
Example: stateOfIncorporationDesc=Virginia
countryOfIncorporationCode Allows 3 character code.
Example: countryOfIncorporationCode=USA
countryOfIncorporationDesc Allows a text.
Example: countryOfIncorporationDesc=United States Of America
naicsCode Allows 6 character code.
Example: naicsCode=513310
naicsDesc Allows a text.
Example: naicsDesc=Furniture Stores
naicsLimitedSB Allows 6 character code.
Example: naicsLimitedSB=513310
pscCode Allows 4 character code.
Example: pscCode=0989
pscDesc Allows a text.
Example: pscDesc=Screws
servedDisasterStateCode Allows 2 character code.
Example: servedDisasterStateCode=VA
servedDisasterStateName Allows a text.
Example: servedDisasterStateName=Virginia
servedDisasterCountyCode Allows text.
Example: servedDisasterCountyCode=763577
servedDisasterCountyName Allows a text.
Example: servedDisasterCountyName=FAIRFAX
servedDisasterMSA Allows text.
Example: servedDisasterMSA=86800730
includeSections Allows to filter data by sections, entityRegistration, coreData, assertions, repsAndCerts and pointsOfContact.
Example: includeSections=entityRegistration,coreData
format Allows user to download different file formats(csv and json are allowable values).
Example: format=csv
emailId Allows user to get file download links to email. Email Id should be provided in conjunction with format.
Example: emailId=test@gsa.gov
edi Allows text.
Example: edi=YES/NO
companySecurityLevelCode Allows 2 character code.
Example: companySecurityLevelCode=92
highestEmployeeSecurityLevelCode Allows 2 character code .
Example: highestEmployeeSecurityLevelCode=90
ultimateParentUEIDUNS Allows text.
Example: ultimateParentUEIDUNS=090123451
ultimateParentUEISAM Allows text.
Example: ultimateParentUEISAM=090123451
agencyBusinessPurposeCode Allows text, Determines Agency Business Purpose Code.
Example: agencyBusinessPurposeCode=1
routingNumber Allows a text.
Example: routingNumber=0123456
bankName Allows a text.
Example: bankName=TEST
accountNumber Allows a text.
Example: accountNumber=012323456
eftWaiverFlag Allows a text.
Example: eftWaiverFlag=Y
agencyLocationCode Allows a text.
Example: agencyLocationCode=1
disbursingOfficeSymbol Allows a text.
Example: disbursingOfficeSymbol=1093
taxpayerName Allows a text.
Example: taxpayerName=test
taxpayerIdentificationNumber Allows a text.
Example: taxpayerIdentificationNumber=01234
sensitivity Allows a text, Determines Sensitivity Level of Data.
Example: sensitivity=public
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
ueiSAM string Unique Entity Identifier SAM
ueiDUNS string Unique Entity Identifier DUNS
entityEFTIndicator string Entity EFT Indicator
cageCode string CAGE Code
dodaac string DoDAAC
legalBusinessName string Legal Business Name
dbaName string Doing Business As Name
purposeOfRegistration string Purpose of Registration
registrationStatus string Registration Status
registrationDate string Registration Date
lastUpdateDate string Last Update Date
expirationDate string Expiration Date
activeDate string Active Date
noPublicDisplayFlag string No Public Display Flag
exclusionStatusFlag string Exclusion Status Flag
exclusionURL string Active Exclusion URL
core Data Section
Field Name Type Description
congressionalDistrict string Physical Address Congressional District
entityHierarchyInformation
Field Name Type Description
immediateParentEntity object
immediateParentEntity 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
zipCode string Physical Address Zip
zipCodePlus4 string Physical Address Zip Plus4
countryCode string Physical Address Country
phoneNumber string Phone Number
intermediateParentEntities object
ultimateDomesticParent 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
zipCode string Physical Address Zip
zipCodePlus4 string Physical Address Zip Plus4
countryCode string Physical Address Country
phoneNumber string Phone Number
ultimateParentEntity object
ultimateParentEntity 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
zipCode string Physical Address Zip
zipCodePlus4 string Physical Address Zip Plus4
countryCode string Physical Address Country
phoneNumber string Phone Number
evsMonitoring object
evsMonitoring contains below fields
Field Name Type Description
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
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
federalHierarchy Sub Section
Field Name Type Description
source string Source
hierarchyDepartmentCode string Hierarchy Department Code
hierarchyDepartmentName string Hierarchy Department Name
hierarchyAgencyCode string Hierarchy Agency Code
hierarchyAgencyName string Hierarchy Agency Name
hierarchyOfficeCode string Hierarchy Office Code
tinInformation Sub Section
Field Name Type Description
taxpayerName string Taxpayer Name
taxpayerIdentificationType string Taxpayer Identification Type
taxpayerIdentificationNumber string Taxpayer Identification Number
entityInformation Sub Section
Field Name Type Description
entityURL string Entity URL
entityDivisionName string Entity Division Name
entityDivisionNumber string Entity Division Number
entityStartDate string Entity Start Date
fiscalYearEndCloseDate string Fiscal Year End Close Date
submissionDate string Submission Date
correspondenceFlag string Correspondence Flag
physicalAddress, mailingAddress Sub Sections
Field Name Type Description
addressLine1 string Physical Address Line 1 and Mailing Address Line 1
addressLine2 string Physical Address Line 2 and Mailing Address Line 2
city string Physical Address City and Mailing Address City
stateOrProvinceCode string Physical Address State or Province Code and Mailing Address State or Province Code
zipCode string Physical Address Zip and Mailing Address Zip
zipCodePlus4 string Physical Address Zip Plus4 and Mailing Address Zip Plus4
countryCode string Physical Address Country Code and Mailing Address Country Code
generalInformation Sub Section
Field Name Type Description
agencyBusinessPurposeCode string Agency Business Purpose Code
agencyBusinessPurposeDesc string Agency Business Purpose Desc
entityStructureCode string Entity Structure Code
entityStructureDesc string Entity Structure Desc
entityTypeCode string Entity Type Code
entityTypeDesc string Entity Type Desc
profitStructureCode string Profit Structure Code
profitStructureDesc string Profit Structure Desc
organizationStructureCode string Organization StructureCode
organizationStructureDesc string Organization StructureDesc
stateOfIncorporationCode string State Of Incorporation Code
stateOfIncorporationDesc string State Of Incorporation Desc
countryOfIncorporationCode string Country Of Incorporation Code
countryOfIncorporationDesc string Country Of Incorporation Desc
companySecurityLevelCode string Company Security Level Code
companySecurityLevelDesc string Company Security Level Description
highestEmployeeSecurityLevelCode string Highest Employee Security Level Code
highestEmployeeSecurityLevelDesc string Highest Employee Security Level Description
businessTypes Sub Section
Field Name Type Description
businessTypeList list businessTypeList contains these fields
Field Name Type Description
businessTypeCode string Business Type Code
businessTypeDesc string Business Type Description
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
financialInformation Sub Section
Field Name Type Description
creditCardUsage string Credit Card Usage
debtSubjectToOffset string Debt Subject to Offset Flag
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
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
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
assertions Section
goodsAndServices Sub Section
Field Name Type Description
primaryNaics string Primary NAICS
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
pscList List
pscList contains these fields
Field Name Type Description
pscCode string PSC Code
pscDescription string PSC Description
disasterReliefData Sub Section
Field Name Type Description
disasterRegistryFlag string Disaster Registry Flag
bondingFlag string Bonding Flag
bondingLevels string Bonding Flag
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
sizeMetrics Sub Section
Field Name Type Description
averageAnnualRevenue string Average Annual Revenue
averageNumberOfEmployees string Average Number Of Employees
sizeMetricDetails Sub Section
Field Name Type Description
employeesLocation string Employees Location
receiptsLocation string Receipts Location
industrySpecificSizeMetrics Sub Section
Field Name Type Description
barrelsCapacity string Barrels Capacity
totalAssets string Total Assets
megawattHours string Mega Watt Hours
ediInformation Sub Section
Field Name Type Description
ediInformationFlag string EDI Information Flag
vanProvider string Van Provider
isaQualifier string ISA Qualifier
isaIdentifier string ISA Identifier
functionalGroupIdentifier string Functional Group Identifier
requestFlag820s string Request Flag 820s
repsAndCerts Section
certifications Sub Section
Field Name Type Description
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
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
qualifications Sub Section
Field Name Type Description
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
financialAssistanceCertifications Sub Section
Field Name Type Description
financialAssistanceResponse string Financial Assistance Response
pointsOfContact Section
governmentBusinessPOC Sub section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
electronicBusinessPOC Sub section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
governmentBusinessAlternatePOC Sub section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
electronicBusinessAlternatePOC Sub Section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
pastPerformancePOC Sub Section
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
pastPerformanceAlternatePOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
partyPerformingCertificationPOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
soleProprietorshipPOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
accountsReceivablePOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
accountsPayablePOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
ediPOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
eliminationsPOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code
salesPOC Sub Sections
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
USPhone string US Phone
USPhoneExtension string US Phone Extension
nonUSPhone string Non-US Phone
fax string Fax
email string Email
addressLine1 string Address Line 1
addressLine2 string Address Line 2
city string City
stateOrProvinceCode string State or Province Code
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
countryCode string Country Code

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

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.

Back to top