Field reference for public SAM API v1

The fields listed here match up to the SAM data as defined in the public data extract available on SAM. The documentation for the extract is available on the openIAE site here. There are a few fields like the NAICS code which have been broken out into objects or arrays. The documentation will be updated to provide more information about how to expect those codes to be sent to the user, but most of the fields are one-to-one mapped from the public extract file.

We are working on improving access to the information on SAM. If you are directly integrating with SAM and need information about this or other interfaces into SAM, you can go to Interact, sign up, and then contact the your Change Control Board member to get access to the SAM Interfaces and Extracts Working Group forum.

 

Field References SAM API v1

http://gsa.github.io/sam_api/sam/fields.html

Field Name:

Data Type:

Description:

activationDate

string

The date on which the entity's registration went active after all validations were completed. ISO-8601-formatted date

altElectronicBusinessPoc

object

The alternate point of contact for electronic business transactions within the entity

altGovtBusinessPoc

object

The alternate point of contact for government business within the entity

altPastPerformancePoc

object

The alternate point of contact for past performance information for business within the entity

businessStartDate

string

The date the entity was started or acquired. ISO-8601-formatted date

businessTypes

array

An array of business types determined by SBA or Ability One.

cage

string

Commercial And Government Entity (CAGE) Code is a unique identifier assigned to an entity which provides a standardized method of identifying a given facility at a specific location. All US entities must meet a CAGE Code validation process, or will be assigned one by the Defense Logistics Information Service (DLIS).

cageRejectionReason

string

Detailed description of why the entity's CAGE validation was rejected.

certificationsURL

object

An object wrapping a URL linking to a PDF of certification data

companyDivision

string

This field is the Division Name as provided by the Entity

congressionalDistrict

string

The Congressional District in which the entity resides, per their SAM address

corporateStructureCode

string

The structure of the entity as defined by the IRS as a code

corporateStructureDescription

string

The expanded description of the corporate structure

corporateStructureName

string

The expanded description of the corporate structure

corporateUrl

string

The URL provided by the entity for the corporation

correspondenceFlag

string

This field is used to identify an entity's preferred correspondence type. 'M' indicates US Mail', 'F' indicates fax, 'E' indicates email

countryOfIncorporation

string

The country code where the entity was incorporated. This follows the ISO3166 3-digit format. SAM can also accommodate 2 character country codes

creditCardUsage

boolean

Indicates whether an entity is willing to be paid by Government credit card

disasterRelief

object

An object which describes the disaster relief locations which can be serviced by the entity.

type

string

One State

Multiple State

Any State

geographicalAreas

array of objects

Identifies the state if "Multiple States" is presented. Identifies the metropolitan statistical area and county if "One State" is presented.

metropolitanStatisticalArea

string

See list more info

county

string

See list more info

divisionNumber

string

This field is the Division Number as provided by the Entity

dodaac

string

The Department of Defense Activity Address Code (DODAAC) for non-civilian government agencies (DoD). This is filled with the letters "DOD" followed by the agency's 6 digit DoDAAC number

doingBusinessAsName

string

The Doing Business As (DBA) name of the entity provided by D&B monitoring

duns

string

The 9-digit DUNS number of the awardee

dunsPlus4

string

User-created 4-digit extension to the DUNS number indicating more than one set of U.S. banking information for that physical address

electronicBusinessPoc

object

The point of contact for electronic business transactions within the entity

ExcpCounter

boolean

 

expirationDate

string

A system generated date for the date when the entity's registration expires. Any time the user updates the company's information; this date needs to be updated to the current date. ISO-8601-formatted date

fiscalYearEndCloseDate

string

The day of the year in MM/YY format that corresponds to the day on which the company's fiscal year closes

govtBusinessPoc

object

The point of contact for government business within the entity

hasDelinquentFederalDebt

boolean

The Delinquent Federal Debt (DFD) Certification (Flag) tracks status of an outstanding Delinquent Federal Debt owed by the registrant. This flag set to true indicates that the registrant has been determined to have a delinquent obligation owed to the U. S. Federal Government as shown by records at the Department of the Treasury. This flag set to false means the Treasury Department found no delinquent obligation. A non-entry [-] indicates that this registrant has not yet been verified with Treasury. Foreign registrations are not verified.

hasKnownExclusion

boolean

This flag indicates whether an entity has an exclusion record

hasSBAProtest

string

As a contracting officer, you may protest the size of a procurement or sale and file the size protest with the SBA Government Contracting Area Office.

isSmallBusiness

string

Indicates if the entity is a small business

lastUpdateDate

string

The last date on which the entity's registration was updated. ISO-8601-formatted date

legalBusinessName

string

The legal business name of the entity.

mailingAddress

object

The mailing address for the entity

naics

array of objects

The North American Industry Classification System is the standard used by Federal Statistical agencies in classifying business establishments for the purpose of collecting and analyzing statistical data related to the U.S. business economy

isPrimary

boolean

Indicates whether a naics is the primary

naicsCode

string

See list more info

naicsName

string

See list more info

ncage

string

CAGE Codes that are used internationally as part of the NATO Codification System (NCS) are called NCAGE codes. All foreign entities must provide an NCAGE Code

pastPerformancePoc

object

The point of contact for past performance information for business within the entity

pscCodes

array of objects

The Product Service Codes, described by objects, which the entity supports. The 'More info' link takes you to the PSC manual

pscName

string

See list more info

pscCode

string

See list more info

publicDisplay

boolean

Indicates if the entity is opt-ed in/out of public search

purposeOfRegistration

string

Indicates whether the entity is seeking contracts, grants, or intergovernmental transfers

qualifications

object

An object wrapping a URL linking to a PDF of qualifications data

registrationDate

string

The date the initial entity registration was submitted, this date will not change. ISO-8601-formatted date

samAddress

object

The address provided by the entity for contact

stateOfIncorporation

string

The US state in which the entity was incorporated, if applicable

status

string

The status of the entity's registration

statusMessage

string

The status of the entity's registration

submissionDate

string

The date the entity registration was submitted

Common RESTful API Objects

Address Object
An address is represented by a JSON object with a structure as follows:
{    "line1": "1800 F St NW",    "line2": "IAE Offices",    "city": "Washington",    "stateOrProvince": "DC",    "zip": "20504",    "zip4": "0000",    "countryCode": "USA"  }  

Note that city and zip4 are optional.

The countryCode is a 3-digit code based on the GENC standard which is derived from ISO-3166-1 alpha-3 code.

Point of Contact Object
A point of contact object references an individual that is tied to a SAM registration for a particular purpose (e.g., a government point of contact, a point of contact dedicated to past performance reporting, etc.). A point of contact is represented by an object wth a structure as follows:
{    "firstName": "John",    "middleInitial": "Z",    "lastName": "Smith",    "address": { -- address object -- }    "usPhone": "555-555-5555",    "usPhoneExt": "000",    "nonUsPhone": "105055555555",    "nonUsPhoneExt": "000",    "email": "example@example.com"  }  
Note that only firstName, lastName, email and one phone number is required.