IAE Technical & Interface Community (TIC)

Integrated Award Environment | For People Who Make, Receive, and Manage Federal AwardsIntegrated Award Environment | For People Who Make, Receive, and Manage Federal Awards

IAE Technical & Interface Community (TIC)

January 28, 2021

Integrated Award Environment | For People Who Make, Receive, and Manage Federal Awards 2

Agenda

● Administrative Updates

● Data Access Integration of SAM.gov and Beta.SAM.gov

● Data Access with Unique Entity Identifier

● Federal Hierarchy API Updates

● Reference Slides

IAE Technical and Interface Community Meeting - January 28, 2021


Data Access Integration of SAM.gov and beta.SAM.gov

Katherine Rollins



If you are a current user of SAM.gov data:

SAM transitioning to beta.SAM.gov

AS A USER OF SAM.gov DATA YOU NEED TO BE AWARE OF THE

FOLLOWING CHANGES on May 24, 2021

▪ All SAM.gov functionality is moving to beta.SAM.gov on May 24,

2021.

▪ As part of the transition, beta.SAM.gov will be renamed SAM.gov.

▪ After May 24, 2021, access to SAM.gov data services for entity

and exclusion data will only be found at https://open.gsa.gov.

▪ System accounts need to be created in beta.SAM.gov. To learn

how to create a system account, view this System Account Video.

▪ SAM Extracts (Entity Management Public, Entity Management for

Official Use Only (FOUO), Entity Management Sensitive, and

Exclusions Public) will transition from SFTP to access through an

API. They are currently available via API for testing.

▪ SOAP Services will be replaced by REST APIs. REST APIs are

currently available for testing.

UEI (DUNS) 🡪 UEI (SAM)

● The DUNS will remain the authoritative identifier for entities

for SAM.gov data through May 24, 2021.

● The new SAM-generated unique entity identifier (UEI) is

replacing the DUNS number and will be the only identifier on

4/4/2022.

● System users who ingest SAM data need to switch to the new

extracts or APIs and prepare/reconfigure their systems to

allow for the new UEI (SAM).

● New versions of SAM extracts and APIs are available now.

These new extracts contain both the UEI (DUNS) and the UEI

(SAM) to allow users time to prepare for the eventual

transition to UEI (SAM).


https://beta.sam.gov/cm/videos/detail?id=498



Get Ready Now

Regardless of whether you are using SFTP or SOAP services now, you need a system account in beta.SAM.gov to begin working with the REST APIs.

To create a beta.SAM.gov System Account, Go to: www.beta.SAM.gova. Before you can begin the federal system account process, you must have a role of system account administrator or system account

manager. Contact your agency administrator to grant you the correct role. Once you have the role, you can begin the account request process. Note: An existing account in legacy SAM does not guarantee access to beta.SAM.gov system accounts, Your existing account will not be transferred.

a. Create a system account application filling out all required information. i. Determine the relevant packages for your needs. You may request access to multiple APIs when you create a single account.

i. A bona fide need is required for FOUO or sensitive information.ii. The System Description and Function must reference the type of system (financial, contract writing, etc.) that will be using this

data.iii. Once completed, your application will be sent for review.

a. The IAE PMO and security will review the application package and approve or reject the request. 1. Upon system account approval, you can generate a system account API key and access your required files.

You have the option of using our alpha.SAM.gov testing site where you can create a system account and test your connections before moving to the production site. For information on creating a system account in alpha.SAM.gov, please contact [email protected].

http://www.beta.sam.gov

mailto:[email protected]



Understanding Modernized Data Access Points

Previous: Entity Management Extracts Public Data Package/V2 [Access Method: SFTP]

New: Entity/Exclusions Extract Download API - Public https://open.gsa.gov/api/sam-entity-extracts-api/ [Download via API]

Previous: Entity Management Extracts FOUO Data Package/V2 [Access Method: SFTP]

New: Entity/Exclusions Extract Download API - FOUO https://open.gsa.gov/api/sam-entity-extracts-api/ [Download via API]

Previous: Entity Management Extracts Sensitive Data Package/V3 [Access Method: SFTP]

New: Entity/Exclusions Extract Download API - Sensitive https://open.gsa.gov/api/sam-entity-extracts-api/ [Download via API]

Previous: Exclusions Extract Data Package/V2 [Access Method: SFTP]

New: Entity/Exclusions Extract Download API - Public https://open.gsa.gov/api/sam-entity-extracts-api/ [Download via API]

Previous: Entity Management Web Service FOUO [Access Method: Web Service]

New: Beta.SAM.gov Entity Management API https://open.gsa.gov/api/entity-api/[ via REST API]

Previous: Entity Management Web Service Sensitive [Access Method: Web Service]

New: Beta.SAM.gov Entity Management API https://open.gsa.gov/api/exclusion-api/[via Rest API]

https://open.gsa.gov/api/sam-entity-extracts-api/




https://open.gsa.gov/api/entity-api/

https://open.gsa.gov/api/exclusion-api/



Transition SFTP and SOAP

To Transition SAM.gov SFTP 🡪 Beta.SAM.gov (Download API)

1. Go to: https://open.gsa.gov/api/sam-entity-extracts-api/The new extracts layout, which contains production UEIs (as well as the DUNS), is found in these versions of the files. Older versions of the files continue to be available.

a. Sensitive Entity V3 b. FOUO Entity V2 c. Public Entity V2 d. Exclusions V2

To Transition SOAP Services 🡪 REST API

1. Review the technical specifications for the REST APIs:a. Beta.SAM.gov Entity Management API: https://open.gsa.gov/api/entity-api/b. Beta.SAM.gov Exclusions API: https://open.gsa.gov/api/exclusion-api/






NEED MORE HELP?

Help with Transition:

▪ User questions specific to alpha.SAM.gov or testing of these interfaces should be directed to

[email protected].

▪ Users who have questions regarding the SAM-generated UEI or entity validation services specifically

should reach out to [email protected].

▪ Technical questions can always be addressed to the Federal Service Desk (FSD) at www.fsd.gov.

Help with current production SAM.gov interfaces or beta.SAM.gov interfaces:

▪ should always be addressed to the Federal Service Desk (FSD) at www.fsd.gov.



http://www.fsd.gov

http://www.fsd.gov


Data Access with Unique Entity Identifier

Katherine Rollins


Integrated Award Environment | For People Who Make, Receive, and Manage Federal Awards

By April 2022, the federal government will no longer use the DUNS Number to uniquely identify entities in IAE systems and throughout the federal award lifecycle.

● Entities with an active registration in SAM will not need to take action to obtain their UEI; the government will assign their UEI.

● Entities registering for the first time will be assigned a UEI within SAM as part of the registration process.● Sub-awardees who currently require a DUNS number for subaward reporting, but are not registered in SAM,

will need to go to SAM.gov to obtain their UEI. They will only need to complete a short process to establish their entity affiliation with the new UEI.

User questions specific to testing of these interfaces should be directed to [email protected]

Users with questions regarding the SAM-generated UEI or entity validation services specifically should reach out to [email protected]

IAE Systems Modernization: New Unique Entity Identifier


11




Currently, the D-U-N-S ® number is still the official identifier for doing business with the government.

● Entities continue to register in SAM.gov using D-U-N-S ® number assigned by Dun & Bradstreet (D&B).

● Entity uniqueness continues to be validated by D&B as part of the D-U-N-S ® number assignment process.

IAE Systems Modernization: New Unique Entity Identifier


12


If you are a current user of SAM.gov data:

Official UEI(SAM) Data

The official UEI(SAM) has been available in SAM.gov entity and exclusions extracts since the 10/24/2020 SAM.gov release.

Official UEI(SAM)s will be available in upcoming Beta.SAM.gov releases for front end display changes

Official UEI(SAM) Notification Sources● Application Release Notes: SAM.gov, Beta.SAM.gov,

FPDS.gov, eSRS/FSRS, CPARS● OpenGSA Documentation Updates

Not Official UEI(SAM) Sources● Testing Sites: Alpha.SAM.gov, uat.SAM.gov,

Beta.FPDS.gov, etc.● 3rd Party Sites

UEI(SAM) Version - API Transition

IAE is transitioning to production V2 APIs for Opportunities, Entities, and Exclusions. These APIs include UEI(SAM) fields and are the API version to be used post-DUNS.

Opportunities API v2 Promotion: Available on Production beta.SAM.gov now

Entity and Exclusions API v2 Promotion: ● Phase I - Initial Release on beta.SAM.gov now

○ Includes entity/exclusions data currently available plus UEI(SAM) information

● Phase II - Coming soon - Final Release○ Includes all entity and exclusions data elements

Version 1 Deprecations: Date TBD, but no later than 04/2022



Federal Hierarchy API Updates

Brian Gilman



● Integration with DOD PIEE to FH API○ Coming to Alpha March 2021○ Systems using FH API will need to confirm DOD hierarchy is displaying correctly

● Office Move and Move History to FH API(w/ permissions)○ Systems using FH API will need to test API that is showing the correct office history

and maintaining the history

Federal Hierarchy Upcoming Changes


15


February 25, 2021

Next Meeting


?

Other Questions / Comments


IAE Technical and Interface Community Meeting - Month DD, YYYY

Reference Slides


Getting System Help

● Federal Service Desk (FSD) - All users have access

○ Report connectivity issues - user cannot access available tools

○ Report functionality issues - designed functionality is not working or is not available

● IAE/SAM Enhancements (IAEENH) - All CCB Reps should have access*

○ Report system bugs - designed functionality is not accurate

○ Suggest enhancements - functionality can be improved

○ Ticket format is IAEENH-123

● SAM/IAE Request for Assistance (IAEREQ) - All CCB Reps should have access*

○ Request expedited assistance for Work Stoppage - MUST include FSD ticket information

○ Ticket format is IAEREQ-1234

● IAE SAM (IAEDEV) - Development teams have access (CCB Reps do not have access)

○ Ticket format is IAEDEV-12345


*If you are a primary or alternate CCB Rep and do not have access to JIRA (IAEENH and REQASSIST), contact [email protected].



Beta.SAM Entity Information Data Status

● Entity information data has the following status in different mediums as follows:


Location Sensitivity Environment Notes

Entity Extracts Public, FOUO (V1/V2) Production Identical to Authoritative Files in SAM. Loaded at same time as SAM.

Entity Extracts Sensitive (V2/V3) Production Identical to Authoritative Files in SAM. Loaded at same time as SAM.

Entity API Public, FOUO Production Incomplete data, one day delayed

Entity API Sensitive Production Incomplete data, one day delayed.

Entity Display Public Production Incomplete data, one day delayed

Entity Display FOUO, Sensitive Alpha Incomplete data, one day delayed


Beta.SAM.gov API Status (1 of 2)


API Status Access Level Specs Location

PSC API Production Public https://open.gsa.gov/api/PSC-Public-API/

FH FOUO API Production FOUO - System Account Only

https://open.gsa.gov/api/fh-fouo-api/

FH Public API Production Public https://open.gsa.gov/api/fh-public-api/

Opportunities Management APIs v1 Production Role Based https://open.gsa.gov/api/opportunities-api/

Opportunities Management APIs v2 Production Role Based https://open.gsa.gov/api/opportunities-api/

Opportunities Management SOAP Web Services

Production (Deprecating Feb 2021)

Role Based https://open.gsa.gov/api/opportunities-soap-api/

Get Opportunities Public API Production Public https://open.gsa.gov/api/get-opportunities-public-api/

https://open.gsa.gov/api/PSC-Public-API/

https://open.gsa.gov/api/fh-fouo-api/

https://open.gsa.gov/api/fh-public-api/

https://open.gsa.gov/api/opportunities-api/

https://open.gsa.gov/api/opportunities-api/

https://open.gsa.gov/api/opportunities-soap-api/

https://open.gsa.gov/api/get-opportunities-public-api/


Beta.SAM.gov API Status (2 of 2)


API Status Access Level Specs Location

Entity Management API v1 Production Public https://open.gsa.gov/api/entity-api/

Entity Management API v1 Production FOUO https://open.gsa.gov/api/entity-api/

Entity Management API v1 Production Sensitive https://open.gsa.gov/api/entity-api/

Entity Management API v2 Production Public, FOUO, Sensitive


Exclusions API v1 Production Public https://open.gsa.gov/api/exclusion-api/

Exclusions API v2 Production Public https://open.gsa.gov/api/exclusion-api/

Entity/Exclusions Extract API Production Public, FOUO, Sensitive









IAE Technical & Interface Community (TIC)

Documents

Transcript of IAE Technical & Interface Community (TIC)