Overview

The Entity Management API allows users to request Unclassified (“Public”), Controlled Unclassified Information (CUI) “For Official Use Only” (FOUO) or CUI “Sensitive” entity data, based on the sensitivity level of the user account and through several optional request parameters.

Public Data:

This constitutes publicly available entities and their unclassified data such as name, UEI, registration details, physical and mailing addresses, business types, PSC, NAICS and points of contact name and address.

FOUO (CUI) Data:

This constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data such as hierarchy, company and employee security levels and points of contact email address, phone, and fax numbers.

Sensitive (CUI) Data:

This constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data such as banking information and SSN/TIN/EIN.

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.
  • It returns ten records per page in the JSON format.
  • It can return only the first 10,000 records.
  • The following characters are not allowed to be sent in the parameter values with the API request: & | { } ^ \

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 link.
  • 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

API endpoints

Production:

  • https://api.sam.gov/entity-information/v1/entities?api_key=
  • https://api.sam.gov/entity-information/v1/entities?
  • https://api.sam.gov/entity-information/v2/entities?api_key=
  • https://api.sam.gov/entity-information/v2/entities?
  • https://api.sam.gov/entity-information/v3/entities?api_key=
  • https://api.sam.gov/entity-information/v3/entities?
  • https://api.sam.gov/entity-information/v4/entities?api_key=
  • https://api.sam.gov/entity-information/v4/entities?

Alpha:

  • https://api-alpha.sam.gov/entity-information/v1/entities?api_key=
  • https://api-alpha.sam.gov/entity-information/v1/entities?
  • https://api-alpha.sam.gov/entity-information/v2/entities?api_key=
  • https://api-alpha.sam.gov/entity-information/v2/entities?
  • https://api-alpha.sam.gov/entity-information/v3/entities?api_key=
  • https://api-alpha.sam.gov/entity-information/v3/entities?
  • https://api-alpha.sam.gov/entity-information/v4/entities?api_key=
  • https://api-alpha.sam.gov/entity-information/v4/entities?

User Requirements

To access Public data:

  • Users must have a non-Federal/Federal Individual (Personal) account and the respective API Key, a non-Federal/Federal System Account with the “Read Public” permission and the respective API Key in SAM.gov.
  • Users can make GET calls using any Browser or a Restful API client such as Postman.

To access FOUO (CUI) data:

  • Users must have a Federal System Account with the “Read FOUO” permission and the respective API Key in SAM.gov.
  • Users can make GET calls using any Browser or a Restful API client such as Postman.

To access Sensitive (CUI) data:

  • Users must have a Federal System Account with the “Read Sensitive” permission and the respective API Key in SAM.gov.
  • Users must make POST calls using a Restful API client such as Postman.

Individual (Personal) Accounts

  • The SAM.gov Federal or non-Federal registered users must obtain the API Key from the https://sam.gov/profile/details page using the field, “Public API Key”.
    image info
  • Click on the “Eye” icon, enter the “Enter One-time Password” (this value will be sent to your email address that is associated with your registered account), hit “Submit”, for the API Key value to appear in the box.

System Accounts

  • The SAM.gov non-Federal registered users must request for a System Account. If their registration and request criteria are satisfied, then they will be provided with the System Accounts” widget on their SAM.gov “Workspace” page.
  • The SAM.gov Federal registered users must contact their CCB representatives for obtaining the “System Accounts” widget on their SAM.gov “Workspace” page.
  • Users must create their System Account using the “System Accounts” widget and get it approved.
  • Users must then set the password for the System Account.
  • After the above step is successfully completed, users will see a new section for retrieving the API Key. Users must enter the password to retrieve this value.

  • System Accounts must satisfy the following criteria to successfully utilize the Entity Management API:

    • System Information
      Unique System ID: The System Account ID
    • Permissions
      Entity Information: read public –> Gives access to the Public data.
      Entity Information: read public, read fouo –> Gives access to the Public and FOUO (CUI) data.
      Entity Information: read public, read fouo, read sensitive –> Gives access to the Public, FOUO (CUI) and Sensitive (CUI) data.
    • Security Information
      IP Address: List all the IP Addresses that the System invokes the API from.
    • Type of Connection: REST APIs
    • System Account Password
    • System Account API Key

API Key Rate Limits

Type of User Account Type of API Key Default API Daily Rate Limit
Non-federal user with no Role in SAM.gov Personal API key 10 requests/day
Non-federal user with a Role in SAM.gov Personal API key 1,000 requests/day
Federal User Personal API key 1,000 requests/day
Non-federal System user System account API key 1,000 requests/day
Federal System user System account API key 10,000 requests/day
Sensitive API Process:
  • The System Account User ID and Password must be sent as "Basic Auth" under the "Authorization" Header. The combination needs to be base 64 encoded as base64(username:password).
  • The API Key value must be sent as "x-api-key" under "Headers" and not directly in the request URL.
  • The "Accept" parameter must be sent as "application/json" under "Headers".
  • The "Content-Type" parameter must be sent as "application/json" under "Headers".
  • All the optional search filters can be sent in the request URL or in the "Body".
  • An example of the Sensitive entity management POST call using curl

    Curl request with basic auth token:
    curl -X POST "https://api.sam.gov/entity-information/v2/entities?ueiSAM=< UEI >" --header "X-Api-Key: < a valid API Key >" --header "Content-Type: application/json" --header "Accept: application/json" --header "Authorization: Basic < auth token >"

    Curl request with username and password:
    curl -X POST "https://api.sam.gov/entity-information/v2/entities?ueiSAM=< UEI >" --header "X-Api-Key: < a valid API Key >" --header "Content-Type: application/json" --header "Accept: application/json" --user "< username >:< password >"



Utilizing the API Extract

  • To retrieve Entity data in the CSV format, “format=csv” must be provided in the request.
  • To retrieve Entity data in the JSON format, “format=json” must be provided in the request.
  • If the request is executed successfully, then a file downloadable URL with Token will be returned. This URL can also be obtained in emails by providing “emailId=Yes” in the request.
  • In the file downloadable URL, the phrase REPLACE_WITH_API_KEY must be 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.

Back to top

API Description

Query String Parameters:
The Entity Management API offers several optional search parameters that can be provided independently or in combination with each other.
Parameter Name Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
samRegistered The API, by default, will return only the entities that are registered, if this search parameter is not sent in the request.
However, users can still choose to send this search parameter as:
samRegistered=Yes. 		v2
The API, by default, will return only the entities that are registered, if this search parameter is not sent in the request.
However, users can choose to send this search parameter as:
samRegistered=Yes – to receive entities that are registered.
samRegistered=No – to receive entities that are not registered/ID Assigned. 		v3
v4
samExtractCode --> registrationStatus Allows 1 character code (A for Active or E for Expired).
samExtractCode=A, registrationStatus=A
NOTE: This parameter is being renamed. samExtractCode is in V1 and registrationStatus is starting V2. 		v1
v2
v3
v4
ueiSAM Unique Entity Identifier SAM
Allows a single 12-character value or up to 100 values.
Example: ueiSAM=RV56IG5JM6G9
Applicable to the entities that are registered or not registered/ID Assigned.		 v1
v2
v3
v4
entityEFTIndicator Entity EFT Indicator.
Example: entityEFTIndicator=0000
NOTE: This parameter must be used in conjunction with ueiSAM.		 v1
v2
v3
v4
cageCode Allows a single 5-character value or up to 100 values.
Example: cageCode=00000
Applicable to the entities that are registered or not registered/ID Assigned.		 v1
v2
v3
v4
dodaac Allows 9 character value.
Example: dodaac=DOD123456		 v1
v2
v3
v4
legalBusinessName Allows partial or complete value search.
Example: legalBusinessName=ALLTEL
Applicable to the entities that are registered or not registered/ID Assigned.		 v1
v2
v3
v4
dbaName Allows Partial or Complete value.
Example: dbaName=ALLTEL		 v1
v2
v3
v4
debtSubjectToOffset Allows Y, N, U or null.
Example: debtSubjectToOffset=Y		 v1
v2
v3
v4
exclusionStatusFlag v1 or v2: Allows D or null.
Examples: exclusionStatusFlag=D, exclusionStatusFlag=""

v3: Allows Y or N
Examples: exclusionStatusFlag=Y, exclusionStatusFlag=N		 v1
v2
v3
v4
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
v3
v4
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
v3
v4
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
v3
v4
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 is starting V2. 		v1
v2
v3
v4
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 the entities that are registered or not registered/ID Assigned.		 v2
v3
v4
purposeOfRegistrationCode Allows 2 character code.
Example: purposeOfRegistrationCode=Z2		 v1
v2
v3
v4
purposeOfRegistrationDesc Allows a text.
Example: purposeOfRegistrationDesc=All Awards		 v1
v2
v3
v4
physicalAddressCity Allows a text.
Example: physicalAddressCity=Herndon
Applicable to the entities that are registered or not registered/ID Assigned.		 v1
v2
v3
v4
physicalAddressCongressionalDistrict Allows a 2 digit code.
Example: physicalAddressCongressionalDistrict=08
Applicable to SAM registrants.		 v1
v2
v3
v4
physicalAddressCountryCode Allows a 3-character code for entities that are registered. Allows both 3-character and 2-character codes for entities that are not registered/ID Assigned.
Example: physicalAddressCountryCode=USA
Applicable to the entities that are registered or not registered/ID Assigned.		 v1
v2
v3
v4
physicalAddressProvinceOrStateCode Allows a 2 character code.
Example: physicalAddressProvinceOrStateCode=AR
Applicable to the entities that are registered or not registered/ID Assigned.		 v1
v2
v3
v4
physicalAddressZipPostalCode SAM registrants:
Allows a 5-digit code for US zip codes or any digit postal code for non-US postal codes, for entities that are registered. Allows either a 5 or a 9-digit code for US zip codes, or any digit postal code for non-US postal codes, for entities that are not registered/ID Assigned.
Examples:
physicalAddressZipPostalCode=02201, physicalAddressZipPostalCode=110054, physicalAddressZipPostalCode=21202-3117 		v1
v2
v3
v4
entityStructureCode Allows 2 character code or null.
Example: entityStructureCode=2L		 v1
v2
v3
v4
entityStructureDesc Allows Description or null.
Example: entityStructureDesc=Partnership or Limited Liability Partnership		 v1
v2
v3
v4
organizationStructureCode Allows 2 character code.
Example: organizationStructureCode=MF		 v1
v2
v3
v4
organizationStructureDesc Allows 2 character code.
Example: organizationStructureDesc=MANUFACTURER OF GOODS		 v1
v2
v3
v4
businessTypeCode Allows 2 character code.
Example: businessTypeCode=OY		 v1
v2
v3
v4
businessTypeDesc Allows a text.
Example: businessTypeDesc=Woman Owned Business 		v1
v2
v3
v4
sbaBusinessTypeCode Allows a two character code or null.
Example: sbaBusinessTypeCode=12		 v1
v2
v3
v4
sbaBusinessTypeDesc Allows text.
Example: sbaBusinessTypeDesc=Woman Owned Small Business		 v1
v2
v3
v4
primaryNaics Allows 6 digit NAICS, accepts multiple NAICS.
Example: primaryNaics=513310		 v1
v2
v3
v4
naicsCode Allows 6 character code.
Example: naicsCode=513310		 v1
v2
v3
v4
naicsDesc Allows a text.
Example: naicsDesc=Furniture Stores		 v1
v2
v3
v4
naicsLimitedSB Allows a 6-digit NAICS Code, "" or !"" values.
Example: naicsLimitedSB=513310		 v1
v2
v3
v4
pscCode Allows 4 character code.
Example: pscCode=X1QA		 v1
v2
v3
v4
pscDesc Allows a text.
Example: pscDesc=Screws		 v1
v2
v3
v4
stateOfIncorporationCode Allows 2 character code.
Example: stateOfIncorporationCode=VA		 v1
v2
v3
v4
stateOfIncorporationDesc Allows a text.
Example: stateOfIncorporationDesc=Virginia		 v1
v2
v3
v4
countryOfIncorporationCode Allows 3 character code.
Example: countryOfIncorporationCode=USA		 v1
v2
v3
v4
countryOfIncorporationDesc Allows a text.
Example: countryOfIncorporationDesc=UNITED STATES		 v1
v2
v3
v4
servedDisasterStateCode Allows 2 digit character code or "any".
Example: servedDisasterStateCode=VA, servedDisasterStateCode=any		 v1
v2
v3
v4
servedDisasterStateName Allows Name or null.
Example: servedDisasterStateName=Virginia		 v1
v2
v3
v4
servedDisasterCountyCode Allows 3 digit county code.
Example: servedDisasterCountyCode=060		 v1
v2
v3
v4
servedDisasterCountyName Allows a text.
Example: servedDisasterCountyName=FAIRFAX		 v1
v2
v3
v4
servedDisasterMSA Allows 4 digit MSA code.
Example: servedDisasterMSA=1720		 v1
v2
v3
v4
proceedingsData When used in conjunction with includeSections=integrityInformation,
allows users to obtain registered entities that have answered Proceedings data.
This parameter accepts the only value of Yes which is not case sensitive.

Examples:
includeSections=integrityInformation&proceedingsData=Yes;
includeSections=All,integrityInformation&proceedingsData=yes;
includeSections=entityRegistration,coreData,integrityInformation,
pointsOfContact&proceedingsData=YES 		v3
v4
includeSections Allows to filter data by sections.
For registered entities:
The applicable sections are entityRegistration, coreData, assertions, pointsOfContact, repsAndCerts, All and integrityInformation.
  • The repsAndCerts section will be returned only if explicitly requested.
  • To request all the sections (entityRegistration, coreData, assertions, pointsOfContact and repsAndCerts), provide a value of 'All'.
  • The integrityInformation section is newly added specifically to the v3 API. It is not included in ‘All’, so it must be explicitly requested.

Examples: includeSections=entityRegistration,coreData;
includeSections=integrityInformation,All;
includeSections=repsAndCerts.

For not registered/ID Assigned entities:
The applicable sections are entityRegistration, coreData, All and integrityInformation.
  • To request both the sections (entityRegistration and coreData), provide a value of 'All'.
  • The integrityInformation section is newly added specifically to the v3 API. It is not included in ‘All’, so it must be explicitly requested.


Examples:
includeSections=entityRegistration,coreData;
includeSections=integrityInformation,All 		v1
v2
v3
v4
format Allows user to download data into the JSON and CSV asynchronous file formats.
Example: format=csv
Applicable to the entities that are registered or not registered/ID Assigned.		 v1
v2
v3
v4
emailId When used in conjunction with the format parameter, allows user to get JSON or CSV asynchronous file download links with tokens sent to the email address associated to the API key used in the request.
Example: emailId=Yes&format=JSON
Applicable to the entities that are registered or not registered/ID Assigned. 		v1
v2
v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
edi Allows text.
Example: edi=YES/NO		 v1
v2
v3
v4
companySecurityLevelCode Allows 2 character code.
Example: companySecurityLevelCode=92		 v1
v2
v3
v4
companySecurityLevelDesc Allows text.
Example: companySecurityLevelDesc=Government Top Secret		 v1
v2
v3
v4
highestEmployeeSecurityLevelCode Allows 2 character code .
Example: highestEmployeeSecurityLevelCode=90		 v1
v2
v3
v4
highestEmployeeSecurityLevelDesc Allows text.
Example: highestEmployeeSecurityLevelDesc=Government Top Secret		 v1
v2
v3
v4
ultimateParentUEISAM Allows text.
Example: ultimateParentUEISAM=RQ56IG5JM6G9		 v1
v2
v3
v4
agencyBusinessPurposeCode Allows text, Determines Agency Business Purpose Code.
Example: agencyBusinessPurposeCode=1		 v1
v2
v3
v4
agencyBusinessPurposeDesc Allows text.
Example: agencyBusinessPurposeDesc=Buyer and Seller		 v1
v2
v3
v4
sensitivity By default your API key determines the sensitivity level of the API response. If you would like to receive a response that is at a sensitivity level lower than your API key you can utilize this parameter.
Example: sensitivity=public		 v1
v2
v3
v4
Sensitivity Level: Sensitive, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
routingNumber Allows a text.
Example: routingNumber=0123456		 v1
v2
v3
v4
bankName Allows a text.
Example: bankName=TEST		 v1
v2
v3
v4
accountNumber Allows a text.
Example: accountNumber=012323456		 v1
v2
v3
v4
eftWaiverFlag Allows a text.
Example: eftWaiverFlag=Y		 v1
v2
v3
v4
agencyLocationCode Allows a text.
Example: agencyLocationCode=1		 v1
v2
v3
v4
disbursingOfficeSymbol Allows a text.
Example: disbursingOfficeSymbol=1093		 v1
v2
v3
v4
taxpayerName Allows a text.
Example: taxpayerName=test		 v1
v2
v3
v4
taxpayerIdentificationNumber Allows a text.
Example: taxpayerIdentificationNumber=01234		 v1
v2
v3
v4
Response Schema:
The Entity Management API offers several response elements that are described in the following sections.
entityRegistration
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
samRegistered string Registered or not registered/ID Assigned entity. v2
v3
v4
ueiSAM string Unique Entity Identifier SAM
Applicable to the entities that are registered or not registered/ID Assigned.		 v1
v2
v3
v4
entityEFTIndicator string Entity EFT Indicator v1
v2
v3
v4
cageCode string CAGE Code
Applicable to the entities that are registered or not registered/ID Assigned.		 v1
v2
v3
v4
dodaac string DoDAAC v1
v2
v3
v4
legalBusinessName string Legal Business Name
Applicable to the entities that are registered or not registered/ID Assigned.		 v1
v2
v3
v4
dbaName string Doing Business As Name v1
v2
v3
v4
purposeOfRegistrationCode string Purpose of Registration Code v1
v2
v3
v4
purposeOfRegistrationDesc string Purpose of Registration Description v1
v2
v3
v4
registrationStatus string The status of the entities that are registered or not registered/ID Assigned. v1
v2
v3
v4
evsSource string Source of the validated entities that are registered or not registered/ID Assigned. v3
v4
registrationDate string Registration Date v1
v2
v3
v4
lastUpdateDate string Last Update Date v1
v2
v3
v4
expirationDate ->
registrationExpirationDate		 string Registration Expiration Date
NOTE: This parameter is being renamed. expirationDate is in V1 and registrationExpirationDate is starting V2.		 v1
v2
v3
v4
activationDate string Active Date v1
v2
v3
v4
ueiStatus string Unique Entity Identifier Status
Applicable to the entities that are registered or not registered/ID Assigned.		 v2
v3
v4
ueiExpirationDate string Unique Entity Identifier Expiration Date
Applicable to the entities that are registered or not registered/ID Assigned.		 v2
v3
v4
ueiCreationDate string Unique Entity Identifier Creation Date
Applicable to the entities that are registered or not registered/ID Assigned.		 v2
v3
v4
noPublicDisplayFlag --> publicDisplayFlag string Opted for Public Display or opted out of it.
v1 or v2: Returns noPublicDisplayFlag.
v3: Returns publicDisplayFlag.
Applicable to the entities that are registered or not registered/ID Assigned.

NOTE: A Fed System Account with the Non-SAM NPDY Role is required to access NPDY entities that are not registered/ID Assigned.		 v1
v2
v3
v4
exclusionStatusFlag string v1 or v2: Returns D (Debarred) or null.
v3: Returns Y (Debarred) or N (not Debarred).

NOTE: Debarred entities will populate 'exclusionURL' with the endpoint to access the debarred record.		 v1
v2
v3
v4
exclusionURL string Returns the URL to access the Exclusion record with ueiSAM. v1
v2
v3
v4
dnbOpenData string Dun & Bradstreet Open Data
Applicable to the entities that are registered or not registered/ID Assigned.		 v2
v3
v4
coreData
entityHierarchyInformation Sub Section
Applicable to the entities that are registered
Field Name Type Description
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
immediateParentEntity object
immediateParentEntity contains below fields
Field Name Type Description Applicable Versions
ueiSAM string Unique Entity Identifier SAM v1
v2
v3
v4
legalBusinessName string Legal Business Name v1
v2
v3
v4
evsSource string Source of the registered entity’s hierarchy v3
v4
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
v3
v4
phoneNumber string Phone Number v1
v2
v3
v4
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
legalBusinessName string Legal Business Name
evsSource string Source of the registered entity’s hierarchy

NOTE: This field is only available in v3
v4
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
v3
v4
hqParent object
hqParent contains below fields
Field Name Type Description
ueiSAM string Unique Entity Identifier SAM
legalBusinessName string Legal Business Name
evsSource string Source of the registered entity’s hierarchy

NOTE: This field is only available in v3
v4
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
v3
v4
ultimateParentEntity object
ultimateParentEntity contains below fields
Field Name Type Description Applicable Versions
ueiSAM string Unique Entity Identifier SAM v1
v2
v3
v4
legalBusinessName string Legal Business Name v1
v2
v3
v4
evsSource string Source of the registered entity’s hierarchy v3
v4
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
v3
v4
phoneNumber string Phone Number v1
v2
v3
v4
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
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
stateOrProvinceCode string State or Province Code
countryCode string Country Code
v1
samMonitoring object
samMonitoring contains below fields and this section will return a value of "Currently Not Available".
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
zipCode string Zip Code
zipCodePlus4 string Zip Code Plus 4
stateOrProvinceCode string State or Province Code
countryCode string Country Code
v1
legalBusinessName string Legal Business Name v2
v3
v4
dbaName string DBA Name v2
v3
v4
outOfBusinessFlag string Out Of Business Flag v2
v3
v4
monitoringStatus string Monitoring Status v2
v3
v4
lastUpdated string Last Updated v2
v3
v4
addressLine1 string Address Line 1 v2
v3
v4
addressLine2 string Address Line 2 v2
v3
v4
city string City v2
v3
v4
postalCode string Postal Code v2
v3
v4
stateOrProvinceCode string State or Province Code v2
v3
v4
countryCode string Country Code v2
v3
v4
federalHierarchy Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
source string Source v1
v2
v3
v4
hierarchyDepartmentCode string Hierarchy Department Code v1
v2
v3
v4
hierarchyDepartmentName string Hierarchy Department Name v1
v2
v3
v4
hierarchyAgencyCode string Hierarchy Agency Code v1
v2
v3
v4
hierarchyAgencyName string Hierarchy Agency Name v1
v2
v3
v4
hierarchyOfficeCode string Hierarchy Office Code v1
v2
v3
v4
tinInformation Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Sensitive, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
taxpayerName string Taxpayer Name v1
v2
v3
v4
taxpayerIdentificationType string Taxpayer Identification Type v1
v2
v3
v4
taxpayerIdentificationNumber string Taxpayer Identification Number v1
v2
v3
v4
entityInformation Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
entityURL string Entity URL v1
v2
v3
v4
entityDivisionName string Entity Division Name v1
v2
v3
v4
entityDivisionNumber string Entity Division Number v1
v2
v3
v4
entityStartDate string Entity Start Date v1
v2
v3
v4
fiscalYearEndCloseDate string Fiscal Year End Close Date v1
v2
v3
v4
submissionDate string Submission Date v1
v2
v3
v4
Sensitivity Level: Sensitive, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
mpin string This field has been deprecated. v1
v2
v3
v4
physicalAddress Sub Section
Applicable to the entities that are registered or not registered/ID Assigned
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
addressLine1 string Address Line 1 v1
v2
v3
v4
addressLine2 string Address Line 2 v1
v2
v3
v4
city string City v1
v2
v3
v4
stateOrProvinceCode string State or Province Code v1
v2
v3
v4
zipCode string Zip Code v1
v2
v3
v4
zipCodePlus4 string Zip Plus4 v1
v2
v3
v4
countryCode string Country Code v1
v2
v3
v4
mailingAddress Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
addressLine1 string Mailing Address Line 1. v1
v2
v3
v4
addressLine2 string Mailing Address Line 2. v1
v2
v3
v4
city string Mailing Address City. v1
v2
v3
v4
stateOrProvinceCode string Mailing Address State or Province Code. v1
v2
v3
v4
zipCode string Mailing Address Zip. v1
v2
v3
v4
zipCodePlus4 string Mailing Address Zip Plus4. v1
v2
v3
v4
countryCode string Mailing Address Country Code v1
v2
v3
v4
congressionalDistrict
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
congressionalDistrict string Physical Address Congressional District v1
v2
v3
v4
generalInformation Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
entityStructureCode string Entity Structure Code v1
v2
v3
v4
entityStructureDescription string Entity Structure Description v1
v2
v3
v4
entityTypeCode string Entity Type Code v1
v2
v3
v4
entityTypeDesc string Entity Type Description v1
v2
v3
v4
profitStructureCode string Profit Structure Code v1
v2
v3
v4
profitStructureDesc string Profit Structure Description v1
v2
v3
v4
organizationStructureCode string Organization Structure Code v1
v2
v3
v4
organizationStructureDesc string Organization Structure Description v1
v2
v3
v4
stateOfIncorporationCode string State Of Incorporation Code v1
v2
v3
v4
stateOfIncorporationDesc string State Of Incorporation Description v1
v2
v3
v4
countryOfIncorporationCode string Country Of IncorporationCode v1
v2
v3
v4
countryOfIncorporationDesc string Country Of IncorporationDescription v1
v2
v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
agencyBusinessPurposeCode string Agency Business Purpose Code v1
v2
v3
v4
agencyBusinessPurposeDesc string Agency Business Purpose Desc v1
v2
v3
v4
companySecurityLevelCode string Company Security Level Code v1
v2
v3
v4
companySecurityLevelDesc string Company Security Level Description v1
v2
v3
v4
highestEmployeeSecurityLevelCode string Highest Employee Security Level Code v1
v2
v3
v4
highestEmployeeSecurityLevelDesc string Highest Employee Security Level Description v1
v2
v3
v4
businessTypes Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
businessTypeList list businessTypeList contains these fields
Field Name Type Description
businessTypeCode string Business Type Code
businessTypeDescription string Business Type Description
v1
v2
v3
v4
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
v3
v4
financialInformation Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
creditCardUsage string Credit Card Usage v1
v2
v3
v4
debtSubjectToOffset string Debt Subject to Offset Flag v1
v2
v3
v4
Sensitivity Level: Sensitive, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
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
v3
v4
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
v3
v4
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
v3
v4
integrityInformation
entitySummary Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
ueiSAM string Unique Entity Identifier SAM v3
v4
cageCode string CAGE Code v3
v4
legalBusinessName string Legal Business Name v3
v4
physicalAddress
addressLine1 string Address Line1 v3
v4
addressLine2 string Address Line2 v3
v4
city string City v3
v4
stateOrProvinceCode string State or Province Code v3
v4
zipCode string Zip Code v3
v4
zipCodePlus4 string Zip Plus4 v3
v4
countryCode string Country Code v3
v4
proceedingsData Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
proceedingsQuestion1 string Proceedings Question1.
Yes or No values are captured		 v3
v4
proceedingsQuestion2 string Proceedings Question2.
Yes or No values are captured		 v3
v4
proceedingsQuestion3 string Proceedings Question3.
Yes or No values are captured		 v3
v4
proceedingsRecordCount string Proceedings Records Counter v3
v4
listOfProceedings
proceedingDate string Proceeding Date v3
v4
instrumentNumber string Instrument Number v3
v4
instrument string Instrument Type v3
v4
proceedingStateCode string Proceeding State Code v3
v4
proceedingType string Proceeding Type v3
v4
disposition string Disposition v3
v4
proceedingDescription string Proceeding Description v3
v4
proceedingsPointsOfContact
proceedingsPOC
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
firstName string First Name v3
v4
middleInitial string Middle Initial v3
v4
lastName string Last Name v3
v4
title string Title v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
usPhone string US Phone v3
v4
usPhoneExtension string US Phone Extension v3
v4
nonUSPhone string Non-US Phone v3
v4
fax string Fax v3
v4
email string Email v3
v4
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
addressLine1 string Address Line 1 v3
v4
addressLine2 string Address Line 2 v3
v4
city string City v3
v4
stateOrProvinceCode string State or Province Code v3
v4
zipCode string Zip Code v3
v4
zipCodePlus4 string Zip Code Plus 4 v3
v4
countryCode string Country Code v3
v4
proceedingsAlternatePOC
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
firstName string First Name v3
v4
middleInitial string Middle Initial v3
v4
lastName string Last Name v3
v4
title string Title v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
usPhone string US Phone v3
v4
usPhoneExtension string US Phone Extension v3
v4
nonUSPhone string Non-US Phone v3
v4
fax string Fax v3
v4
email string Email v3
v4
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
addressLine1 string Address Line 1 v3
v4
addressLine2 string Address Line 2 v3
v4
city string City v3
v4
stateOrProvinceCode string State or Province Code v3
v4
zipCode string Zip Code v3
v4
zipCodePlus4 string Zip Code Plus 4 v3
v4
countryCode string Country Code v3
v4
responsibilityInformationCount Sub Section
Applicable to the entities that are registered or not registered/ID Assigned
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
responsibilityInformationCount string Responsibility Information Counter v3
v4
responsibilityInformationList Sub Section
Applicable to the entities that are registered or not registered/ID Assigned
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
recordType string Record Type v3
v4
recordTypeDesc string Record Type Description v3
v4
recordDate string Record Date v3
v4
procurementIdOrFederalAssistanceId string Contract Data ID or Grant ID v3
v4
referenceIdvPiid string Referenced IDV PIID v3
v4
attachment string Pre-signed URL to access the attachment v3
v4
corporateRelationships Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
highestOwner
legalBusinessName string Legal Business Name v3
v4
cageCode string Cage Code v3
v4
integrityRecords string Returns:
Yes - if the CAGE Code finds one or more matches in the database.
No - if the CAGE Code does not find any match in the database.
N/A - if the CAGE Code is null.		 v3
v4
immediateOwner
legalBusinessName string Legal Business Name v3
v4
cageCode string Cage Code v3
v4
integrityRecords string Returns:
Yes - if the CAGE Code finds one or more matches in the database.
No - if the CAGE Code does not find any match in the database.
N/A - if the CAGE Code is null.		 v3
v4
predecessorsList
legalBusinessName string Legal Business Name v3
v4
cageCode string Cage Code v3
v4
integrityRecords string Returns:
Yes - if the CAGE Code finds one or more matches in the database.
No - if the CAGE Code does not find any match in the database.
N/A - if the CAGE Code is null.		 v3
v4
assertions
goodsAndServices Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
primaryNaics string Primary NAICS v1
v2
v3
v4
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
v3
v4
pscList List
pscList contains these fields
Field Name Type Description
pscCode string PSC Code
pscDescription string PSC Description
v1
v2
v3
v4
disasterReliefData Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
disasterRegistryFlag string Disaster Registry Flag v1
v2
v3
v4
bondingFlag string Bonding Flag v1
v2
v3
v4
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
v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
bondingLevels string Bonding Flag v1
v2
v3
v4
sizeMetrics Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
averageAnnualRevenue string Average Annual Revenue v1
v2
v3
v4
averageNumberOfEmployees string Average Number Of Employees v1
v2
v3
v4
sizeMetricDetails Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
employeesLocation string Employees Location v1
v2
v3
v4
receiptsLocation string Receipts Location v1
v2
v3
v4
industrySpecificSizeMetrics Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
barrelsCapacity string Barrels Capacity v1
v2
v3
v4
totalAssets string Total Assets v1
v2
v3
v4
megawattHours string Mega Watt Hours v1
v2
v3
v4
ediInformation Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
ediInformationFlag string EDI Information Flag v1
v2
v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
vanProvider string Van Provider v1
v2
v3
v4
isaQualifier string ISA Qualifier v1
v2
v3
v4
isaIdentifier string ISA Identifier v1
v2
v3
v4
functionalGroupIdentifier string Functional Group Identifier v1
v2
v3
v4
requestFlag820s string Request Flag 820s v1
v2
v3
v4
repsAndCerts
certifications Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
fARResponses list
fARResponses contains below fields
Field Name Type Description
provisionId string Provision ID
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
section string Section
questionText string Question Text
answerId string Answer ID
answerText string Answer Text
country string Country
company string
company contains below fields
Field Name Type Description
id string ID
name string Name
tin string TIN
uniqueEntityId string Unique EntityId
yearEstablished string Year Established
highestLevelOwnerCage string
highestLevelOwnerCage contains below fields
Field Name Type Description
cageCode string CAGE Code
nCageCode string NCAGE Code
legalBusinessName string Legal Business Name
hasOwner string Has Owner
id string ID
immediateOwnerCage string
immediateOwnerCage contains below fields
Field Name Type Description
cageCode string CAGE Code
nCageCode string NCAGE Code
legalBusinessName string Legal Business Name
hasOwner string Has Owner
id string ID
personDetails string
personDetails contains below fields
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
pointOfContact string
pointOfContact contains below fields
Field Name Type Description
id string ID
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
telephoneNumber string Telephone Number
extension string Extension
internationalNumber string InterNationalNumber
architectExperiencesList List
architectExperiencesList contains below fields
Field Name Type Description
id string ID
experienceCode string Experience Code
experienceDescription string Experience Description
annualAvgRevenueCode string Annual Avg Revenue Code
annualAvgRevenueDescription string Annual Avg Revenue Description
disciplineInfoList List
disciplineInfoList contains below fields
Field Name Type Description
id string ID
disciplineID string Discipline ID
firmNumOfEmployees string Firm Num of Employees
branchNumOfEmployees string Branch Num of Employees
disciplineDescription string Discipline Description
endProductsList string
endProductsList contains below fields
Field Name Type Description
id string ID
name string Name
country string Country
productType string ProductType
exceedsDomesticThreshold string ExceedsDomesticThreshold
foreignGovtEntitiesList string
foreignGovtEntitiesList contains below fields
Field Name Type Description
name string Name
controlledEntityName string Controlled Entity Name
interestDescription string Interest Description
ownershipPercentageType string Ownership Percentage Type
address object
address contains below fields
Field Name Type Description
line1 string Line 1
line2 string Line 2
city string City
stateOrProvince string State Or Province
zip string Zip
countryCode string Country Code
govtCountry string Govt Country
formerFirmsList List
formerFirmsList contains below fields
Field Name Type Description
id string ID
name string Name
tin string Tin
uniqueEntityId string Unique EntityId
yearEstablished string Year Established
fscInfoList List
fscInfoList contains below fields
Field Name Type Description
id string ID
placeOfManufacture string Place of Manufacture
fscCode string FSC Code
description string Description
jointVentureCompaniesList List
jointVentureCompaniesList contains below fields
Field Name Type Description
id string ID
name string Name
tin string Tin
uniqueEntityId string Unique EntityId
yearEstablished string Year Established
laborSurplusConcernsList List
laborSurplusConcernsList contains below fields
Field Name Type Description
surplusArea string Surplus Area
civilJurisdiction string Civil Jurisdiction
state string State
naicsList List
naicsList contains below fields
Field Name Type Description
naicsCode string NAICS Code
naicsName string NAICS Name
isPrimary string Is Primary
isSmallBusiness string Is Small Business
exceptionCounter string Exception Counter
hasSBAProtest string Has SBA Protest
hasSizeChanged string Has Size Changed
predecessorsList List
predecessorsList contains below fields
Field Name Type Description
cageCode string CAGE Code
ncageCode string NCAGE Code
legalBusinessName string Legal Business Name
id string ID
samFacilitiesList List
samFacilitiesList contains below fields
Field Name Type Description
plantAddress object
plantAddress contains below fields
Field Name Type Description
line1 string Line 1
line2 string Line 2
city string City
stateOrProvince string State Or Province
zip string Zip
countryCode string Country Code
ownerName string Owner Name
ownerAddress object
ownerAddress contains below fields
Field Name Type Description
line1 string Line 1
line2 string Line 2
city string City
stateOrProvince string State Or Province
zip string Zip
countryCode string Country Code
samPointsOfContactList List
samPointsOfContactList contains below fields
Field Name Type Description
firstName string First Name
lastName string Last Name
title string Title
servicesRevenuesList List
servicesRevenuesList contains below fields
Field Name Type Description
id string ID
federalRevenueCode string Federal Revenue Code
federalRevenueDescription string Federal Revenue Description
nonFedRevenueCode string Non Fed Revenue Code
nonFedRevenueDescription string Non Fed Revenue Description
totalRevenueCode string Total Revenue Code
totalRevenueDescription string Total Revenue Description
softwareList List
softwareList contains below fields
Field Name Type Description
id string ID
name string Name
country string Country
productType string Product Type
urlList List URL List
v1
v2
v3
v4
dFARResponses list
dFARResponses contains below fields
Field Name Type Description
provisionId string Provision ID
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
section string Section
questionText string Question Text
answerId string Answer ID
answerText string Answer Text
country string Country
company string
company contains below fields
Field Name Type Description
id string ID
name string Name
tin string TIN
uniqueEntityId string Unique EntityId
yearEstablished string Year Established
highestLevelOwnerCage string
highestLevelOwnerCage contains below fields
Field Name Type Description
cageCode string CAGE Code
nCageCode string NCAGE Code
legalBusinessName string Legal Business Name
hasOwner string Has Owner
id string ID
immediateOwnerCage string
immediateOwnerCage contains below fields
Field Name Type Description
cageCode string CAGE Code
nCageCode string NCAGE Code
legalBusinessName string Legal Business Name
hasOwner string Has Owner
id string ID
personDetails string
personDetails contains below fields
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
pointOfContact string
pointOfContact contains below fields
Field Name Type Description
id string ID
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
telephoneNumber string Telephone Number
extension string Extension
internationalNumber string InterNationalNumber
architectExperiencesList List
architectExperiencesList contains below fields
Field Name Type Description
id string ID
experienceCode string Experience Code
experienceDescription string Experience Description
annualAvgRevenueCode string Annual Avg Revenue Code
annualAvgRevenueDescription string Annual Avg Revenue Description
disciplineInfoList List
disciplineInfoList contains below fields
Field Name Type Description
id string ID
disciplineID string Discipline ID
firmNumOfEmployees string Firm Num of Employees
branchNumOfEmployees string Branch Num of Employees
disciplineDescription string Discipline Description
endProductsList string
endProductsList contains below fields
Field Name Type Description
id string ID
name string Name
country string Country
productType string ProductType
exceedsDomesticThreshold string ExceedsDomesticThreshold
foreignGovtEntitiesList string
foreignGovtEntitiesList contains below fields
Field Name Type Description
name string Name
controlledEntityName string Controlled Entity Name
interestDescription string Interest Description
ownershipPercentageType string Ownership Percentage Type
address object
address contains below fields
Field Name Type Description
line1 string Line 1
line2 string Line 2
city string City
stateOrProvince string State Or Province
zip string Zip
countryCode string Country Code
govtCountry string Govt Country
formerFirmsList List
formerFirmsList contains below fields
Field Name Type Description
id string ID
name string Name
tin string Tin
uniqueEntityId string Unique EntityId
yearEstablished string Year Established
fscInfoList List
fscInfoList contains below fields
Field Name Type Description
id string ID
placeOfManufacture string Place of Manufacture
fscCode string FSC Code
description string Description
jointVentureCompaniesList List
jointVentureCompaniesList contains below fields
Field Name Type Description
id string ID
name string Name
tin string Tin
uniqueEntityId string Unique EntityId
yearEstablished string Year Established
laborSurplusConcernsList List
laborSurplusConcernsList contains below fields
Field Name Type Description
surplusArea string Surplus Area
civilJurisdiction string Civil Jurisdiction
state string State
naicsList List
naicsList contains below fields
Field Name Type Description
naicsCode string NAICS Code
naicsName string NAICS Name
isPrimary string Is Primary
isSmallBusiness string Is Small Business
exceptionCounter string Exception Counter
hasSBAProtest string Has SBA Protest
hasSizeChanged string Has Size Changed
predecessorsList List
predecessorsList contains below fields
Field Name Type Description
cageCode string CAGE Code
ncageCode string NCAGE Code
legalBusinessName string Legal Business Name
id string ID
samFacilitiesList List
samFacilitiesList contains below fields
Field Name Type Description
plantAddress object
plantAddress contains below fields
Field Name Type Description
line1 string Line 1
line2 string Line 2
city string City
stateOrProvince string State Or Province
zip string Zip
countryCode string Country Code
ownerName string Owner Name
ownerAddress object
ownerAddress contains below fields
Field Name Type Description
line1 string Line 1
line2 string Line 2
city string City
stateOrProvince string State Or Province
zip string Zip
countryCode string Country Code
samPointsOfContactList List
samPointsOfContactList contains below fields
Field Name Type Description
firstName string First Name
lastName string Last Name
title string Title
servicesRevenuesList List
servicesRevenuesList contains below fields
Field Name Type Description
id string ID
federalRevenueCode string Federal Revenue Code
federalRevenueDescription string Federal Revenue Description
nonFedRevenueCode string Non Fed Revenue Code
nonFedRevenueDescription string Non Fed Revenue Description
totalRevenueCode string Total Revenue Code
totalRevenueDescription string Total Revenue Description
softwareList List
softwareList contains below fields
Field Name Type Description
id string ID
name string Name
country string Country
productType string Product Type
urlList List URL List
v1
v2
v3
v4
qualifications Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
architectEngineerResponses Object
architectEngineerResponses contains below fields
Field Name Type Description
provisionId string Provision ID
listOfAnswers list
listOfAnswers contains below fields
Field Name Type Description
section string Section
questionText string Question Text
answerId string Answer ID
answerText string Answer Text
country string Country
company string
company contains below fields
Field Name Type Description
id string ID
name string Name
tin string TIN
uniqueEntityId string Unique EntityId
yearEstablished string Year Established
highestLevelOwnerCage string
highestLevelOwnerCage contains below fields
Field Name Type Description
cageCode string CAGE Code
nCageCode string NCAGE Code
legalBusinessName string Legal Business Name
hasOwner string Has Owner
id string ID
immediateOwnerCage string
immediateOwnerCage contains below fields
Field Name Type Description
cageCode string CAGE Code
nCageCode string NCAGE Code
legalBusinessName string Legal Business Name
hasOwner string Has Owner
id string ID
personDetails string
personDetails contains below fields
Field Name Type Description
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
pointOfContact string
pointOfContact contains below fields
Field Name Type Description
id string ID
firstName string First Name
middleInitial string Middle Initial
lastName string Last Name
title string Title
telephoneNumber string Telephone Number
extension string Extension
internationalNumber string InterNationalNumber
architectExperiencesList List
architectExperiencesList contains below fields
Field Name Type Description
id string ID
experienceCode string Experience Code
experienceDescription string Experience Description
annualAvgRevenueCode string Annual Avg Revenue Code
annualAvgRevenueDescription string Annual Avg Revenue Description
disciplineInfoList List
disciplineInfoList contains below fields
Field Name Type Description
id string ID
disciplineID string Discipline ID
firmNumOfEmployees string Firm Num of Employees
branchNumOfEmployees string Branch Num of Employees
disciplineDescription string Discipline Description
endProductsList string
endProductsList contains below fields
Field Name Type Description
id string ID
name string Name
country string Country
productType string ProductType
exceedsDomesticThreshold string ExceedsDomesticThreshold
foreignGovtEntitiesList string
foreignGovtEntitiesList contains below fields
Field Name Type Description
name string Name
controlledEntityName string Controlled Entity Name
interestDescription string Interest Description
ownershipPercentageType string Ownership Percentage Type
address object
address contains below fields
Field Name Type Description
line1 string Line 1
line2 string Line 2
city string City
stateOrProvince string State Or Province
zip string Zip
countryCode string Country Code
govtCountry string Govt Country
formerFirmsList List
formerFirmsList contains below fields
Field Name Type Description
id string ID
name string Name
tin string Tin
uniqueEntityId string Unique EntityId
yearEstablished string Year Established
fscInfoList List
fscInfoList contains below fields
Field Name Type Description
id string ID
placeOfManufacture string Place of Manufacture
fscCode string FSC Code
description string Description
jointVentureCompaniesList List
jointVentureCompaniesList contains below fields
Field Name Type Description
id string ID
name string Name
tin string Tin
uniqueEntityId string Unique EntityId
yearEstablished string Year Established
laborSurplusConcernsList List
laborSurplusConcernsList contains below fields
Field Name Type Description
surplusArea string Surplus Area
civilJurisdiction string Civil Jurisdiction
state string State
naicsList List
naicsList contains below fields
Field Name Type Description
naicsCode string NAICS Code
naicsName string NAICS Name
isPrimary string Is Primary
isSmallBusiness string Is Small Business
exceptionCounter string Exception Counter
hasSBAProtest string Has SBA Protest
hasSizeChanged string Has Size Changed
predecessorsList List
predecessorsList contains below fields
Field Name Type Description
cageCode string CAGE Code
ncageCode string NCAGE Code
legalBusinessName string Legal Business Name
id string ID
samFacilitiesList List
samFacilitiesList contains below fields
Field Name Type Description
plantAddress object
plantAddress contains below fields
Field Name Type Description
line1 string Line 1
line2 string Line 2
city string City
stateOrProvince string State Or Province
zip string Zip
countryCode string Country Code
ownerName string Owner Name
ownerAddress object
ownerAddress contains below fields
Field Name Type Description
line1 string Line 1
line2 string Line 2
city string City
stateOrProvince string State Or Province
zip string Zip
countryCode string Country Code
samPointsOfContactList List
samPointsOfContactList contains below fields
Field Name Type Description
firstName string First Name
lastName string Last Name
title string Title
servicesRevenuesList List
servicesRevenuesList contains below fields
Field Name Type Description
id string ID
federalRevenueCode string Federal Revenue Code
federalRevenueDescription string Federal Revenue Description
nonFedRevenueCode string Non Fed Revenue Code
nonFedRevenueDescription string Non Fed Revenue Description
totalRevenueCode string Total Revenue Code
totalRevenueDescription string Total Revenue Description
softwareList List
softwareList contains below fields
Field Name Type Description
id string ID
name string Name
country string Country
productType string Product Type
urlList List URL List
v1
v2
v3
v4
financialAssistanceCertifications Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
grantsCertificationStatus string Grants Certification Status v1
v2
v3
v4
grantsCertifyingResponse string Grants Certifying Response v1
v2
v3
v4
certifierFirstName string Certifier First Name v1
v2
v3
v4
certifierLastName string Certifier Last Name v1
v2
v3
v4
certifierMiddleInitial string Certifier Middle Initial v1
v2
v3
v4
pdfLinks Sub Section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
farPDF string FAR PDF v1
v2
v3
v4
farAndDfarsPDF string FAR and DFARS PDF v1
v2
v3
v4
architectEngineeringPDF string Architect Engineering PDF v1
v2
v3
v4
financialAssistanceCertificationsPDF string Financial Assistance Certifications PDF v1
v2
v3
v4
pointsOfContact
governmentBusinessPOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
addressLine1 string Address Line 1 v1
v2
v3
v4
addressLine2 string Address Line 2 v1
v2
v3
v4
city string City v1
v2
v3
v4
stateOrProvinceCode string State or Province Code v1
v2
v3
v4
zipCode string Zip Code v1
v2
v3
v4
zipCodePlus4 string Zip Code Plus 4 v1
v2
v3
v4
countryCode string Country Code v1
v2
v3
v4
electronicBusinessPOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
addressLine1 string Address Line 1 v1
v2
v3
v4
addressLine2 string Address Line 2 v1
v2
v3
v4
city string City v1
v2
v3
v4
stateOrProvinceCode string State or Province Code v1
v2
v3
v4
zipCode string Zip Code v1
v2
v3
v4
zipCodePlus4 string Zip Code Plus 4 v1
v2
v3
v4
countryCode string Country Code v1
v2
v3
v4
governmentBusinessAlternatePOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
addressLine1 string Address Line 1 v1
v2
v3
v4
addressLine2 string Address Line 2 v1
v2
v3
v4
city string City v1
v2
v3
v4
stateOrProvinceCode string State or Province Code v1
v2
v3
v4
zipCode string Zip Code v1
v2
v3
v4
zipCodePlus4 string Zip Code Plus 4 v1
v2
v3
v4
countryCode string Country Code v1
v2
v3
v4
electronicBusinessAlternatePOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
addressLine1 string Address Line 1 v1
v2
v3
v4
addressLine2 string Address Line 2 v1
v2
v3
v4
city string City v1
v2
v3
v4
stateOrProvinceCode string State or Province Code v1
v2
v3
v4
zipCode string Zip Code v1
v2
v3
v4
zipCodePlus4 string Zip Code Plus 4 v1
v2
v3
v4
countryCode string Country Code v1
v2
v3
v4
pastPerformancePOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
addressLine1 string Address Line 1 v1
v2
v3
v4
addressLine2 string Address Line 2 v1
v2
v3
v4
city string City v1
v2
v3
v4
stateOrProvinceCode string State or Province Code v1
v2
v3
v4
zipCode string Zip Code v1
v2
v3
v4
zipCodePlus4 string Zip Code Plus 4 v1
v2
v3
v4
countryCode string Country Code v1
v2
v3
v4
pastPerformanceAlternatePOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
Sensitivity Level: Public, which constitutes publicly available entities and their unclassified data
addressLine1 string Address Line 1 v1
v2
v3
v4
addressLine2 string Address Line 2 v1
v2
v3
v4
city string City v1
v2
v3
v4
stateOrProvinceCode string State or Province Code v1
v2
v3
v4
zipCode string Zip Code v1
v2
v3
v4
zipCodePlus4 string Zip Code Plus 4 v1
v2
v3
v4
countryCode string Country Code v1
v2
v3
v4
partyPerformingCertificationPOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
addressLine1 string Address Line 1 v1
v2
v3
v4
addressLine2 string Address Line 2 v1
v2
v3
v4
city string City v1
v2
v3
v4
stateOrProvinceCode string State or Province Code v1
v2
v3
v4
zipCode string Zip Code v1
v2
v3
v4
zipCodePlus4 string Zip Code Plus 4 v1
v2
v3
v4
countryCode string Country Code v1
v2
v3
v4
soleProprietorshipPOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
accountsReceivablePOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
accountsPayablePOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
addressLine1 string Address Line 1 v1
v2
v3
v4
addressLine2 string Address Line 2 v1
v2
v3
v4
city string City v1
v2
v3
v4
stateOrProvinceCode string State or Province Code v1
v2
v3
v4
zipCode string Zip Code v1
v2
v3
v4
zipCodePlus4 string Zip Code Plus 4 v1
v2
v3
v4
countryCode string Country Code v1
v2
v3
v4
ediPOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
eliminationsPOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
addressLine1 string Address Line 1 v1
v2
v3
v4
addressLine2 string Address Line 2 v1
v2
v3
v4
city string City v1
v2
v3
v4
stateOrProvinceCode string State or Province Code v1
v2
v3
v4
zipCode string Zip Code v1
v2
v3
v4
zipCodePlus4 string Zip Code Plus 4 v1
v2
v3
v4
countryCode string Country Code v1
v2
v3
v4
salesPOC Sub section
Applicable to the entities that are registered
Field Name Type Description Applicable Versions
Sensitivity Level: FOUO, which constitutes both the publicly available entities and the entities that have opted out of public display with their CUI data
firstName string First Name v1
v2
v3
v4
middleInitial string Middle Initial v1
v2
v3
v4
lastName string Last Name v1
v2
v3
v4
title string Title v1
v2
v3
v4
usPhone string US Phone v1
v2
v3
v4
usPhoneExtension string US Phone Extension v1
v2
v3
v4
nonUSPhone string Non-US Phone v1
v2
v3
v4
fax string Fax v1
v2
v3
v4
email string Email v1
v2
v3
v4
addressLine1 string Address Line 1 v1
v2
v3
v4
addressLine2 string Address Line 2 v1
v2
v3
v4
city string City v1
v2
v3
v4
stateOrProvinceCode string State or Province Code v1
v2
v3
v4
zipCode string Zip Code v1
v2
v3
v4
zipCodePlus4 string Zip Code Plus 4 v1
v2
v3
v4
countryCode string Country Code v1
v2
v3
v4

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

Additional Help References

Go to SAM.gov Data Services for Reps and Certs Mapping and Data Dictionary documents.

HTTP Response Codes

The API will return one of the following responses:

HTTP Response Code Description
200 The API call is successful.
400 Application Level Error Messages:
  1. Invalid "Date" format:
    v1 or v2: Date should be specified in the format: MM/dd/YYYY.
    v3: "message":"Dates must be specified in the MM/DD/YYYY format.", "detail":"Any Date parameter must be provided in the MM/DD/YYYY format."
  2. Invalid Search Parameter:
    v1 or v2: "Invalid Input Parameters","detail":"< user-provided invalid parameter >"
    v3: "message":"The search parameter, < user-provided invalid parameter > does not exist.", "detail":"Please refer to https://open.gsa.gov/api/entity-api/ for a list of allowable search parameters."
  3. If 'includeSections', 'emailId' or 'format' is sent in the "q" parameter:
    v1 or v2: The parameters: 'includeSections', 'emailId' or 'format' are not permitted inside Query Param(q).

    If 'includeSections', 'emailId', 'format' or 'proceedingsData' is sent in the "q" parameter:
    v3: "message":"The search parameters 'includeSections','emailId','format' and 'proceedingsData' are not permitted inside Query Param(q)", "detail":"Please provide these parameters separately".
  4. More than 100 ueiSAM values are sent:
    v1 or v2: A maximum of 100 ueiSAM is allowed.
    v3: "message": "More than 100 UEI SAM are not allowed.", "detail": "Please limit the number of UEI SAM to 100."
  5. More than 100 CAGE values are sent:
    v1 or v2: A maximum of 100 CAGE Codes is allowed.
    v3: "message":"More than 100 CAGE Codes are not allowed.", "detail":"Please limit the number of CAGE Codes to 100."
  6. If "emailId" is sent on its own:
    v1 or v2: The parameter emailId must be provided in conjunction with the parameter format.
    v3: "message":"The search parameter 'emailId' must be provided in conjunction with the search parameter 'format.", "detail":"Users can opt for receiving the requested JSON/CSV files in their emails."
  7. If "entityEFTIndicator" is sent on its own:
    v1 or v2: entityEFTIndicator filter must be provided in conjunction with ueiSAM filter.
    v3: message":"The search parameter 'entityEFTIndicator' must be provided in conjunction with the search parameter 'ueiSAM'.", "detail":"The entityEFTIndicator parameter cannot be provided on its own."
  8. File size exceeded for JSON or CSV exports:
    v1 or v2: "Total Number of Records: < the total number > exceeded the maximum allowable limit: 1000000. Please provide a suitable search parameter to refine your search."
    v3: "message":"Total Number of Records: < the total number > exceeded the maximum allowable limit: 1000000. Please provide a suitable search parameter to refine your search.", "detail":"Count Exceeded Error"
  9. JSON or CSV file generation is in-progress:
    v1 or v2: File Processing in Progress. Please check again later.
    v3: "message": "The requested JSON or CSV file is not generated yet. Please try again later.", "details": "Larger files will take some time to process."
  10. Using an expired Token for downloading JSON or CSV files:
    v1 or v2: title":"Requested File is Expired and cannot be downloaded","detail":"We are not able to process your request"
    v3: "message":"The requested JSON or CSV file token is expired.","detail":"Please verify the token number."
  11. More than 10,000 records are requested via "page" and "size" parameters:
    v1 or v2: "title":"Results Too Large","detail":"The Page and Size search has exceeded 10,000 records (Page multiplied by Size). Please change the Page and Size accordingly."
    v3: "message":"Results Too Large","detail":"The Page and Size search has exceeded 10,000 records (Page multiplied by Size). Please change the Page and Size accordingly."
  12. More than 10 for "size" is requested:
    v1 or v2: "title":"size is < user requested size >","detail":"Size Cannot Exceed 10 Records"
    v3: "message":"size is < user requested size >","detail":"Size Cannot Exceed 10 Records"
  13. Missing "Basic Auth" under "Authorization" and missing System Account credentials:
    v1 or v2: No system account credentials are provided. Please provide credentials via basic authentication.
  14. Different IP Address than that mentioned in the System Account:
    v1 or v2: IP Addresses associated with this System Account are different from that sending the request. Please submit your requests from a valid system.
  15. API Key does not belong to the System Account:
    v1 or v2: System Account and API Key you have provided do not match. Please visit your System Account and obtain the API Key from there.
  16. System Account has a different value for "Type of Connection":
    v1 or v2: "title": "Connection type failure", "detail": "Insufficient privileges to perform the operation - System account must have Type of Connection as Restful",
    v3: "message": "Connection type failure", "detail": "Insufficient privileges to perform the operation - System account must have Type of Connection as Restful",
  17. If GET is used with System Accounts:
    v1 or v2: GET requests for Sensitive data are no longer supported. Please use POST requests to access the Sensitive Entity data.
    v3: "message": "Permission denied", "detail": "GET requests for Sensitive data are no longer supported. Please use POST requests to access the Sensitive Entity data.",
  18. Insufficient API Key privileges to download a JSON or CSV File:
    v1 or v2: The API Key is not authorized to access this < file type > Extract
    v3: The API Key is not authorized to access this < file type > Extract
  19. A non-existing Reps and Certs PDF file is requested:
    v1, v2, v3: The requested PDF File does not exist; the entity did not answer this type of Representations and Certifications data.
  20. If proceedingsData=Yes is sent on its own or in combination with includeSections=< a value other than integrityInformation >:
    v3: "message": "The search parameter 'proceedingsData' must be provided in conjunction with includeSections=integrityInformation."
  21. If proceedingsData=< a value other than Yes > is provided:
    v3: "message": "The search parameter 'proceedingsData' contains an invalid value - < user provided invalid value >."
  22. If proceedingsData parameter is sent in combination with samRegistered=No:
    v3: "message": "The search parameter 'proceedingsData' does not apply to unregistered (samRegistered=No) entities."
401 1. Missing "Basic Auth" under "Authorization" and missing System Account credentials:
v3: "message": "The System Account Credentials are missing", "detail": "Please provide valid System Account User Name and Password.",

2. Providing "Basic Auth" under "Authorization", but missing or invalid System Account credentials:
v1 or v2: Unauthorized
v3: Unauthorized

3. Different IP Address than that mentioned in the System Account:
v3: "message": "Invalid IP Address", "detail": "The IP Addresses sending the API requests and the ones associated with the System Account must be the same.",

4. API Key does not belong to the System Account:
v3: "message": "System Account-API Key Mismatch", "detail": "The System Account and API Key you have provided do not match. Please refer to your System Account and obtain the API Key from there.",
403 Forbidden 1. Missing API Key:
v1 or v2: No api_key was supplied in request body. Please submit with a valid API key.
v3: No api_key was supplied in request body. Please submit with a valid API key.

2. An invalid API Key:
v1 or v2: An invalid API key was supplied. Please submit with a valid API key.
v3: An invalid API key was supplied. Please submit with a valid API key.
406 1. Missing Accept Header:
v1 or v2: "title": "Invalid Accept Header", "detail": "Request Header parameter needs to pass valid Accept value",
v3: "message": "Missing or Invalid Request Header, Accept", "detail": "The allowable values are application/json, application/zip.",

2. Invalid Accept Header:
v1 or v2: "title": "Invalid Accept Header", "detail": "Could not find acceptable representation",
v3: "title": "Invalid Accept Header","detail": "Could not find acceptable representation",
415 Unsupported Media Type Missing or Invalid Content-Type Header:
v1 or v2: "title": "Invalid Content-Type Header", "detail": "Request Header parameter needs to pass valid Content-Type value",
v3:"message": "Missing or Invalid Request Header, Content_Type", "detail": "The allowable value is application/json.",
NOTE:
Error messages in v1 and v2 are returned in this fashion: httpStatus, title, detail, errorCode, source
Error messages in v3 are returned in this fashion: Status, timestamp, message, detail, errorCode, transaction_id

Back to top

Examples

Example 1: Post April 3rd, 2022, I would like to obtain the registered entities that have undergone Address change and Name change resulting from EVS Monitoring.

Request URL Production URL: https://api.sam.gov/entity-information/v2/entities?api_key=< FOUO API Key >&ueiSAM=[ZQGGHJH74DW7~JH9ZARNKWKC7]&includeSections=entityRegistration,coreData

https://api.sam.gov/entity-information/v3/entities?api_key= < FOUO API Key >&ueiSAM=[ZQGGHJH74DW7~JH9ZARNKWKC7]&includeSections=entityRegistration,coreData

Alpha URL: https://api-alpha.sam.gov/entity-information/v2/entities?api_key=< FOUO API Key >&ueiSAM=[ZQGGHJH74DW7~JH9ZARNKWKC7]&includeSections=entityRegistration,coreData

https://api-alpha.sam.gov/entity-information/v3/entities?api_key=< FOUO API Key >&ueiSAM=[ZQGGHJH74DW7~JH9ZARNKWKC7]&includeSections=entityRegistration,coreData

Response (JSON Output) FOUO Response for the two records is provided in v2 and v3. 

An Entity with an Address Change resulting from EVS Monitoring in v2:

"entityData": [
{
"entityRegistration": {
"samRegistered": "Yes",
"ueiSAM": "ZQGGHJH74DW7",
"entityEFTIndicator": null,
"cageCode": "855J5",
"dodaac": null,
"legalBusinessName": "INTERNATIONAL BUSINESS MACHINES CORPORATION",
"dbaName": null,
"purposeOfRegistrationCode": "Z2",
"purposeOfRegistrationDesc": "All Awards",
"registrationStatus": "Active",
"registrationDate": "2018-07-24",
"lastUpdateDate": "2021-06-10",
"registrationExpirationDate": "2021-08-10",
"activationDate": "2020-08-13",
"ueiStatus": "Active",
"ueiExpirationDate": "2021-08-10",
"ueiCreationDate": "2021-06-25",
"noPublicDisplayFlag": "Y",
"exclusionStatusFlag": null,
"exclusionURL": null,
"dnbOpenData": "Y"
},
"coreData": {
"entityHierarchyInformation": {
"immediateParentEntity": {
"ueiSAM": null,
"legalBusinessName": null,
"physicalAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"stateOrProvinceCode": null,
"countryCode": null,
"zipCode": null,
"zipCodePlus4": null
},
"phoneNumber": null
},
"intermediateParentEntities": [
{
"domesticParent": {
"ueiSAM": "J64CSQTQNRC1",
"legalBusinessName": "International Business Machines Corporation",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
},
"hqParent": {
"ueiSAM": "J64CSQTQNRC1",
"legalBusinessName": "International Business Machines Corporation",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
}
}
],
"ultimateParentEntity": {
"ueiSAM": "J64CSQTQNRC1",
"legalBusinessName": "International Business Machines Corporation",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
},
"evsMonitoring": {
"legalBusinessName": "International Business Machines Corporation",
"dbaName": null,
"outOfBusinessFlag": null,
"monitoringStatus": "Y",
"lastUpdated": "Y",
"addressLine1": "New Address Line 1",
"addressLine2": "New Address Line 2",
"city": "New City",
"postalCode": "New Zip/Postal Code",
"stateOrProvinceCode": "New State/Province",
"countryCode": "New Country Code"
}
},
"federalHierarchy": {
"source": null,
"hierarchyDepartmentCode": null,
"hierarchyDepartmentName": null,
"hierarchyAgencyCode": null,
"hierarchyAgencyName": null,
"hierarchyOfficeCode": null
},
"entityInformation": {
"entityURL": "http://www.ibm.com/us/en",
"entityDivisionName": "IBM Global Business Services",
"entityDivisionNumber": "16",
"entityStartDate": "1911-01-01",
"fiscalYearEndCloseDate": "12/31",
"submissionDate": "2020-08-10",
},
"physicalAddress": {
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
"mailingAddress": {
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
"congressionalDistrict": "00",
"generalInformation": {
"agencyBusinessPurposeCode": null,
"agencyBusinessPurposeDesc": null,
"entityStructureCode": "2L",
"entityStructureDesc": "Corporate Entity (Not Tax Exempt)",
"entityTypeCode": "F",
"entityTypeDesc": "Business or Organization",
"profitStructureCode": "2X",
"profitStructureDesc": "For Profit Organization",
"organizationStructureCode": null,
"organizationStructureDesc": null,
"stateOfIncorporationCode": "NY",
"stateOfIncorporationDesc": "NEW YORK",
"countryOfIncorporationCode": "USA",
"countryOfIncorporationDesc": "UNITED STATES",
"companySecurityLevelCode": "94",
"companySecurityLevelDesc": "Government Top Secret",
"highestEmployeeSecurityLevelCode": "94",
"highestEmployeeSecurityLevelDesc": "Government Top Secret"
},
"businessTypes": {
"businessTypeList": [
{
"businessTypeCode": "2X",
"businessTypeDesc": "For Profit Organization"
},
{
"businessTypeCode": "F",
"businessTypeDesc": "Business or Organization"
}
],
"sbaBusinessTypeList": [
{
"sbaBusinessTypeCode": null,
"sbaBusinessTypeDesc": null,
"certificationEntryDate": null,
"certificationExitDate": null
}
]
},
"financialInformation": {
"creditCardUsage": "N",
"debtSubjectToOffset": "N",
},

            }
        },

An Entity with an Address Change resulting from EVS Monitoring in v3:

"entityData": [
{
"entityRegistration": {
"samRegistered": "Yes",
"ueiSAM": "ZQGGHJH74DW7",
"entityEFTIndicator": null,
"cageCode": "855J5",
"dodaac": null,
"legalBusinessName": "INTERNATIONAL BUSINESS MACHINES CORPORATION",
"dbaName": null,
"purposeOfRegistrationCode": "Z2",
"purposeOfRegistrationDesc": "All Awards",
"registrationStatus": "Active",
"evsSource": "E&Y",
"registrationDate": "2018-07-24",
"lastUpdateDate": "2021-06-10",
"registrationExpirationDate": "2021-08-10",
"activationDate": "2020-08-13",
"ueiStatus": "Active",
"ueiExpirationDate": "2021-08-10",
"ueiCreationDate": "2021-06-25",
"publicDisplayFlag": "Y",
"exclusionStatusFlag": "N",
"exclusionURL": null,
"dnbOpenData": "Y"
},
"coreData": {
"entityHierarchyInformation": {
"immediateParentEntity": {
"ueiSAM": null,
"legalBusinessName": null,
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"stateOrProvinceCode": null,
"countryCode": null,
"zipCode": null,
"zipCodePlus4": null
},
"phoneNumber": null
},
"intermediateParentEntities": [
{
"domesticParent": {
"ueiSAM": "J64CSQTQNRC1",
"legalBusinessName": "International Business Machines Corporation",
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
},
"hqParent": {
"ueiSAM": "J64CSQTQNRC1",
"legalBusinessName": "International Business Machines Corporation",
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
}
}
],
"ultimateParentEntity": {
"ueiSAM": "J64CSQTQNRC1",
"legalBusinessName": "International Business Machines Corporation",
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
},
"evsMonitoring": {
"legalBusinessName": "International Business Machines Corporation",
"dbaName": null,
"outOfBusinessFlag": null,
"monitoringStatus": "Y",
"lastUpdated": "Y",
"addressLine1": "New Address Line 1",
"addressLine2": "New Address Line 2",
"city": "New City",
"postalCode": "New Zip/Postal Code",
"stateOrProvinceCode": "New State/Province",
"countryCode": "New Country Code"
}
},
"federalHierarchy": {
"source": null,
"hierarchyDepartmentCode": null,
"hierarchyDepartmentName": null,
"hierarchyAgencyCode": null,
"hierarchyAgencyName": null,
"hierarchyOfficeCode": null
},
"entityInformation": {
"entityURL": "http://www.ibm.com/us/en",
"entityDivisionName": "IBM Global Business Services",
"entityDivisionNumber": "16",
"entityStartDate": "1911-01-01",
"fiscalYearEndCloseDate": "12/31",
"submissionDate": "2020-08-10",
},
"physicalAddress": {
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
"mailingAddress": {
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
"congressionalDistrict": "00",
"generalInformation": {
"agencyBusinessPurposeCode": null,
"agencyBusinessPurposeDesc": null,
"entityStructureCode": "2L",
"entityStructureDesc": "Corporate Entity (Not Tax Exempt)",
"entityTypeCode": "F",
"entityTypeDesc": "Business or Organization",
"profitStructureCode": "2X",
"profitStructureDesc": "For Profit Organization",
"organizationStructureCode": null,
"organizationStructureDesc": null,
"stateOfIncorporationCode": "NY",
"stateOfIncorporationDesc": "NEW YORK",
"countryOfIncorporationCode": "USA",
"countryOfIncorporationDesc": "UNITED STATES",
"companySecurityLevelCode": "94",
"companySecurityLevelDesc": "Government Top Secret",
"highestEmployeeSecurityLevelCode": "94",
"highestEmployeeSecurityLevelDesc": "Government Top Secret"
},
"businessTypes": {
"businessTypeList": [
{
"businessTypeCode": "2X",
"businessTypeDesc": "For Profit Organization"
},
{
"businessTypeCode": "F",
"businessTypeDesc": "Business or Organization"
}
],
"sbaBusinessTypeList": [
{
"sbaBusinessTypeCode": null,
"sbaBusinessTypeDesc": null,
"certificationEntryDate": null,
"certificationExitDate": null
}
]
},
"financialInformation": {
"creditCardUsage": "N",
"debtSubjectToOffset": "N",
},

            }
        },

An Entity with a Name Change resulting from EVS Monitoring in v2:

"entityData": [
{
"entityRegistration": {
"samRegistered": "Yes",
"ueiSAM": "JH9ZARNKWKC7",
"entityEFTIndicator": null,
"cageCode": "7X7G0",
"dodaac": null,
"legalBusinessName": "IBM Southeast Employees' Credit Union",
"dbaName": null,
"purposeOfRegistrationCode": "Z1",
"purposeOfRegistrationDesc": "Federal Assistance Awards",
"registrationStatus": "Active",
"registrationDate": "2017-07-27",
"lastUpdateDate": "2021-03-11",
"registrationExpirationDate": "2022-03-03",
"activationDate": "2021-03-05",
"ueiStatus": "Active",
"ueiExpirationDate": "2022-03-03",
"ueiCreationDate": "2021-06-25",
"noPublicDisplayFlag": "N",
"exclusionStatusFlag": null,
"exclusionURL": null,
"dnbOpenData": "Y"
},
"coreData": {
"entityHierarchyInformation": {
"immediateParentEntity": {
"ueiSAM": null,
"legalBusinessName": null,
"physicalAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"stateOrProvinceCode": null,
"countryCode": null,
"zipCode": null,
"zipCodePlus4": null
},
"phoneNumber": null
},
"intermediateParentEntities": [
{
"domesticParent": {
"ueiSAM": "JH9ZARNKWKC7",
"legalBusinessName": "IBM Southeast Employees' Credit Union",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
},
"hqParent": {
"ueiSAM": "JH9ZARNKWKC7",
"legalBusinessName": "IBM Southeast Employees' Credit Union",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
}
}
],
"ultimateParentEntity": {
"ueiSAM": "JH9ZARNKWKC7",
"legalBusinessName": "IBM Southeast Employees' Credit Union",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
},
"evsMonitoring": {
"legalBusinessName": "International Business Machines CORPORATION",
"dbaName": null,
"outOfBusinessFlag": null,
"monitoringStatus": "Y",
"lastUpdated": "Y",
"addressLine1": null,
"addressLine2": null,
"city": null,
"postalCode": null,
"stateOrProvinceCode": null,
"countryCode": null
}
},
"federalHierarchy": {
"source": null,
"hierarchyDepartmentCode": null,
"hierarchyDepartmentName": null,
"hierarchyAgencyCode": null,
"hierarchyAgencyName": null,
"hierarchyOfficeCode": null
},
"entityInformation": {
"entityURL": "www.ithinkfi.org",
"entityDivisionName": null,
"entityDivisionNumber": null,
"entityStartDate": "1969-09-03",
"fiscalYearEndCloseDate": "12/31",
"submissionDate": "2021-03-03",
},
"physicalAddress": {
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
"mailingAddress": {
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
"congressionalDistrict": "00",
"generalInformation": {
"agencyBusinessPurposeCode": null,
"agencyBusinessPurposeDesc": null,
"entityStructureCode": "8H",
"entityStructureDesc": "Corporate Entity (Tax Exempt)",
"entityTypeCode": "F",
"entityTypeDesc": "Business or Organization",
"profitStructureCode": "A8",
"profitStructureDesc": "Non-Profit Organization",
"organizationStructureCode": null,
"organizationStructureDesc": null,
"stateOfIncorporationCode": "FL",
"stateOfIncorporationDesc": "FLORIDA",
"countryOfIncorporationCode": "USA",
"countryOfIncorporationDesc": "UNITED STATES",
"companySecurityLevelCode": null,
"companySecurityLevelDesc": null,
"highestEmployeeSecurityLevelCode": null,
"highestEmployeeSecurityLevelDesc": null
},
"businessTypes": {
"businessTypeList": [
{
"businessTypeCode": "A8",
"businessTypeDesc": "Non-Profit Organization"
},
{
"businessTypeCode": "F",
"businessTypeDesc": "Business or Organization"
}
],
"sbaBusinessTypeList": [
{
"sbaBusinessTypeCode": null,
"sbaBusinessTypeDesc": null,
"certificationEntryDate": null,
"certificationExitDate": null
}
]
},
"financialInformation": {
"creditCardUsage": "N",
"debtSubjectToOffset": "N",

                },
                
            }
        }
    ],

An Entity with a Name Change resulting from EVS Monitoring in v3:

"entityData": [
{
"entityRegistration": {
"samRegistered": "Yes",
"ueiSAM": "JH9ZARNKWKC7",
"entityEFTIndicator": null,
"cageCode": "7X7G0",
"dodaac": null,
"legalBusinessName": "IBM Southeast Employees' Credit Union",
"dbaName": null,
"purposeOfRegistrationCode": "Z1",
"purposeOfRegistrationDesc": "Federal Assistance Awards",
"registrationStatus": "Active",
"evsSource": "E&Y",
"registrationDate": "2017-07-27",
"lastUpdateDate": "2021-03-11",
"registrationExpirationDate": "2022-03-03",
"activationDate": "2021-03-05",
"ueiStatus": "Active",
"ueiExpirationDate": "2022-03-03",
"ueiCreationDate": "2021-06-25",
"publicDisplayFlag": "N",
"exclusionStatusFlag": "N",
"exclusionURL": null,
"dnbOpenData": "Y"
},
"coreData": {
"entityHierarchyInformation": {
"immediateParentEntity": {
"ueiSAM": null,
"legalBusinessName": null,
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"stateOrProvinceCode": null,
"countryCode": null,
"zipCode": null,
"zipCodePlus4": null
},
"phoneNumber": null
},
"intermediateParentEntities": [
{
"domesticParent": {
"ueiSAM": "JH9ZARNKWKC7",
"legalBusinessName": "IBM Southeast Employees' Credit Union",
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
},
"hqParent": {
"ueiSAM": "JH9ZARNKWKC7",
"legalBusinessName": "IBM Southeast Employees' Credit Union",
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
}
}
],
"ultimateParentEntity": {
"ueiSAM": "JH9ZARNKWKC7",
"legalBusinessName": "IBM Southeast Employees' Credit Union",
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": "Address Line1",
"addressLine2": null,
"city": "City",
"stateOrProvinceCode": "XX",
"countryCode": "XXX",
"zipCode": "11111",
"zipCodePlus4": "1111"
},
"phoneNumber": null
},
"evsMonitoring": {
"legalBusinessName": "International Business Machines CORPORATION",
"dbaName": null,
"outOfBusinessFlag": null,
"monitoringStatus": "Y",
"lastUpdated": "Y",
"addressLine1": null,
"addressLine2": null,
"city": null,
"postalCode": null,
"stateOrProvinceCode": null,
"countryCode": null
}
},
"federalHierarchy": {
"source": null,
"hierarchyDepartmentCode": null,
"hierarchyDepartmentName": null,
"hierarchyAgencyCode": null,
"hierarchyAgencyName": null,
"hierarchyOfficeCode": null
},
"entityInformation": {
"entityURL": "www.ithinkfi.org",
"entityDivisionName": null,
"entityDivisionNumber": null,
"entityStartDate": "1969-09-03",
"fiscalYearEndCloseDate": "12/31",
"submissionDate": "2021-03-03",
},
"physicalAddress": {
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
"mailingAddress": {
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
"congressionalDistrict": "00",
"generalInformation": {
"agencyBusinessPurposeCode": null,
"agencyBusinessPurposeDesc": null,
"entityStructureCode": "8H",
"entityStructureDesc": "Corporate Entity (Tax Exempt)",
"entityTypeCode": "F",
"entityTypeDesc": "Business or Organization",
"profitStructureCode": "A8",
"profitStructureDesc": "Non-Profit Organization",
"organizationStructureCode": null,
"organizationStructureDesc": null,
"stateOfIncorporationCode": "FL",
"stateOfIncorporationDesc": "FLORIDA",
"countryOfIncorporationCode": "USA",
"countryOfIncorporationDesc": "UNITED STATES",
"companySecurityLevelCode": null,
"companySecurityLevelDesc": null,
"highestEmployeeSecurityLevelCode": null,
"highestEmployeeSecurityLevelDesc": null
},
"businessTypes": {
"businessTypeList": [
{
"businessTypeCode": "A8",
"businessTypeDesc": "Non-Profit Organization"
},
{
"businessTypeCode": "F",
"businessTypeDesc": "Business or Organization"
}
],
"sbaBusinessTypeList": [
{
"sbaBusinessTypeCode": null,
"sbaBusinessTypeDesc": null,
"certificationEntryDate": null,
"certificationExitDate": null
}
]
},
"financialInformation": {
"creditCardUsage": "N",
"debtSubjectToOffset": "N",

                },
                
            }
        }
    ],

Example 2: Post April 3rd, 2022, I would like to obtain the publicly available not registered/ID Assigned entities.

Request URL Production URL: https://api.sam.gov/entity-information/v3/entities?api_key=< API Key >&samRegistered=No&includeSections=entityRegistration

Alpha URL: https://api-alpha.sam.gov/entity-information/v3/entities?api_key=< API Key >&samRegistered=No&includeSections=entityRegistration

Response (JSON Output) 

"entityData": [
    {
        "entityRegistration": {
        "samRegistered": "No",
        "ueiSAM": "JF19T45AM8F2",
        "cageCode": "null",
        "legalBusinessName": "Anchored Consulting Group LLC",
        "registrationStatus": "Active",
        "evsSource": null,
        "ueiStatus": "Active",
        "ueiExpirationDate": null,
        "ueiCreationDate": "2021-07-20",
        "publicDisplayFlag": "Y",
        "dnbOpenData": "Y"
    }

Example 3: Get the “entityRegistration” and “coreData” sections for all the “Joint Venture Women” or “Asian-Pacific” Entities that are registered for “All Awards” or “Federal Assistance Awards”.

Request URL Production URL: https://api.sam.gov/entity-information/v2/entities?api_key=< A valid FOUO API Key >&purposeOfRegistrationCode=Z1~Z2&q=(businessTypeDesc:'Joint Venture Women' OR businessTypeDesc:'Asian-Pacific')&includeSections=entityRegistration,coreData

https://api.sam.gov/entity-information/v3/entities?api_key=< A valid FOUO API Key >&purposeOfRegistrationCode=Z1~Z2&q=(businessTypeDesc:'Joint Venture Women' OR businessTypeDesc:'Asian-Pacific')&includeSections=entityRegistration,coreData

Alpha URL: https://api-alpha.sam.gov/entity-information/v2/entities?< A valid FOUO API Key >&purposeOfRegistrationCode=Z1~Z2&q=(businessTypeDesc:'Joint Venture Women' OR businessTypeDesc:'Asian-Pacific')&includeSections=entityRegistration,coreData

https://api-alpha.sam.gov/entity-information/v3/entities?< A valid FOUO API Key >&purposeOfRegistrationCode=Z1~Z2&q=(businessTypeDesc:'Joint Venture Women' OR businessTypeDesc:'Asian-Pacific')&includeSections=entityRegistration,coreData

Response (JSON Output) FOUO Response for one record is provided as an example in v2 and v3. 

V2:
    "entityData": [
        {
            "entityRegistration": {
                "samRegistered": "Yes",
                "ueiSAM": "V4EUJ1MPVH45",
                "entityEFTIndicator": null,
                "cageCode": "92G16",
                "dodaac": null,
                "legalBusinessName": "HH Real Estate Properties Corporation",
                "dbaName": null,
                "purposeOfRegistrationCode": "Z1",
                "purposeOfRegistrationDesc": "Federal Assistance Awards",
                "registrationStatus": "Active",
                "registrationDate": "2021-06-23",
                "lastUpdateDate": "2021-06-24",
                "registrationExpirationDate": "2022-06-23",
                "activationDate": "2021-06-24",
                "ueiStatus": "Active",
                "ueiExpirationDate": "2022-06-23",
                "ueiCreationDate": "2021-06-25",
                "noPublicDisplayFlag": "Y",
                "exclusionStatusFlag": null,
                "exclusionURL": null,
                "dnbOpenData": "Y"
            },
            "coreData": {
                "entityHierarchyInformation": {
                    "immediateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "intermediateParentEntities": [
                        {
                            "domesticParent": {
                                "ueiSAM": null,
                                "legalBusinessName": null,
                                "physicalAddress": {
                                    "addressLine1": null,
                                    "addressLine2": null,
                                    "city": null,
                                    "stateOrProvinceCode": null,
                                    "countryCode": null,
                                    "zipCode": null,
                                    "zipCodePlus4": null
                                },
                                "phoneNumber": null
                            },
                            "hqParent": {
                                "ueiSAM": null,
                                "legalBusinessName": null,
                                "physicalAddress": {
                                    "addressLine1": null,
                                    "addressLine2": null,
                                    "city": null,
                                    "stateOrProvinceCode": null,
                                    "countryCode": null,
                                    "zipCode": null,
                                    "zipCodePlus4": null
                                },
                                "phoneNumber": null
                            }
                        }
                    ],
                    "ultimateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "evsMonitoring": {
                        "legalBusinessName": null,
                        "dbaName": null,
                        "outOfBusinessFlag": null,
                        "monitoringStatus": null,
                        "lastUpdated": null,
                        "addressLine1": null,
                        "addressLine2": null,
                        "city": null,
                        "postalCode": null,
                        "stateOrProvinceCode": null,
                        "countryCode": null
                    }
                },
                "federalHierarchy": {
                    "source": null,
                    "hierarchyDepartmentCode": null,
                    "hierarchyDepartmentName": null,
                    "hierarchyAgencyCode": null,
                    "hierarchyAgencyName": null,
                    "hierarchyOfficeCode": null
                },
                "entityInformation": {
                    "entityURL": null,
                    "entityDivisionName": null,
                    "entityDivisionNumber": null,
                    "entityStartDate": "2021-05-17",
                    "fiscalYearEndCloseDate": "12/31",
                    "submissionDate": "2021-06-23",
                },
                "physicalAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "mailingAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "congressionalDistrict": "09",
                "generalInformation": {
                    "agencyBusinessPurposeCode": null,
                    "agencyBusinessPurposeDesc": null,
                    "entityStructureCode": "2L",
                    "entityStructureDesc": "Corporate Entity (Not Tax Exempt)",
                    "entityTypeCode": "F",
                    "entityTypeDesc": "Business or Organization",
                    "profitStructureCode": "2X",
                    "profitStructureDesc": "For Profit Organization",
                    "organizationStructureCode": null,
                    "organizationStructureDesc": null,
                    "stateOfIncorporationCode": "TN",
                    "stateOfIncorporationDesc": "TENNESSEE",
                    "countryOfIncorporationCode": "USA",
                    "countryOfIncorporationDesc": "UNITED STATES",
                    "companySecurityLevelCode": null,
                    "companySecurityLevelDesc": null,
                    "highestEmployeeSecurityLevelCode": null,
                    "highestEmployeeSecurityLevelDesc": null
                },
                "businessTypes": {
                    "businessTypeList": [
                        {
                            "businessTypeCode": "23",
                            "businessTypeDesc": "Minority Owned Business"
                        },
                        {
                            "businessTypeCode": "2X",
                            "businessTypeDesc": "For Profit Organization"
                        },
                        {
                            "businessTypeCode": "8C",
                            "businessTypeDesc": "Joint Venture Women Owned Small Business"
                        },
                        {
                            "businessTypeCode": "8W",
                            "businessTypeDesc": "Woman Owned Small Business"
                        },
                        {
                            "businessTypeCode": "A2",
                            "businessTypeDesc": "Woman Owned Business"
                        },
                        {
                            "businessTypeCode": "F",
                            "businessTypeDesc": "Business or Organization"
                        },
                        {
                            "businessTypeCode": "HK",
                            "businessTypeDesc": "Community Development Corporation Owned Firm"
                        },
                        {
                            "businessTypeCode": "OY",
                            "businessTypeDesc": "Black American Owned"
                        }
                    ],
                    "sbaBusinessTypeList": [
                        {
                            "sbaBusinessTypeCode": null,
                            "sbaBusinessTypeDesc": null,
                            "certificationEntryDate": null,
                            "certificationExitDate": null
                        }
                    ]
                },
                "financialInformation": {
                  "creditCardUsage": "N",
                  "debtSubjectToOffset": null
                }
              }
            }

"links": {
"selfLink": "https://api.sam.gov/entity-information/v2/entities?purposeOfRegistrationCode=Z1%7EZ2&q=%28businessTypeDesc%3A%27Joint+Venture+Women%27+OR+businessTypeDesc%3A%27Asian-Pacific%27%29&includeSections=entityRegistration%2CcoreData&page=0&size=10",
"nextLink": "https://api.sam.gov/entity-information/v2/entities?purposeOfRegistrationCode=Z1%7EZ2&q=%28businessTypeDesc%3A%27Joint+Venture+Women%27+OR+businessTypeDesc%3A%27Asian-Pacific%27%29&includeSections=entityRegistration%2CcoreData&page=1&size=10"
}
}
V3:
"entityData": [
{
"entityRegistration": {
"samRegistered": "Yes",
"ueiSAM": "V4EUJ1MPVH45",
"entityEFTIndicator": null,
"cageCode": "92G16",
"dodaac": null,
"legalBusinessName": "HH Real Estate Properties Corporation",
"dbaName": null,
"purposeOfRegistrationCode": "Z1",
"purposeOfRegistrationDesc": "Federal Assistance Awards",
"registrationStatus": "Active",
"evsSource": "E&Y",
"registrationDate": "2021-06-23",
"lastUpdateDate": "2021-06-24",
"registrationExpirationDate": "2022-06-23",
"activationDate": "2021-06-24",
"ueiStatus": "Active",
"ueiExpirationDate": "2022-06-23",
"ueiCreationDate": "2021-06-25",
"publicDisplayFlag": "Y",
"exclusionStatusFlag": "N",
"exclusionURL": null,
"dnbOpenData": "Y"
},
"coreData": {
"entityHierarchyInformation": {
"immediateParentEntity": {
"ueiSAM": null,
"legalBusinessName": null,
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"stateOrProvinceCode": null,
"countryCode": null,
"zipCode": null,
"zipCodePlus4": null
},
"phoneNumber": null
},
"intermediateParentEntities": [
{
"domesticParent": {
"ueiSAM": null,
"legalBusinessName": null,
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"stateOrProvinceCode": null,
"countryCode": null,
"zipCode": null,
"zipCodePlus4": null
},
"phoneNumber": null
},
"hqParent": {
"ueiSAM": null,
"legalBusinessName": null,
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"stateOrProvinceCode": null,
"countryCode": null,
"zipCode": null,
"zipCodePlus4": null
},
"phoneNumber": null
}
}
],
"ultimateParentEntity": {
"ueiSAM": null,
"legalBusinessName": null,
"evsSource": "E&Y",
"physicalAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"stateOrProvinceCode": null,
"countryCode": null,
"zipCode": null,
"zipCodePlus4": null
},
"phoneNumber": null
},
"evsMonitoring": {
"legalBusinessName": null,
"dbaName": null,
"outOfBusinessFlag": null,
"monitoringStatus": null,
"lastUpdated": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"postalCode": null,
"stateOrProvinceCode": null,
"countryCode": null
}
},
"federalHierarchy": {
"source": null,
"hierarchyDepartmentCode": null,
"hierarchyDepartmentName": null,
"hierarchyAgencyCode": null,
"hierarchyAgencyName": null,
"hierarchyOfficeCode": null
},
"entityInformation": {
"entityURL": null,
"entityDivisionName": null,
"entityDivisionNumber": null,
"entityStartDate": "2021-05-17",
"fiscalYearEndCloseDate": "12/31",
"submissionDate": "2021-06-23",
},
"physicalAddress": {
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
"mailingAddress": {
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
"congressionalDistrict": "09",
"generalInformation": {
"agencyBusinessPurposeCode": null,
"agencyBusinessPurposeDesc": null,
"entityStructureCode": "2L",
"entityStructureDesc": "Corporate Entity (Not Tax Exempt)",
"entityTypeCode": "F",
"entityTypeDesc": "Business or Organization",
"profitStructureCode": "2X",
"profitStructureDesc": "For Profit Organization",
"organizationStructureCode": null,
"organizationStructureDesc": null,
"stateOfIncorporationCode": "TN",
"stateOfIncorporationDesc": "TENNESSEE",
"countryOfIncorporationCode": "USA",
"countryOfIncorporationDesc": "UNITED STATES",
"companySecurityLevelCode": null,
"companySecurityLevelDesc": null,
"highestEmployeeSecurityLevelCode": null,
"highestEmployeeSecurityLevelDesc": null
},
"businessTypes": {
"businessTypeList": [
{
"businessTypeCode": "23",
"businessTypeDesc": "Minority Owned Business"
},
{
"businessTypeCode": "2X",
"businessTypeDesc": "For Profit Organization"
},
{
"businessTypeCode": "8C",
"businessTypeDesc": "Joint Venture Women Owned Small Business"
},
{
"businessTypeCode": "8W",
"businessTypeDesc": "Woman Owned Small Business"
},
{
"businessTypeCode": "A2",
"businessTypeDesc": "Woman Owned Business"
},
{
"businessTypeCode": "F",
"businessTypeDesc": "Business or Organization"
},
{
"businessTypeCode": "HK",
"businessTypeDesc": "Community Development Corporation Owned Firm"
},
{
"businessTypeCode": "OY",
"businessTypeDesc": "Black American Owned"
}
],
"sbaBusinessTypeList": [
{
"sbaBusinessTypeCode": null,
"sbaBusinessTypeDesc": null,
"certificationEntryDate": null,
"certificationExitDate": null
}
]
},
"financialInformation": {
"creditCardUsage": "N",
"debtSubjectToOffset": null
}
}
},

"links": {
"selfLink": "https://api.sam.gov/entity-information/v3/entities?purposeOfRegistrationCode=Z1%7EZ2&q=%28businessTypeDesc%3A%27Joint+Venture+Women%27+OR+businessTypeDesc%3A%27Asian-Pacific%27%29&includeSections=entityRegistration%2CcoreData&page=0&size=10",
"nextLink": "https://api.sam.gov/entity-information/v3/entities?purposeOfRegistrationCode=Z1%7EZ2&q=%28businessTypeDesc%3A%27Joint+Venture+Women%27+OR+businessTypeDesc%3A%27Asian-Pacific%27%29&includeSections=entityRegistration%2CcoreData&page=1&size=10"
}
}

Example 4: Get Entities with no Hierarchy, a small hierarchy, and a large Hierarchy.

Request URL Production URL: https://api.sam.gov/entity-information/v2/entities?api_key=< A valid FOUO API Key >&includeSections=entityRegistration,coreData

https://api.sam.gov/entity-information/v3/entities?api_key=< A valid FOUO API Key >&includeSections=entityRegistration,coreData

Alpha URL: https://api-alpha.sam.gov/entity-information/v2/entities?< A valid FOUO API Key >&includeSections=entityRegistration,coreData

https://api-alpha.sam.gov/entity-information/v3/entities?< A valid FOUO API Key >&includeSections=entityRegistration,coreData

Response (JSON Output) FOUO Responses for the three records are provided in v2 and v3. 

Entity with no Hierarchy in v2:

    "entityData": [
        {
            "entityRegistration": {
                "samRegistered": "Yes",
                "ueiSAM": "JK9SLMFNHKP4",
                "entityEFTIndicator": null,
                "cageCode": "87AW0",
                "dodaac": null,
                "legalBusinessName": "BRADLEY DEFENSE SOLUTIONS INC",
                "dbaName": null,
                "purposeOfRegistrationCode": "Z2",
                "purposeOfRegistrationDesc": "All Awards",
                "registrationStatus": "Inactive",
                "registrationDate": "2018-11-19",
                "lastUpdateDate": "2021-01-21",
                "registrationExpirationDate": "2019-11-19",
                "activationDate": "2018-11-29",
                "ueiStatus": "Active",
                "ueiExpirationDate": "2019-11-19",
                "ueiCreationDate": "2021-06-25",
                "noPublicDisplayFlag": "Y",
                "exclusionStatusFlag": null,
                "exclusionURL": null,
                "dnbOpenData": null
            },
            "coreData": {
                "entityHierarchyInformation": {
                    "immediateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "intermediateParentEntities": [
                        {
                            "domesticParent": {
                                "ueiSAM": null,
                                "legalBusinessName": null,
                                "physicalAddress": {
                                    "addressLine1": null,
                                    "addressLine2": null,
                                    "city": null,
                                    "stateOrProvinceCode": null,
                                    "countryCode": null,
                                    "zipCode": null,
                                    "zipCodePlus4": null
                                },
                                "phoneNumber": null
                            },
                            "hqParent": {
                                "ueiSAM": null,
                                "legalBusinessName": null,
                                "physicalAddress": {
                                    "addressLine1": null,
                                    "addressLine2": null,
                                    "city": null,
                                    "stateOrProvinceCode": null,
                                    "countryCode": null,
                                    "zipCode": null,
                                    "zipCodePlus4": null
                                },
                                "phoneNumber": null
                            }
                        }
                    ],
                    "ultimateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "evsMonitoring": {
                        "legalBusinessName": null,
                        "dbaName": null,
                        "outOfBusinessFlag": null,
                        "monitoringStatus": null,
                        "lastUpdated": null,
                        "addressLine1": null,
                        "addressLine2": null,
                        "city": null,
                        "postalCode": null,
                        "stateOrProvinceCode": null,
                        "countryCode": null
                    }
                },
                "federalHierarchy": {
                    "source": null,
                    "hierarchyDepartmentCode": null,
                    "hierarchyDepartmentName": null,
                    "hierarchyAgencyCode": null,
                    "hierarchyAgencyName": null,
                    "hierarchyOfficeCode": null
                },
                "entityInformation": {
                    "entityURL": null,
                    "entityDivisionName": null,
                    "entityDivisionNumber": null,
                    "entityStartDate": "2018-05-01",
                    "fiscalYearEndCloseDate": "05/01",
                    "submissionDate": "2018-11-19",
                },
                "physicalAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "mailingAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "congressionalDistrict": "00",
                "generalInformation": {
                    "agencyBusinessPurposeCode": null,
                    "agencyBusinessPurposeDesc": null,
                    "entityStructureCode": "2L",
                    "entityStructureDesc": "Corporate Entity (Not Tax Exempt)",
                    "entityTypeCode": "F",
                    "entityTypeDesc": "Business or Organization",
                    "profitStructureCode": "2X",
                    "profitStructureDesc": "For Profit Organization",
                    "organizationStructureCode": "MF",
                    "organizationStructureDesc": "Manufacturer of Goods",
                    "stateOfIncorporationCode": "NY",
                    "stateOfIncorporationDesc": "NEW YORK",
                    "countryOfIncorporationCode": "USA",
                    "countryOfIncorporationDesc": "UNITED STATES",
                    "companySecurityLevelCode": null,
                    "companySecurityLevelDesc": null,
                    "highestEmployeeSecurityLevelCode": null,
                    "highestEmployeeSecurityLevelDesc": null
                },
                "businessTypes": {
                    "businessTypeList": [
                        {
                            "businessTypeCode": "2X",
                            "businessTypeDesc": "For Profit Organization"
                        },
                        {
                            "businessTypeCode": "F",
                            "businessTypeDesc": "Business or Organization"
                        },
                        {
                            "businessTypeCode": "MF",
                            "businessTypeDesc": "Manufacturer of Goods"
                        }
                    ],
                    "sbaBusinessTypeList": [
                        {
                            "sbaBusinessTypeCode": null,
                            "sbaBusinessTypeDesc": null,
                            "certificationEntryDate": null,
                            "certificationExitDate": null
                        }
                    ]
                },
                "financialInformation": {
                    "creditCardUsage": "Y",
                    "debtSubjectToOffset": "N",
                },
                
            }
        }
    ],

Entity with no Hierarchy in v3:

    "entityData": [
        {
            "entityRegistration": {
                "samRegistered": "Yes",
                "ueiSAM": "JK9SLMFNHKP4",
                "entityEFTIndicator": null,
                "cageCode": "87AW0",
                "dodaac": null,
                "legalBusinessName": "BRADLEY DEFENSE SOLUTIONS INC",
                "dbaName": null,
                "purposeOfRegistrationCode": "Z2",
                "purposeOfRegistrationDesc": "All Awards",
                "registrationStatus": "Inactive",
                "evsSource": "E&Y",
                "registrationDate": "2018-11-19",
                "lastUpdateDate": "2021-01-21",
                "registrationExpirationDate": "2019-11-19",
                "activationDate": "2018-11-29",
                "ueiStatus": "Active",
                "ueiExpirationDate": "2019-11-19",
                "ueiCreationDate": "2021-06-25",
                "publicDisplayFlag": "Y",
                "exclusionStatusFlag": "N",
                "exclusionURL": null,
                "dnbOpenData": null
            },
            "coreData": {
                "entityHierarchyInformation": {
                    "immediateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "evsSource": "E&Y",
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "intermediateParentEntities": [
                        {
                            "domesticParent": {
                                "ueiSAM": null,
                                "legalBusinessName": null,
                                "evsSource": "E&Y",
                                "physicalAddress": {
                                    "addressLine1": null,
                                    "addressLine2": null,
                                    "city": null,
                                    "stateOrProvinceCode": null,
                                    "countryCode": null,
                                    "zipCode": null,
                                    "zipCodePlus4": null
                                },
                                "phoneNumber": null
                            },
                            "hqParent": {
                                "ueiSAM": null,
                                "legalBusinessName": null,
                                "evsSource": "E&Y",
                                "physicalAddress": {
                                    "addressLine1": null,
                                    "addressLine2": null,
                                    "city": null,
                                    "stateOrProvinceCode": null,
                                    "countryCode": null,
                                    "zipCode": null,
                                    "zipCodePlus4": null
                                },
                                "phoneNumber": null
                            }
                        }
                    ],
                    "ultimateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "evsSource": "E&Y",
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "evsMonitoring": {
                        "legalBusinessName": null,
                        "dbaName": null,
                        "outOfBusinessFlag": null,
                        "monitoringStatus": null,
                        "lastUpdated": null,
                        "addressLine1": null,
                        "addressLine2": null,
                        "city": null,
                        "postalCode": null,
                        "stateOrProvinceCode": null,
                        "countryCode": null
                    }
                },
                "federalHierarchy": {
                    "source": null,
                    "hierarchyDepartmentCode": null,
                    "hierarchyDepartmentName": null,
                    "hierarchyAgencyCode": null,
                    "hierarchyAgencyName": null,
                    "hierarchyOfficeCode": null
                },
                "entityInformation": {
                    "entityURL": null,
                    "entityDivisionName": null,
                    "entityDivisionNumber": null,
                    "entityStartDate": "2018-05-01",
                    "fiscalYearEndCloseDate": "05/01",
                    "submissionDate": "2018-11-19",
                },
                "physicalAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "mailingAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "congressionalDistrict": "00",
                "generalInformation": {
                    "agencyBusinessPurposeCode": null,
                    "agencyBusinessPurposeDesc": null,
                    "entityStructureCode": "2L",
                    "entityStructureDesc": "Corporate Entity (Not Tax Exempt)",
                    "entityTypeCode": "F",
                    "entityTypeDesc": "Business or Organization",
                    "profitStructureCode": "2X",
                    "profitStructureDesc": "For Profit Organization",
                    "organizationStructureCode": "MF",
                    "organizationStructureDesc": "Manufacturer of Goods",
                    "stateOfIncorporationCode": "NY",
                    "stateOfIncorporationDesc": "NEW YORK",
                    "countryOfIncorporationCode": "USA",
                    "countryOfIncorporationDesc": "UNITED STATES",
                    "companySecurityLevelCode": null,
                    "companySecurityLevelDesc": null,
                    "highestEmployeeSecurityLevelCode": null,
                    "highestEmployeeSecurityLevelDesc": null
                },
                "businessTypes": {
                    "businessTypeList": [
                        {
                            "businessTypeCode": "2X",
                            "businessTypeDesc": "For Profit Organization"
                        },
                        {
                            "businessTypeCode": "F",
                            "businessTypeDesc": "Business or Organization"
                        },
                        {
                            "businessTypeCode": "MF",
                            "businessTypeDesc": "Manufacturer of Goods"
                        }
                    ],
                    "sbaBusinessTypeList": [
                        {
                            "sbaBusinessTypeCode": null,
                            "sbaBusinessTypeDesc": null,
                            "certificationEntryDate": null,
                            "certificationExitDate": null
                        }
                    ]
                },
                "financialInformation": {
                    "creditCardUsage": "Y",
                    "debtSubjectToOffset": "N",
                },
                
            }
        }
    ],

Entity with a small Hierarchy in v2:

        {
            "entityRegistration": {
                "samRegistered": "Yes",
                "ueiSAM": "JXCSEVSG7785",
                "entityEFTIndicator": null,
                "cageCode": "AQ773",
                "dodaac": null,
                "legalBusinessName": "CONSIGLIO NAZIONALE DELLE RICERCHE - CNR",
                "dbaName": "ICB ISTITUTO DI CHIMICA BIOMOLECOLARE",
                "purposeOfRegistrationCode": "Z2",
                "purposeOfRegistrationDesc": "All Awards",
                "registrationStatus": "Active",
                "registrationDate": "2018-03-02",
                "lastUpdateDate": "2021-03-03",
                "registrationExpirationDate": "2022-02-25",
                "activationDate": "2021-03-03",
                "ueiStatus": "Active",
                "ueiExpirationDate": "2022-02-25",
                "ueiCreationDate": "2021-06-25",
                "noPublicDisplayFlag": "Y",
                "exclusionStatusFlag": null,
                "exclusionURL": null,
                "dnbOpenData": "Y"
            },
            "coreData": {
                "entityHierarchyInformation": {
                    "immediateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "intermediateParentEntities": [
                        {
                            "domesticParent": {
                                "ueiSAM": "NLXHHB71VMK5",
                                "legalBusinessName": "REPUBBLICA ITALIANA",
                                "physicalAddress": {
                                    "addressLine1": "Address Line1",
                                    "addressLine2": "Address Line2",
                                    "city": "City",
                                    "stateOrProvinceCode": "State/Province", 
                                    "countryCode": "XXX",
                                    "zipCode": "11111",
                                    "zipCodePlus4": "9999"
                                },
                                "phoneNumber": null
                            },
                            "hqParent": {
                                "ueiSAM": "CWVEJHEWM684",
                                "legalBusinessName": "CONSIGLIO NAZIONALE DELLE RICERCHE",
                                "physicalAddress": {
                                    "addressLine1": "Address Line1",
                                    "addressLine2": "Address Line2",
                                    "city": "City",
                                    "stateOrProvinceCode": "State/Province",
                                    "countryCode": "XXX",
                                    "zipCode": "11111",
                                    "zipCodePlus4": "9999"
                                },
                                "phoneNumber": null
                            }
                        }
                    ],
                    "ultimateParentEntity": {
                        "ueiSAM": "NLXHHB71VMK5",
                        "legalBusinessName": "REPUBBLICA ITALIANA",
                        "physicalAddress": {
                            "addressLine1": "Address Line1",
                            "addressLine2": "Address Line2",
                            "city": "City",
                            "stateOrProvinceCode": "State/Province",
                            "countryCode": "XXX",
                            "zipCode": "11111",
                            "zipCodePlus4": "9999"
                        },
                        "phoneNumber": null
                    },
                    "evsMonitoring": {
                        "legalBusinessName": null,
                        "dbaName": null,
                        "outOfBusinessFlag": null,
                        "monitoringStatus": null,
                        "lastUpdated": null,
                        "addressLine1": null,
                        "addressLine2": null,
                        "city": null,
                        "postalCode": null,
                        "stateOrProvinceCode": null,
                        "countryCode": null
                    }
                },
                "federalHierarchy": {
                    "source": null,
                    "hierarchyDepartmentCode": null,
                    "hierarchyDepartmentName": null,
                    "hierarchyAgencyCode": null,
                    "hierarchyAgencyName": null,
                    "hierarchyOfficeCode": null
                },
                "entityInformation": {
                    "entityURL": null,
                    "entityDivisionName": null,
                    "entityDivisionNumber": null,
                    "entityStartDate": "2019-02-04",
                    "fiscalYearEndCloseDate": "12/31",
                    "submissionDate": "2021-02-25",
                },
                "physicalAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "mailingAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "congressionalDistrict": 00,
                "generalInformation": {
                    "agencyBusinessPurposeCode": null,
                    "agencyBusinessPurposeDesc": null,
                    "entityStructureCode": "ZZ",
                    "entityStructureDesc": "Other",
                    "entityTypeCode": "F",
                    "entityTypeDesc": "Business or Organization",
                    "profitStructureCode": "2U",
                    "profitStructureDesc": "Other Not For Profit Organization",
                    "organizationStructureCode": null,
                    "organizationStructureDesc": null,
                    "stateOfIncorporationCode": null,
                    "stateOfIncorporationDesc": null,
                    "countryOfIncorporationCode": "ITA",
                    "countryOfIncorporationDesc": "ITALY",
                    "companySecurityLevelCode": null,
                    "companySecurityLevelDesc": null,
                    "highestEmployeeSecurityLevelCode": null,
                    "highestEmployeeSecurityLevelDesc": null
                },
                "businessTypes": {
                    "businessTypeList": [
                        {
                            "businessTypeCode": "2U",
                            "businessTypeDesc": "Other Not For Profit Organization"
                        },
                        {
                            "businessTypeCode": "F",
                            "businessTypeDesc": "Business or Organization"
                        }
                    ],
                    "sbaBusinessTypeList": [
                        {
                            "sbaBusinessTypeCode": null,
                            "sbaBusinessTypeDesc": null,
                            "certificationEntryDate": null,
                            "certificationExitDate": null
                        }
                    ]
                },
                "financialInformation": {
                    "creditCardUsage": "N",
                    "debtSubjectToOffset": null,
                },
            }
        }
    ],

Entity with a small Hierarchy in v3:

        {
            "entityRegistration": {
                "samRegistered": "Yes",
                "ueiSAM": "JXCSEVSG7785",
                "entityEFTIndicator": null,
                "cageCode": "AQ773",
                "dodaac": null,
                "legalBusinessName": "CONSIGLIO NAZIONALE DELLE RICERCHE - CNR",
                "dbaName": "ICB ISTITUTO DI CHIMICA BIOMOLECOLARE",
                "purposeOfRegistrationCode": "Z2",
                "purposeOfRegistrationDesc": "All Awards",
                "registrationStatus": "Active",
                "evsSource": "E&Y",
                "registrationDate": "2018-03-02",
                "lastUpdateDate": "2021-03-03",
                "registrationExpirationDate": "2022-02-25",
                "activationDate": "2021-03-03",
                "ueiStatus": "Active",
                "ueiExpirationDate": "2022-02-25",
                "ueiCreationDate": "2021-06-25",
                "publicDisplayFlag": "Y",
                "exclusionStatusFlag": "N",
                "exclusionURL": null,
                "dnbOpenData": "Y"
            },
            "coreData": {
                "entityHierarchyInformation": {
                    "immediateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "evsSource": "E&Y",
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "intermediateParentEntities": [
                        {
                            "domesticParent": {
                                "ueiSAM": "NLXHHB71VMK5",
                                "legalBusinessName": "REPUBBLICA ITALIANA",
                                "evsSource": "E&Y",
                                "physicalAddress": {
                                    "addressLine1": "Address Line1",
                                    "addressLine2": "Address Line2",
                                    "city": "City",
                                    "stateOrProvinceCode": "State/Province",
                                    "countryCode": "XXX",
                                    "zipCode": "11111",
                                    "zipCodePlus4": "9999"
                                },
                                "phoneNumber": null
                            },
                            "hqParent": {
                                "ueiSAM": "CWVEJHEWM684",
                                "legalBusinessName": "CONSIGLIO NAZIONALE DELLE RICERCHE",
                                "evsSource": "E&Y",
                                "physicalAddress": {
                                    "addressLine1": "Address Line1",
                                    "addressLine2": "Address Line2",
                                    "city": "City",
                                    "stateOrProvinceCode": "State/Province",
                                    "countryCode": "XXX",
                                    "zipCode": "11111",
                                    "zipCodePlus4": "9999"
                                },
                                "phoneNumber": null
                            }
                        }
                    ],
                    "ultimateParentEntity": {
                        "ueiSAM": "NLXHHB71VMK5",
                        "legalBusinessName": "REPUBBLICA ITALIANA",
                        "physicalAddress": {
                            "addressLine1": "Address Line1",
                            "addressLine2": "Address Line2",
                            "city": "City",
                            "stateOrProvinceCode": "State/Province",
                            "countryCode": "XXX",
                            "zipCode": "11111",
                            "zipCodePlus4": "9999"
                        },
                        "phoneNumber": null
                    },
                    "evsMonitoring": {
                        "legalBusinessName": null,
                        "dbaName": null,
                        "outOfBusinessFlag": null,
                        "monitoringStatus": null,
                        "lastUpdated": null,
                        "addressLine1": null,
                        "addressLine2": null,
                        "city": null,
                        "postalCode": null,
                        "stateOrProvinceCode": null,
                        "countryCode": null
                    }
                },
                "federalHierarchy": {
                    "source": null,
                    "hierarchyDepartmentCode": null,
                    "hierarchyDepartmentName": null,
                    "hierarchyAgencyCode": null,
                    "hierarchyAgencyName": null,
                    "hierarchyOfficeCode": null
                },
                "entityInformation": {
                    "entityURL": null,
                    "entityDivisionName": null,
                    "entityDivisionNumber": null,
                    "entityStartDate": "2019-02-04",
                    "fiscalYearEndCloseDate": "12/31",
                    "submissionDate": "2021-02-25",
                },
                "physicalAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "mailingAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "congressionalDistrict": 00,
                "generalInformation": {
                    "agencyBusinessPurposeCode": null,
                    "agencyBusinessPurposeDesc": null,
                    "entityStructureCode": "ZZ",
                    "entityStructureDesc": "Other",
                    "entityTypeCode": "F",
                    "entityTypeDesc": "Business or Organization",
                    "profitStructureCode": "2U",
                    "profitStructureDesc": "Other Not For Profit Organization",
                    "organizationStructureCode": null,
                    "organizationStructureDesc": null,
                    "stateOfIncorporationCode": null,
                    "stateOfIncorporationDesc": null,
                    "countryOfIncorporationCode": "ITA",
                    "countryOfIncorporationDesc": "ITALY",
                    "companySecurityLevelCode": null,
                    "companySecurityLevelDesc": null,
                    "highestEmployeeSecurityLevelCode": null,
                    "highestEmployeeSecurityLevelDesc": null
                },
                "businessTypes": {
                    "businessTypeList": [
                        {
                            "businessTypeCode": "2U",
                            "businessTypeDesc": "Other Not For Profit Organization"
                        },
                        {
                            "businessTypeCode": "F",
                            "businessTypeDesc": "Business or Organization"
                        }
                    ],
                    "sbaBusinessTypeList": [
                        {
                            "sbaBusinessTypeCode": null,
                            "sbaBusinessTypeDesc": null,
                            "certificationEntryDate": null,
                            "certificationExitDate": null
                        }
                    ]
                },
                "financialInformation": {
                    "creditCardUsage": "N",
                    "debtSubjectToOffset": null,
                },
            }
        }
    ],

Entity with a large Hierarchy in v2:

    "entityData": [
        {
            "entityRegistration": {
                "samRegistered": "Yes",
                "ueiSAM": "MJ5MN6SGYKF6",
                "entityEFTIndicator": null,
                "cageCode": "F9073",
                "dodaac": null,
                "legalBusinessName": "AIRBUS DEFENCE AND SPACE SAS",
                "dbaName": null,
                "purposeOfRegistrationCode": "Z2",
                "purposeOfRegistrationDesc": "All Awards",
                "registrationStatus": "Active",
                "registrationDate": "2018-08-23",
                "lastUpdateDate": "2021-05-26",
                "registrationExpirationDate": "2021-12-06",
                "activationDate": "2020-06-09",
                "ueiStatus": "Active",
                "ueiExpirationDate": "2021-12-06",
                "ueiCreationDate": "2021-06-25",
                "noPublicDisplayFlag": "Y",
                "exclusionStatusFlag": null,
                "exclusionURL": null,
                "dnbOpenData": "Y"
            },
            "coreData": {
                "entityHierarchyInformation": {
                    "immediateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "intermediateParentEntities": [
                        {
                            "domesticParent": {
                                "ueiSAM": "NPMCJNWE75K6",
                                "legalBusinessName": "AIRBUS SAS",
                                "physicalAddress": {
                                    "addressLine1": "Address Line1",
                                    "addressLine2": "Address Line2",
                                    "city": "City",
                                    "stateOrProvinceCode": "State/Province",
                                    "countryCode": "XXX",
                                    "zipCode": "11111",
                                    "zipCodePlus4": "9999"
                                },
                                "phoneNumber": null
                            },
                            "hqParent": {
                                "ueiSAM": "CK6JEE77RH16",
                                "legalBusinessName": "ASTRIUM SAS",
                                "physicalAddress": {
                                    "addressLine1": "Address Line1",
                                    "addressLine2": "Address Line2",
                                    "city": "City",
                                    "stateOrProvinceCode": "State/Province",
                                    "countryCode": "XXX",
                                    "zipCode": "11111",
                                    "zipCodePlus4": "9999"
                                },
                                "phoneNumber": null
                            }
                        }
                    ],
                    "ultimateParentEntity": {
                        "ueiSAM": "QM7GAR7U8NK3",
                        "legalBusinessName": "Airbus SE",
                        "physicalAddress": {
                            "addressLine1": "Address Line1",
                            "addressLine2": "Address Line2",
                            "city": "City",
                            "stateOrProvinceCode": "State/Province",
                            "countryCode": "XXX",
                            "zipCode": "11111",
                            "zipCodePlus4": "9999"
                        },
                        "phoneNumber": null
                    },
                    "evsMonitoring": {
                        "legalBusinessName": null,
                        "dbaName": null,
                        "outOfBusinessFlag": null,
                        "monitoringStatus": null,
                        "lastUpdated": null,
                        "addressLine1": null,
                        "addressLine2": null,
                        "city": null,
                        "postalCode": null,
                        "stateOrProvinceCode": null,
                        "countryCode": null
                    }
                },
                "federalHierarchy": {
                    "source": null,
                    "hierarchyDepartmentCode": null,
                    "hierarchyDepartmentName": null,
                    "hierarchyAgencyCode": null,
                    "hierarchyAgencyName": null,
                    "hierarchyOfficeCode": null
                },
                "entityInformation": {
                    "entityURL": null,
                    "entityDivisionName": null,
                    "entityDivisionNumber": null,
                    "entityStartDate": "2017-05-31",
                    "fiscalYearEndCloseDate": "12/31",
                    "submissionDate": "2020-06-09",
                },
                "physicalAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "mailingAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },                
                "congressionalDistrict": "00",
                "generalInformation": {
                    "agencyBusinessPurposeCode": null,
                    "agencyBusinessPurposeDesc": null,
                    "entityStructureCode": "8H",
                    "entityStructureDesc": "Corporate Entity (Tax Exempt)",
                    "entityTypeCode": "F",
                    "entityTypeDesc": "Business or Organization",
                    "profitStructureCode": "2X",
                    "profitStructureDesc": "For Profit Organization",
                    "organizationStructureCode": "MF",
                    "organizationStructureDesc": "Manufacturer of Goods",
                    "stateOfIncorporationCode": null,
                    "stateOfIncorporationDesc": null,
                    "countryOfIncorporationCode": "FRA",
                    "countryOfIncorporationDesc": "FRANCE",
                    "companySecurityLevelCode": null,
                    "companySecurityLevelDesc": null,
                    "highestEmployeeSecurityLevelCode": null,
                    "highestEmployeeSecurityLevelDesc": null
                },
                "businessTypes": {
                    "businessTypeList": [
                        {
                            "businessTypeCode": "2X",
                            "businessTypeDesc": "For Profit Organization"
                        },
                        {
                            "businessTypeCode": "F",
                            "businessTypeDesc": "Business or Organization"
                        },
                        {
                            "businessTypeCode": "MF",
                            "businessTypeDesc": "Manufacturer of Goods"
                        }
                    ],
                    "sbaBusinessTypeList": [
                        {
                            "sbaBusinessTypeCode": null,
                            "sbaBusinessTypeDesc": null,
                            "certificationEntryDate": null,
                            "certificationExitDate": null
                        }
                    ]
                },
                "financialInformation": {
                    "creditCardUsage": "N",
                    "debtSubjectToOffset": null,
                },
            }
        }
    ],

Entity with a large Hierarchy in v3:

    "entityData": [
        {
            "entityRegistration": {
                "samRegistered": "Yes",
                "ueiSAM": "MJ5MN6SGYKF6",
                "entityEFTIndicator": null,
                "cageCode": "F9073",
                "dodaac": null,
                "legalBusinessName": "AIRBUS DEFENCE AND SPACE SAS",
                "dbaName": null,
                "purposeOfRegistrationCode": "Z2",
                "purposeOfRegistrationDesc": "All Awards",
                "registrationStatus": "Active",
                "evsSource": "E&Y",
                "registrationDate": "2018-08-23",
                "lastUpdateDate": "2021-05-26",
                "registrationExpirationDate": "2021-12-06",
                "activationDate": "2020-06-09",
                "ueiStatus": "Active",
                "ueiExpirationDate": "2021-12-06",
                "ueiCreationDate": "2021-06-25",
                "publicDisplayFlag": "Y",
                "exclusionStatusFlag": "N",
                "exclusionURL": null,
                "dnbOpenData": "Y"
            },
            "coreData": {
                "entityHierarchyInformation": {
                    "immediateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "evsSource": "E&Y",
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "intermediateParentEntities": [
                        {
                            "domesticParent": {
                                "ueiSAM": "NPMCJNWE75K6",
                                "legalBusinessName": "AIRBUS SAS",
                                "evsSource": "E&Y",
                                "physicalAddress": {
                                    "addressLine1": "Address Line1",
                                    "addressLine2": "Address Line2",
                                    "city": "City",
                                    "stateOrProvinceCode": "State/Province",
                                    "countryCode": "XXX",
                                    "zipCode": "11111",
                                    "zipCodePlus4": "9999"
                                },
                                "phoneNumber": null
                            },
                            "hqParent": {
                                "ueiSAM": "CK6JEE77RH16",
                                "legalBusinessName": "ASTRIUM SAS",
                                "evsSource": "E&Y",
                                "physicalAddress": {
                                    "addressLine1": "Address Line1",
                                    "addressLine2": "Address Line2",
                                    "city": "City",
                                    "stateOrProvinceCode": "State/Province",
                                    "countryCode": "XXX",
                                    "zipCode": "11111",
                                    "zipCodePlus4": "9999"
                                },
                                "phoneNumber": null
                            }
                        }
                    ],
                    "ultimateParentEntity": {
                        "ueiSAM": "QM7GAR7U8NK3",
                        "legalBusinessName": "Airbus SE",
                        "evsSource": "E&Y",
                        "physicalAddress": {
                            "addressLine1": "Address Line1",
                            "addressLine2": "Address Line2",
                            "city": "City",
                            "stateOrProvinceCode": "State/Province",
                            "countryCode": "XXX",
                            "zipCode": "11111",
                            "zipCodePlus4": "9999"
                        },
                        "phoneNumber": null
                    },
                    "evsMonitoring": {
                        "legalBusinessName": null,
                        "dbaName": null,
                        "outOfBusinessFlag": null,
                        "monitoringStatus": null,
                        "lastUpdated": null,
                        "addressLine1": null,
                        "addressLine2": null,
                        "city": null,
                        "postalCode": null,
                        "stateOrProvinceCode": null,
                        "countryCode": null
                    }
                },
                "federalHierarchy": {
                    "source": null,
                    "hierarchyDepartmentCode": null,
                    "hierarchyDepartmentName": null,
                    "hierarchyAgencyCode": null,
                    "hierarchyAgencyName": null,
                    "hierarchyOfficeCode": null
                },
                "entityInformation": {
                    "entityURL": null,
                    "entityDivisionName": null,
                    "entityDivisionNumber": null,
                    "entityStartDate": "2017-05-31",
                    "fiscalYearEndCloseDate": "12/31",
                    "submissionDate": "2020-06-09",
                },
                "physicalAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "mailingAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },                
                "congressionalDistrict": "00",
                "generalInformation": {
                    "agencyBusinessPurposeCode": null,
                    "agencyBusinessPurposeDesc": null,
                    "entityStructureCode": "8H",
                    "entityStructureDesc": "Corporate Entity (Tax Exempt)",
                    "entityTypeCode": "F",
                    "entityTypeDesc": "Business or Organization",
                    "profitStructureCode": "2X",
                    "profitStructureDesc": "For Profit Organization",
                    "organizationStructureCode": "MF",
                    "organizationStructureDesc": "Manufacturer of Goods",
                    "stateOfIncorporationCode": null,
                    "stateOfIncorporationDesc": null,
                    "countryOfIncorporationCode": "FRA",
                    "countryOfIncorporationDesc": "FRANCE",
                    "companySecurityLevelCode": null,
                    "companySecurityLevelDesc": null,
                    "highestEmployeeSecurityLevelCode": null,
                    "highestEmployeeSecurityLevelDesc": null
                },
                "businessTypes": {
                    "businessTypeList": [
                        {
                            "businessTypeCode": "2X",
                            "businessTypeDesc": "For Profit Organization"
                        },
                        {
                            "businessTypeCode": "F",
                            "businessTypeDesc": "Business or Organization"
                        },
                        {
                            "businessTypeCode": "MF",
                            "businessTypeDesc": "Manufacturer of Goods"
                        }
                    ],
                    "sbaBusinessTypeList": [
                        {
                            "sbaBusinessTypeCode": null,
                            "sbaBusinessTypeDesc": null,
                            "certificationEntryDate": null,
                            "certificationExitDate": null
                        }
                    ]
                },
                "financialInformation": {
                    "creditCardUsage": "N",
                    "debtSubjectToOffset": null,
                },
            }
        }
    ],

Example 5: Get an Entity with no EVS Monitoring.

Request URL Production URL: https://api.sam.gov/entity-information/v2/entities?api_key= < FOUO API Key >&includeSections=entityRegistration,coreData

https://api.sam.gov/entity-information/v3/entities?api_key= < FOUO API Key >&includeSections=entityRegistration,coreData

Alpha URL: https://api-alpha.sam.gov/entity-information/v2/entities?api_key=< FOUO API Key >&includeSections=entityRegistration,coreData

https://api-alpha.sam.gov/entity-information/v3/entities?api_key=< FOUO API Key >&includeSections=entityRegistration,coreData

Response (JSON Output) FOUO Response for the record is provided in v2 and v3. 

v2:

    "entityData": [
        {
            "entityRegistration": {
                "samRegistered": "Yes",
                "ueiSAM": "XY1XDER4WPJ6",
                "entityEFTIndicator": null,
                "cageCode": "7F0U0",
                "dodaac": null,
                "legalBusinessName": "Enterprise Assurance Management",
                "dbaName": null,
                "purposeOfRegistrationCode": "Z2",
                "purposeOfRegistrationDesc": "All Awards",
                "registrationStatus": "Active",
                "registrationDate": "2015-07-10",
                "lastUpdateDate": "2021-03-30",
                "registrationExpirationDate": "2021-10-25",
                "activationDate": "2020-04-30",
                "ueiStatus": "Active",
                "ueiExpirationDate": "2021-10-25",
                "ueiCreationDate": "2021-06-25",
                "noPublicDisplayFlag": "Y",
                "exclusionStatusFlag": null,
                "exclusionURL": null,
                "dnbOpenData": "Y"
            },
            "coreData": {
                "entityHierarchyInformation": {
                    "immediateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "intermediateParentEntities": [
                        {
                            "domesticParent": {
                                "ueiSAM": null,
                                "legalBusinessName": null,
                                "physicalAddress": {
                                    "addressLine1": null,
                                    "addressLine2": null,
                                    "city": null,
                                    "stateOrProvinceCode": null,
                                    "countryCode": null,
                                    "zipCode": null,
                                    "zipCodePlus4": null
                                },
                                "phoneNumber": null
                            },
                            "hqParent": {
                                "ueiSAM": null,
                                "legalBusinessName": null,
                                "physicalAddress": {
                                    "addressLine1": null,
                                    "addressLine2": null,
                                    "city": null,
                                    "stateOrProvinceCode": null,
                                    "countryCode": null,
                                    "zipCode": null,
                                    "zipCodePlus4": null
                                },
                                "phoneNumber": null
                            }
                        }
                    ],
                    "ultimateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "evsMonitoring": {
                        "legalBusinessName": "Enterprise Assurance Management",
                        "dbaName": null,
                        "outOfBusinessFlag": null,
                        "monitoringStatus": null,
                        "lastUpdated": null,
                        "addressLine1": null,
                        "addressLine2": null,
                        "city": null,
                        "postalCode": null,
                        "stateOrProvinceCode": null,
                        "countryCode": null
                    }
                },
                "federalHierarchy": {
                    "source": null,
                    "hierarchyDepartmentCode": null,
                    "hierarchyDepartmentName": null,
                    "hierarchyAgencyCode": null,
                    "hierarchyAgencyName": null,
                    "hierarchyOfficeCode": null
                },
                "entityInformation": {
                    "entityURL": "eamsecured.com",
                    "entityDivisionName": "Enterprise Assurance Management Corp., (EAMC)",
                    "entityDivisionNumber": "Enterprise",
                    "entityStartDate": "2011-06-30",
                    "fiscalYearEndCloseDate": "10/31",
                    "submissionDate": "2020-04-28",
                },
                "physicalAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "mailingAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "congressionalDistrict": "04",
                "generalInformation": {
                    "agencyBusinessPurposeCode": null,
                    "agencyBusinessPurposeDesc": null,
                    "entityStructureCode": "8H",
                    "entityStructureDesc": "Corporate Entity (Tax Exempt)",
                    "entityTypeCode": "F",
                    "entityTypeDesc": "Business or Organization",
                    "profitStructureCode": "2X",
                    "profitStructureDesc": "For Profit Organization",
                    "organizationStructureCode": "XS",
                    "organizationStructureDesc": "Subchapter S Corporation",
                    "stateOfIncorporationCode": "MD",
                    "stateOfIncorporationDesc": "MARYLAND",
                    "countryOfIncorporationCode": "USA",
                    "countryOfIncorporationDesc": "UNITED STATES",
                    "companySecurityLevelCode": "93",
                    "companySecurityLevelDesc": "Government Secret",
                    "highestEmployeeSecurityLevelCode": "94",
                    "highestEmployeeSecurityLevelDesc": "Government Top Secret"
                },
                "businessTypes": {
                    "businessTypeList": [
                        {
                            "businessTypeCode": "2X",
                            "businessTypeDesc": "For Profit Organization"
                        },
                        {
                            "businessTypeCode": "A2",
                            "businessTypeDesc": "Woman Owned Business"
                        },
                        {
                            "businessTypeCode": "F",
                            "businessTypeDesc": "Business or Organization"
                        },
                        {
                            "businessTypeCode": "OY",
                            "businessTypeDesc": "Black American Owned"
                        },
                        {
                            "businessTypeCode": "XS",
                            "businessTypeDesc": "Subchapter S Corporation"
                        }
                    ],
                    "sbaBusinessTypeList": [
                        {
                            "sbaBusinessTypeCode": null,
                            "sbaBusinessTypeDesc": null,
                            "certificationEntryDate": null,
                            "certificationExitDate": null
                        }
                    ]
                },
                "financialInformation": {
                    "creditCardUsage": "Y",
                    "debtSubjectToOffset": "N",
                },
            }
        }
    ],

V3:

    "entityData": [
        {
            "entityRegistration": {
                "samRegistered": "Yes",
                "ueiSAM": "XY1XDER4WPJ6",
                "entityEFTIndicator": null,
                "cageCode": "7F0U0",
                "dodaac": null,
                "legalBusinessName": "Enterprise Assurance Management",
                "dbaName": null,
                "purposeOfRegistrationCode": "Z2",
                "purposeOfRegistrationDesc": "All Awards",
                "registrationStatus": "Active",
                "evsSource": "E&Y",
                "registrationDate": "2015-07-10",
                "lastUpdateDate": "2021-03-30",
                "registrationExpirationDate": "2021-10-25",
                "activationDate": "2020-04-30",
                "ueiStatus": "Active",
                "ueiExpirationDate": "2021-10-25",
                "ueiCreationDate": "2021-06-25",
                "publicDisplayFlag": "Y",
                "exclusionStatusFlag": "N",
                "exclusionURL": null,
                "dnbOpenData": "Y"
            },
            "coreData": {
                "entityHierarchyInformation": {
                    "immediateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "evsSource": "E&Y",
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "intermediateParentEntities": [
                        {
                            "domesticParent": {
                                "ueiSAM": null,
                                "legalBusinessName": null,
                                "evsSource": "E&Y",
                                "physicalAddress": {
                                    "addressLine1": null,
                                    "addressLine2": null,
                                    "city": null,
                                    "stateOrProvinceCode": null,
                                    "countryCode": null,
                                    "zipCode": null,
                                    "zipCodePlus4": null
                                },
                                "phoneNumber": null
                            },
                            "hqParent": {
                                "ueiSAM": null,
                                "legalBusinessName": null,
                                "evsSource": "E&Y",
                                "physicalAddress": {
                                    "addressLine1": null,
                                    "addressLine2": null,
                                    "city": null,
                                    "stateOrProvinceCode": null,
                                    "countryCode": null,
                                    "zipCode": null,
                                    "zipCodePlus4": null
                                },
                                "phoneNumber": null
                            }
                        }
                    ],
                    "ultimateParentEntity": {
                        "ueiSAM": null,
                        "legalBusinessName": null,
                        "evsSource": "E&Y",
                        "physicalAddress": {
                            "addressLine1": null,
                            "addressLine2": null,
                            "city": null,
                            "stateOrProvinceCode": null,
                            "countryCode": null,
                            "zipCode": null,
                            "zipCodePlus4": null
                        },
                        "phoneNumber": null
                    },
                    "evsMonitoring": {
                        "legalBusinessName": "Enterprise Assurance Management",
                        "dbaName": null,
                        "outOfBusinessFlag": null,
                        "monitoringStatus": null,
                        "lastUpdated": null,
                        "addressLine1": null,
                        "addressLine2": null,
                        "city": null,
                        "postalCode": null,
                        "stateOrProvinceCode": null,
                        "countryCode": null
                    }
                },
                "federalHierarchy": {
                    "source": null,
                    "hierarchyDepartmentCode": null,
                    "hierarchyDepartmentName": null,
                    "hierarchyAgencyCode": null,
                    "hierarchyAgencyName": null,
                    "hierarchyOfficeCode": null
                },
                "entityInformation": {
                    "entityURL": "eamsecured.com",
                    "entityDivisionName": "Enterprise Assurance Management Corp., (EAMC)",
                    "entityDivisionNumber": "Enterprise",
                    "entityStartDate": "2011-06-30",
                    "fiscalYearEndCloseDate": "10/31",
                    "submissionDate": "2020-04-28",
                },
                "physicalAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "mailingAddress": {
                  "addressLine1": "Address1",
                  "addressLine2": "Address2",
                  "city": "City",
                  "stateOrProvinceCode": "XX",
                  "zipCode": "11111",
                  "zipCodePlus4": "1111",
                  "countryCode": "ABC"
                },
                "congressionalDistrict": "04",
                "generalInformation": {
                    "agencyBusinessPurposeCode": null,
                    "agencyBusinessPurposeDesc": null,
                    "entityStructureCode": "8H",
                    "entityStructureDesc": "Corporate Entity (Tax Exempt)",
                    "entityTypeCode": "F",
                    "entityTypeDesc": "Business or Organization",
                    "profitStructureCode": "2X",
                    "profitStructureDesc": "For Profit Organization",
                    "organizationStructureCode": "XS",
                    "organizationStructureDesc": "Subchapter S Corporation",
                    "stateOfIncorporationCode": "MD",
                    "stateOfIncorporationDesc": "MARYLAND",
                    "countryOfIncorporationCode": "USA",
                    "countryOfIncorporationDesc": "UNITED STATES",
                    "companySecurityLevelCode": "93",
                    "companySecurityLevelDesc": "Government Secret",
                    "highestEmployeeSecurityLevelCode": "94",
                    "highestEmployeeSecurityLevelDesc": "Government Top Secret"
                },
                "businessTypes": {
                    "businessTypeList": [
                        {
                            "businessTypeCode": "2X",
                            "businessTypeDesc": "For Profit Organization"
                        },
                        {
                            "businessTypeCode": "A2",
                            "businessTypeDesc": "Woman Owned Business"
                        },
                        {
                            "businessTypeCode": "F",
                            "businessTypeDesc": "Business or Organization"
                        },
                        {
                            "businessTypeCode": "OY",
                            "businessTypeDesc": "Black American Owned"
                        },
                        {
                            "businessTypeCode": "XS",
                            "businessTypeDesc": "Subchapter S Corporation"
                        }
                    ],
                    "sbaBusinessTypeList": [
                        {
                            "sbaBusinessTypeCode": null,
                            "sbaBusinessTypeDesc": null,
                            "certificationEntryDate": null,
                            "certificationExitDate": null
                        }
                    ]
                },
                "financialInformation": {
                    "creditCardUsage": "Y",
                    "debtSubjectToOffset": "N",
                },
            }
        }
    ],

Example 6: How do I obtain both the Public and NPDY registered “Responsibility & Integrity Record” data with my Public API Key?

Request URL Production URL:

https://api.sam.gov/entity-information/v3/entities?api_key=< PUBLIC API Key >&includeSections=integrityInformation

Alpha URL:

https://api-alpha.sam.gov/entity-information/v3/entities?api_key=< PUBLIC API Key >& includeSections=entityRegistration,integrityInformation

Response (JSON Output) 

"entityData": [
{
      "entityRegistration": {
        "samRegistered": "Yes",
        "ueiSAM": "DE95TS6Y5XR6",
        "entityEFTIndicator": null,
        "cageCode": "CJ542",
        "dodaac": null,
        "legalBusinessName": "ng4T GmbH",
        "dbaName": null,
        "purposeOfRegistrationCode": "Z2",
        "purposeOfRegistrationDesc": "All Awards",
        "registrationStatus": "Active",
        "evsSource": "D&B",
        "registrationDate": "2016-05-09",
        "lastUpdateDate": "2022-05-20",
        "registrationExpirationDate": "2022-05-20",
        "activationDate": "2021-05-20",
        "ueiStatus": "Active",
        "ueiExpirationDate": null,
        "ueiCreationDate": "2020-06-18",
        "publicDisplayFlag": "Y",
        "exclusionStatusFlag": "N",
        "exclusionURL": null,
        "dnbOpenData": null
      },
{
"integrityInformation": {
"entitySummary": {
"ueiSAM": "DE95TS6Y5XR6",
"cageCode": "CJ542",
"legalBusinessName": "ng4T GmbH",
"physicalAddress": {
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
}
},
"proceedingsData": {
"proceedingsQuestion1": "YES",
"proceedingsQuestion2": "YES",
"proceedingsQuestion3": "YES",
"proceedingsRecordCount": 1,
"listOfProceedings": [
{
"proceedingDate": "1000-01-01",
"instrumentNumber": "XXXXX",
"instrument": "U.S.Federal issued contract",
"proceedingStateCode": "XX",
"proceedingType": "Criminal",
"disposition": "Other acknowledgment of fault",
"proceedingDescription": "Proceeding Description"
}
],
"proceedingsPointsOfContact": {
"proceedingsPOC": {
"firstName": "First Name",
"middleInitial": "Z",
"lastName": "Last Name",
"title": "Title",
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
"proceedingsAlternatePOC": {
"firstName": "First Name",
"middleInitial": "Z",
"lastName": "Last Name",
"title": "Title",
"addressLine1": "Address1",
"addressLine2": "Address2",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "ABC"
},
}
},
"responsibilityInformationCount": 2,
"responsibilityInformationList": [
{
"recordType": "C",
"recordTypeDesc": "Termination for Cause",
"recordDate": "2018-04-10",
"procurementIdOrFederalAssistanceId": "W9127S18F0005P00002",
"referenceIdvPiid": "W9127S15D0018",
"attachment": "< Pre-signed URL >"
},
{
"recordType": "C",
"recordTypeDesc": "Termination for Cause",
"recordDate": "2018-04-10",
"procurementIdOrFederalAssistanceId": "W9127S16P0075P00003",
"referenceIdvPiid": null,
"attachment": "< Pre-signed URL >"
}
],
"corporateRelationships": {
"highestOwner": {
"legalBusinessName": "WSP GLOBAL INC",
"cageCode": “7NDG5",
"integrityRecords": "Yes"
},
"immediateOwner": {
"legalBusinessName": "LOUIS BERGER U.S., INC.",
"cageCode": "7NDG5",
"integrityRecords": "No"
},
"predecessorsList": [
{
"legalBusinessName": null,
"cageCode": null,
"integrityRecords": "N/A"
}
]
}
}
},
{
"entityRegistration": "This entity has opted out of public search. Only federal government users and users associated with this entity can view this record on SAM.gov.",
"integrityInformation": {
        "entitySummary": {
          "ueiSAM": "VNP5VWMPAEF3",
          "cageCode": null,
          "legalBusinessName": "Harrisonburg Rescue Squad Inc",
          "physicalAddress": {
            "addressLine1": "Address1",
            "addressLine2": "Address2",
            "city": "City",
            "stateOrProvinceCode": "XX",
            "zipCode": "11111",
            "zipCodePlus4": "1111",
            "countryCode": "ABC"
          }
        },
        "proceedingsData": {
          "proceedingsQuestion1": null,
          "proceedingsQuestion2": null,
          "proceedingsQuestion3": null,
          "proceedingsRecordCount": 0,
          "listOfProceedings": [],
          "proceedingsPointsOfContact": {
            "proceedingsPOC": {
              "firstName": null,
              "middleInitial": null,
              "lastName": null,
              "title": null,
              "addressLine1": null,
              "addressLine2": null,
              "city": null,
              "stateOrProvinceCode": null,
              "zipCode": null,
              "zipCodePlus4": null,
              "countryCode": null
            },
            "proceedingsAlternatePOC": {
              "firstName": null,
              "middleInitial": null,
              "lastName": null,
              "title": null,
              "addressLine1": null,
              "addressLine2": null,
              "city": null,
              "stateOrProvinceCode": null,
              "zipCode": null,
              "zipCodePlus4": null,
              "countryCode": null
            }
          }
        },
        "responsibilityInformationCount": 1,
        "responsibilityInformationList": [
          {
            "recordType": "C",
            "recordTypeDesc": "Termination for Cause",
            "recordDate": "2019-02-15",
            "procurementIdOrFederalAssistanceId": "W912DQ18C1026",
            "referenceIdvPiid": null,
            "attachment": "< Pre-signed URL >"
          }
        ],
        "corporateRelationships": {
          "highestOwner": {
            "legalBusinessName": null,
            "cageCode": null,
            "integrityRecords": "N/A"
          },
          "immediateOwner": {
            "legalBusinessName": null,
            "cageCode": null,
            "integrityRecords": "N/A"
          },
          "predecessorsList": [
            {
              "legalBusinessName": null,
              "cageCode": null,
              "integrityRecords": "N/A"
            }
          ]
        }
      }
    }
  ]

Example 7: How do I obtain both the Public and NPDY not registered/ID Assigned “Responsibility & Integrity Record” data with my Public API Key?

Request URL Production URL:

https://api.sam.gov/entity-information/v3/entities?api_key=< PUBLIC API Key >&samRegistered=No&includeSections=integrityInformation,All

Alpha URL:

https://api-alpha.sam.gov/entity-information/v3/entities?api_key=< PUBLIC API Key >&samRegistered=No&includeSections=integrityInformation,All
Response (JSON Output) 

{
      "entityRegistration": {
        "samRegistered": "No",
        "ueiSAM": "WB23FJYKNLM1",
        "cageCode": null,
        "legalBusinessName": "9TH CIRCUIT COURT OF APPEALS",
        "registrationStatus": "ID Assigned",
        "evsSource": null,
        "ueiStatus": "Active",
        "ueiExpirationDate": null,
        "ueiCreationDate": "2022-02-22",
        "publicDisplayFlag": "Y",
        "dnbOpenData": null
      },
      "coreData": {
        "physicalAddress": {
            "addressLine1": "Address1",
            "addressLine2": "Address2",
            "city": "City",
            "stateOrProvinceCode": "XX",
            "zipCode": "11111",
            "zipCodePlus4": "1111",
            "countryCode": "ABC"
        }
      },
      "integrityInformation": {
        "responsibilityInformationCount": 1,
        "responsibilityInformationList": [
          {
            "recordType": "C",
            "recordTypeDesc": "Termination for Cause",
            "recordDate": "2022-05-09",
            "procurementIdOrFederalAssistanceId": "BG567815C0001",
            "referenceIdvPiid": null,
            "attachment": "< Pre-signed URL >"
          }            
       ]
      }
    },
    {
      "entityRegistration": {
        "samRegistered": "This entity has opted out of public search. Only federal government users and users associated with this entity can view this record on SAM.gov.",
        "ueiSAM": "TST987654321",
        "cageCode": null,
        "legalBusinessName": "HAYES, INC.",
        "registrationStatus": "This entity has opted out of public search. Only federal government users and users associated with this entity can view this record on SAM.gov.",
        "evsSource": "This entity has opted out of public search. Only federal government users and users associated with this entity can view this record on SAM.gov.",
        "ueiStatus": "This entity has opted out of public search. Only federal government users and users associated with this entity can view this record on SAM.gov.",
        "ueiExpirationDate": "This entity has opted out of public search. Only federal government users and users associated with this entity can view this record on SAM.gov.",
        "ueiCreationDate": "This entity has opted out of public search. Only federal government users and users associated with this entity can view this record on SAM.gov.",
        "publicDisplayFlag": "This entity has opted out of public search. Only federal government users and users associated with this entity can view this record on SAM.gov.",
        "dnbOpenData": "This entity has opted out of public search. Only federal government users and users associated with this entity can view this record on SAM.gov."
      },
      "coreData": {
        "physicalAddress": {
            "addressLine1": "Address1",
            "addressLine2": "Address2",
            "city": "City",
            "stateOrProvinceCode": "XX",
            "zipCode": "11111",
            "zipCodePlus4": "1111",
            "countryCode": "ABC"
        }
      },
      "integrityInformation": {
        "responsibilityInformationCount": 3,
        "responsibilityInformationList": [
          {
            "recordType": "C",
            "recordTypeDesc": "Termination for Cause",
            "recordDate": "2022-05-09",
            "procurementIdOrFederalAssistanceId": "BG567815C0001",
            "referenceIdvPiid": null,
            "attachment": "< Pre-signed URL >"
          },
          {
            "recordType": "C",
            "recordTypeDesc": "Termination for Cause",
            "recordDate": "2022-05-17",
            "procurementIdOrFederalAssistanceId": "ABAB0113C0001",
            "referenceIdvPiid": null,
            "attachment": "< Pre-signed URL >"
          },
          {
            "recordType": "W",
            "recordTypeDesc": "Material Failure to Comply with Closeout Requirements",
            "recordDate": "2022-05-17",
            "procurementIdOrFederalAssistanceId": "ABAB0113C0001",
            "referenceIdvPiid": null,
            "attachment": "< Pre-signed URL >"
          }
       ]
      }
    }
  ]

Example 8: I have a Fed System Account and the Role required to access the not registered/ID Assigned entities. How can I obtain them?

Request URL Production URL: https://api.sam.gov/entity-information/v3/entities?api_key= < API Key >&samRegistered=No

Alpha URL: https://api-alpha.sam.gov/entity-information/v3/entities?api_key=< API Key >&samRegistered=No


Response Response for one Public and one NPDY record is provided.

A Public unregistered/ID Assigned entity:

"entityData": [
{
"entityRegistration": {
"samRegistered": "No",
"ueiSAM": "JF19T45AM8F2",
"cageCode": "null",
"legalBusinessName": "Anchored Consulting Group LLC",
"registrationStatus": "Active",
"evsSource": null,
"ueiStatus": "Active",
"ueiExpirationDate": null,
"ueiCreationDate": "2021-07-20",
"publicDisplayFlag": "Y",
"dnbOpenData": "Y"
},
"coreData": {
"physicalAddress": {
"addressLine1": "Address 1",
"addressLine2": "null",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": null,
"countryCode": "XXX"
}
}
},

An NPDY unregistered/ID Assigned entity:

"entityData": [
{
"entityRegistration": {
"samRegistered": "No",
"ueiSAM": "MC4NTRBK7AX5",
"cageCode": "null",
"legalBusinessName": "FPDS",
"registrationStatus": "Active",
"evsSource": null,
"ueiStatus": "Active",
"ueiExpirationDate": null,
"ueiCreationDate": "2021-07-20",
"publicDisplayFlag": "N",
"dnbOpenData": "Y"
},
"coreData": {
"physicalAddress": {
"addressLine1": "Address 1",
"addressLine2": "null",
"city": "City",
"stateOrProvinceCode": "XX",
"zipCode": "11111",
"zipCodePlus4": "1111",
"countryCode": "XXX"
}
}
},

Example 9: I would like to obtain an asynchronous CSV file of the Active registered entities.

Request URL Production URL: https://api.sam.gov/entity-information/v2/entities?api_key= < FOUO API Key >&registrationStatus=A

https://api.sam.gov/entity-information/v3/entities?api_key= < FOUO API Key >&registrationStatus=A

Alpha URL: https://api-alpha.sam.gov/entity-information/v2/entities?api_key=< FOUO API Key >&registrationStatus=A

https://api-alpha.sam.gov/entity-information/v3/entities?api_key=< FOUO API Key >&registrationStatus=A

Response Click to view a sample v2 CSV Response for one record v2_CSV_Response
Click to view a sample v3 CSV Response for one record v3_CSV_Response

Example 10: Get a JSON file of all the Entities using the POST request:

Request URL Production URL:: https://api.sam.gov/entity-information/v2/entities?format=JSON

https://api.sam.gov/entity-information/v3/entities?format=JSON

Alpha URL: : https://api-alpha.sam.gov/entity-information/v2/entities?format=JSON

https://api-alpha.sam.gov/entity-information/v3/entities?format=JSON

Response
  • Download link with the token:
    Extract File will be available for download with POST url: https://api.sam.gov/entity-information/v2/download-entities?token=< value > in some time. If you have provided an email id, you will get a notification email once file is ready for download. Requests for Larger Set of Data may take longer time to process.

    Extract File will be available for download with POST url: https://api.sam.gov/entity-information/v3/download-entities?token=< value > in some time. If you have provided an email id, you will get a notification email once file is ready for download. Requests for Larger Set of Data may take longer time to process.
  • Download the file using the token via POST:
    https://api.sam.gov/entity-information/v2/download-entities?token=< value>
    https://api.sam.gov/entity-information/v3/download-entities?token=< value >
  • Once the file is downloaded, save it by renaming it in this format: < filename >.json.gz.
  • If the downloaded file is of CSV type, then file renaming convention is < filename >.csv.gz.

Back to top

Additional Information

You can view the full details of the differences between the SAM legacy API and SAM.gov 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, including Dun & Bradstreet (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: Legal 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. Entity registration, exclusion, or contract award records in SAM may contain D&B-supplied data. Applicable records containing D&B data include all entity registration records with a last updated date earlier than 4/4/2022, all exclusions records with a created date earlier than 4/4/2022, and all base award notices with an award date earlier than 4/4/2022. These records show the Entity Validation Service (EVS) Source as D&B in outbound data streams.
  • 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

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

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.
12/20/2019 v1.4 * Removed Email, Fax,US phone number and non-us phone number from public poc sections for v2.

* Added “COMING SOON” section for upcoming changes to Alpha and Beta endpoints to meet new API standards.
02/25/2020 v1.5 * Added Examples for v2 requests and responses.

* Updated Alpha endpoint to meet new API standards.
02/28/2020 v1.6 * Updated Beta endpoint to meet new API standards.

* Removed “COMING SOON” information in Getting Started section.
05/04/2020 v1.7 * Added V2 endpoint information.
06/10/2020 v1.8 * Added the endpoint, new process and an example for the Sensitive API .
08/17/2020 v1.9 * The “Sensitive API Process” subsection under the “Sensitive API Information” section has been updated with additional steps for sending Sensitive requests (sending “Accept” and “Content-Type” parameters).

* The Sample Request Header screenshots under “Example 13” have been updated to reflect the new parameters as well. Two new codes (406, 415) have been added in the “HTTP Response Codes” section.
10/15/2020 v2.0 * Updated the description for the correspondenceFlag field

* Added the http response code description when providing the entityEFTIndicator parameter without providing the ueiDUNS or ueiSAM prarameter.

* Updated the description for the entityEFTIndicator parameter.
12/07/2020 v2.1 * Updated the Sensitive response documentation to include mpin.

* Updated the Query String Parameters to include the sbaBusinessTypeCode, sbaBusinessTypeDesc, companySecurityLevelDesc, highestEmployeeSecurityLevelDesc, and agencyBusinessPurposeDesc.

* Updated the definitions and examples in the Query String Parameters.

* Updated emailId parameter description.

* Updated sensitivity parameter description.

* Corrected zip code related fields in V1 dnbMonitoring and samMonitoring sections.
01/22/2021 v2.2 * Added the highlighted changes message under the “Getting Started” section.

* Updated the repsAndCerts schema for Public, FOUO, and Sensitive.

* Added note to the noPublicDisplayFlag field in the response.

* Added the Beta V2 endpoints.
02/05/2021 v2.3 * Added message to includeSections that user can provide “All”.

* Added message about special characters that cannot be used in API request.

* Updated the exclusionStatusFlag definition.
03/12/2021 v2.4 * Added Http Response for invalid IP address.

* Added note to sensitivity parameter explaining use of POST call.

* Added note under repsAndCerts section about use with format parameter.

* Added NOTE under FOUO API Information Expected Results section and Sensitive API Information Sensitive API Process sections mentioning only system account keys can be used to access data.

* Removed the message stating that this page is not FireFox compliant.
04/08/2021 v2.5 * Updated Contact Us information.

* Updated pointsOfContact fields information for public api.

* Updated Application Level Error Messages in HTTP Response Codes section.
05/12/2021 v2.6 * Updated instances of beta.sam.gov to SAM.gov.

* Removed non-relevant information for Beta api.
07/16/2021 v2.7 * Updated the instructions on sending “Basic Auth” under the “Authorization” header.

* Added the Type of Connections and Rate Limits table.

* Updated the Contact Us information.

* Added example curl requests.

* Updated the examples.
07/20/2021 v2.8 * Added v3 documentation.

* Updated OpenAPI specification file.

* Updated HTTP Response Codes.

* Added v3 Examples.
09/21/2021 v2.9 * Added the “Additional Help References” section.
10/06/2021 v3.0 * Updated the “Contact Us” section.
10/21/2021 v3.1 * Updated Examples - Added Example 1 and Example 2 to indicate the post April 3rd, 2022 behavior.

* Added error messages #23 and #24 to the 400 level http response codes.

* Added the Version 3 endpoint.

* Added notes in the Query String Parameters, Expected Result and HTTP Response Codes sections to highlight the until and after April 3rd, 2022 behavior.
02/01/2022 v3.2 * Update the OpenAPI Specification File to include the V3 endpoints.

* Updated the OpenAPI Specification File to reflect the correct behavior for the V3 exclusionsStatusFlag parameter.
04/04/2022 v3.3 * Removed duns information from the documentation.
08/08/2022 v3.4 * Updated to clarify the use of Controlled Unclassified Information (CUI) data.
08/10/2022 v3.5 * Introduced a header to clearly distinguish the applicability of the section or sub-section to the registered entities and/or unregistered/ID Assigned entities.

* Included the “Responsibility & Integrity Record” API changes in the “API Description” and “Examples” sections.
09/19/2022 v3.6 * Updated “Description” for includeSections in the “Query String Parameters” section.

* Updated “entitySummary Sub Section” in the “Response Schema” section.

* Added “responsibilityInformationCount Sub Section” in the “Response Schema” section.

* Updated the “Examples” section - modified Example 6, added Example 7 and revised numbering of other Examples accordingly.
10/19/2022 v3.7 * Added a new Public search parameter, “proceedingsData” in the “API Description” - “Query String Parameters” section.

* Added new validation rules for “proceedingsData” in the “HTTP Response Codes” section.

* Updated the yaml file to include proceedingsData as a search parameter.
10/25/2022 v3.8 * Updated the response schema for the API Description 🡪 Response Schema 🡪 integrityInformation 🡪 proceedingsData Sub Section to show the newly added field, “proceedingsRecordCount”.

* Updated Example 6 🡪 Response (JSON Output) to show the newly added field, “proceedingsRecordCount”.

* Updated Reps and Certs help documentation.
11/25/2022 v3.9 * Updated SAM Functional Data Dictionary 🡪 Removed DUNS/D&B References.
01/17/2023 v4.0 * Uploaded a revised Data Dictionary with data fields arranged in the Alphabetical order.
01/30/2023 v4.1 * Uploaded a revised Data Dictionary with data fields added for Proceedings and Responsibility/Qualification.
02/28/2023 v4.2 * Removed MPIN occurrences from the Data Dictionary and the “Overview” > “Sensitive (CUI) Data” section.

* Indicated that MPIN has been deprecated in the “Response Schema” > “coreData” > “entityInformation Sub Section”.
06/27/2023 v4.3 * Uploaded a revised Data Dictionary with updated Socio Economic Self Selections.
08/22/2023 v4.4 * Uploaded a revised Data Dictionary with updated Business Types.
09/29/2023 v4.5 * Updated “Additional Help References” documentation to link to SAM.gov Data Services page.
12/06/2024 v4.6 * A new V4 Entity Management API has been created, enabling the response for the Exceeds Domestic Threshold field within the Reps and Certs section of the API response.As part of this change, below are the associated changes made to this OpenGSA page:

* Added Entity Management V4 endpoint information to the Getting Started section.

* Updated the API Description -> Query String Parameters and Response Schema sub-sections to reflect available parameters and response fields in V4.

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

Back to top