SBA RESTAURANT REVITALIZATION FUND (RRF)
Overview
We are excited to help you learn API’s related to how an eligible business may receive a tax-free federal award equal to the amount of its pandemic-related revenue loss. The SBA Restaurant API platform is designed to support a simplified process - allowing ecosystem partners to submit Award request onbehalf of restaurant owners. This site provides a step by step guide covering various API’s to submit, withdraw, and get details on the SBA RRF Application.
You will note a unique and discrete data elements that needs to be populated when submitting the Award Application.
**Note: Github and the technical documents made available are to support Ecosystem partners. This guide is not intended to provide policy, procedure, or SBA direction. **
Before you begin, please note the following considerations:
- These APIs allow you to submit Award Application to SBA. This application can be submitted via these APIs, or via the Portal available to all Restaurant owners.
These APIs enforce validation routines on all submitted Award Applications including (but not limited to the following):
- Ecosystem partners submitting RRF Applications must submit it only for eligible Restaurant owners
- Grant calculations and Grant amount must also align to provided values – we do mathematical validation on your input.
- API will validate EIN, SSN, Address, PPP Loan information, Franchise code and other information provided in API, before accepting the application successfully
API Prerequisite
Authorization: All the API’s require Authorization parameters that are needed to be passed in each of the API request. Details below:
Sandbox
For clients to authenticate, the token key should be included in the Authorization HTTP header. The key should be prefixed by the string literal ‘Token’, with white space separating the two strings. For example:
Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b
You will get this token under Sandbox API key (Box folder), look out for email from US SBA Forgiveness (noreply@box.com) .
A Vendor Key is also required. A Vendor Key needs to be passed in the HTTP header as shown with an example.
Vendor-Key: b4784996-c592-4794-b9fe-3c51e6acd49d
You will get this key under Vendor key (Box folder), look out for email from US SBA Forgiveness (noreply@box.com) .
Production
For clients to authenticate, the token key should be included in the Authorization HTTP header. The key should be prefixed by the string literal ‘Token’, with white space separating the two strings. For example:
Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b
You will get this token under Prod API key (Box folder), look out for email from US SBA Forgiveness (noreply@box.com) ..
A Vendor Key is also required. A vendor key will only be provided after client succesfully completes their development by using SBA API’s in sandbox. Vendor key will be available in Box folder after sandbox certification. Vendor Key will be passed in the HTTP header as shown below with an example.
Vendor-Key: b4784996-c592-4794-b9fe-3c51e6acd49d
Important: All API end points must match API dictionary format, for instance having “/” at the end of the URL request for POST, PUT & DELETE API requests
Environment
All the forgiveness API’s are exposed in the Sandbox and Production environment
| Environment | URL |
|---|---|
| Sandbox | https://sandbox.restaurants.sba.gov/ |
| Production | https://restaurants.sba.gov/ |
SBA RRF Application to API Field Mappings
Please review RRF Aplication forms showing mapping of elements on the Application to API attributes.
Use Cases
Use Case 1: Submission of RRF Application - Create a RRF Application and submit supporting documents
Use Case 2: Re-submission of RRF Application - Withdraw and resubmit the RRF Application (if needed)
Use Case 3: Get status of submitted RRF Application - Get the status and additional details about an already submitted RRF Application
Use Case 4: Get document types - Get details about the global functional document types (Not file types) accepted by SBA for RRF Application
Use Case 5: Validation of data - Can be used to validate inputs like Franchise code, Address, SBA PPP Loan number before submitting application
API Dictionary here
FAQ here
Design Consideration here
Developer Support
You can reach out to developer support @ developer@ussbaforgiveness.com