v33

latestOpenAPI 3.0.1GSAraw.githubusercontent.com2024-12-09140105.5 KB
entity-management-controller

get Entity Management Details

get/entity-information/v1/entities

Query parameters

activationDatestring

A single Date or Date range in the format MM/DD/YYYY

cageCodestring

The exact 5 character value; a maximum of up to 100 values can be sent

dbaNamestring

Partial or Complete value

debtSubjectToOffsetstring

Y or N or null

dodaacstring

9 character value

ueiSAMstring

Unique Entity Identifier SAM- 12 digit value; a maximum of up to 100 values can be sent

entityEFTIndicatorstring

EFT indicator

entityStructureCodestring

2 character code or null

entityStructureDescstring

Description of Entity Structure

exclusionStatusFlagstring

D or null

expirationDatestring

A single Date or Date range in the format MM/DD/YYYY

legalBusinessNamestring

Partial or Complete value

primaryNaicsstring

6 digit NAICS; accepts multiple NAICS

purposeOfRegistrationCodestring

2 character code

purposeOfRegistrationDescstring

Description of Purpose Of Registration

registrationDatestring

A single Date or Date range in the format MM/DD/YYYY

updateDatestring

A single Date or Date range in the format MM/DD/YYYY

physicalAddressCitystring

City name

physicalAddressCongressionalDistrictstring

2 characters

physicalAddressCongressionalDistrictStatestring

5 characters

physicalAddressCountryCodestring

3 character code

samExtractCodestring

1 character code (A or E)

physicalAddressProvinceOrStateCodestring

2 character code

physicalAddressZipPostalCodestring

5 digit zip code

businessTypeCodestring

2 Character business type codes

businessTypeDescstring

Description of business type code

entityTypestring

2 Character entity type codes

organizationStructureCodestring

2 Character organization structure codes

organizationStructureDescstring

Organization structure description

stateOfIncorporationCodestring

2 Character state code

stateOfIncorporationDescstring

Descriptionof state

countryOfIncorporationCodestring

3 Character country code

countryOfIncorporationDescstring

Description of country

naicsCodestring

6 Characters NAICS code

naicsDescstring

Description of Naics code

naicsLimitedSBstring

6 Characters NAICS code(with small business - Y)

pscCodestring

4 Characters PSC code

pscDescstring

Description of PSC code

servedDisasterStateCodestring

Disaster relief served state, 2 character code

servedDisasterStateNamestring

Description of Disaster relief served state

servedDisasterCountyCodestring

Disaster relief served county code

servedDisasterCountyNamestring

Description of Disaster relief served county

servedDisasterMSAstring

Disaster relief served MSA

sbaBusinessTypeCodestring

A two character code or null

sbaBusinessTypeDescstring

Description of SBa Business Type code

includeSectionsstring

entityInformation, coreData, assertions, repsAndCerts, mandatoryPOCs, optionalPOCs

qstring

Q paramter for Search Operations

pagestring

page

sizestring

record limit per page

formatstring

Acceptable values JSON and CSV

emailIdstring

Acceptable emailId values are Yes/No

sortstring
sortOrder'asc' | 'desc'
isActivestring
naicsUIstring
pscUIstring
organizationIdstring
edistring

Acceptable EDI values are Yes/No

companySecurityLevelCodestring

Company Security Level Code

highestEmployeeSecurityLevelCodestring

Highest Employee Security Level Code

companySecurityLevelDescstring

Company Security Level Description

highestEmployeeSecurityLevelDescstring

Highest Employee Security Level Description

ultimateParentUEISAMstring

Ultimate Parent Unique Entity Identifier SAM- 12 digit value

agencyBusinessPurposeCodestring

Agency Business Purpose Code

agencyBusinessPurposeDescstring

Agency Business Purpose Description

sensitivitystring

Determines Sensitivity Level of Data

routingNumberstring

Routing Number

bankNamestring

Bank Name

accountNumberstring

Account Number

eftWaiverFlagstring

EFT Waiver Flag

agencyLocationCodestring

Agency Location Code

disbursingOfficeSymbolstring

Disbursing Office Symbol

taxpayerNamestring

Taxpayer Name

taxpayerIdentificationNumberstring

Taxpayer Identification Number

proceedingFlagboolean
execCompensationFlagboolean
isDisasterResponseParticipantstring

Disaster Response participant flag

activationDateFromstring
activationDateTostring
expirationDateFromstring
expirationDateTostring
createDateFromstring
createDateTostring
countrystring
classificationstring
cityStateZipCongFlagboolean
qModestring

qMode paramter for Search Operations

exactMatchboolean

exactMatch paramter for Search Operations

api_keystring

api_key