Design Consideration for API’s
Slug ID or UUID - Usage
Slug ID type | Usage |
---|---|
Grant slug id | Unique slug id of the Grant. You may use this slug id for Loan status check or withdrawing loan application |
Document- Slug ID | Unique slug id of the document as defined in SBA system of records |
Application Life cycle
Status | Description |
---|---|
Application in progress | Application has not been submitted yet, not applicable for application from API |
Esignature Pending | Owner needs to sign Grant application and 4506T |
Esignature Processing | Esign has been completed, waiting for signed application back from Docusign webhook |
Submitted | Application has been submitted completely and is ready for SBA processing |
Under Review | Application is under review by SBA |
IRS Verification | Application is waiting for IRS Verification Results |
Not Approved by SBA | Application was not approved by SBA |
Approved by SBA | Application was approved by SBA |
Applicant Additional Info Needed | SBA needs addiitonal info from Restaurant owner |
Payment Sent | Payment has been initiated by SBA |
Payment Confirmed | Payment has been confirmed by SBA |
Payment Exception | Payment is in exception state |
Applicant Correction | Application can be updated by applicant, not applicable for aplication from ecosystem partners |
Business types
Business type code in API | Business type |
---|---|
1 | Sole prop |
2 | Partnership |
3 | Corporation (C-Corp) |
4 | Limited Liability Company (LLC) |
10 | Subchapter S Corporation (S-Corp) |
16 | Self-Employed Individuals |
17 | Independent Contractors |
24 | Tribal Concerns |
26 | Single member LLC |
90 | LLC_AS_S_CORP |
91 | LLC_AS_C_CORP |
** Note: With Single Member LLC, EIN or SSN is allowed at Business level but only single owner with SSN is allowed at owner Level**
Owner types - Person Vs Business
Owner type code in API | Owner type |
---|---|
1 | Person |
2 | Business |
TIN - EIN vs SSN
TIN type code in API | TIN type |
---|---|
0 | EIN |
1 | SSN |
4 | ITIN |
Veteran status
Veteran status code in API | Veteran status |
---|---|
1 | Non-Veteran |
2 | Veteran |
3 | Service-Disabled Veteran |
4 | Spouse of Veteran |
X | Not Disclosed |
Ethnicity
Ethnicity code in API | Ethnicity |
---|---|
H | Hispanic or Latino |
N | Not Hispanic or Latino |
X | Not Disclosed |
Restaurant type
Restaurant type in API | Description |
---|---|
1 | Restaurant |
2 | Licensed facility or premise of a beverage alcohol producer where the public may taste, sample, or purchase products |
3 | Bar, saloon, lounge, tavern |
4 | Brewery and/or microbrewery (Eligibility requires onsite sales to the public comprising at least 33% of gross receipts) |
5 | Winery (Eligibility requires onsite sales to the public comprising at least 33% of gross receipts) |
6 | Distillery (Eligibility requires onsite sales to the public comprising at least 33% of gross receipts) |
7 | Inn (Eligibility requires onsite sales of food and beverage to the public comprising at least 33% of gross receipts) |
8 | Brewpub, tasting room, taproom (Eligibility requires onsite sales to the public comprising at least 33% of gross receipts) |
9 | Caterer |
11 | Snack and Nonalcoholic Beverage Bar |
12 | Food stand, food truck, food cart |
13 | Bakery (Eligibility requires onsite sales to the public comprising at least 33% of gross receipts) |
14 | Other similar place of business in which the public or patrons assemble for the primary purpose of being served food or drink |
Signer title and IRS Form document types by Business type
Business type | Form | Signer title & corresponding API mapping |
---|---|---|
S-Corp | 1120-S | President (1), Secretary (2), Treasurer (3), Vice_President (4), Assistant_Treasurer (5), Chief_Accounting_Officer (6), Controller (7), Shareholder (8) |
C-Corp | 1120 | President (1), Secretary (2), Treasurer (3), Vice_President (4), Assistant_Treasurer (5), Chief_Accounting_Officer (6), Controller (7), Shareholder (8) |
Partnership | 1065 | Limited_Partner (10), Partner (9) |
LLC - (Files tax as partnership) | 1065 | Limited Partner (10), Partner (9), Managing_Member (13) |
LLC - (Files tax as S-Corp) | 1120-S | President (1), Secretary (2), Treasurer (3), Vice_President (4), Assistant_Treasurer (5), Chief_Accounting_Officer (6), Controller (7), Shareholder (8) |
LLC - (Files tax as C-Corp) | 1120 | President (1), Secretary (2), Treasurer (3), Vice_President (4), Assistant_Treasurer (5), Chief_Accounting_Officer (6), Controller (7), Shareholder (8) |
Sole prop | 1040 | Owner (11) , Sole_Proprietor (12) |
Self-Employed | 1040 | Owner (11) , Sole_Proprietor (12) |
Single member LLC | 1040 | Owner (11) , Sole_Proprietor (12) |
Independent Contractor | 1040 | Owner (11) , Sole_Proprietor (12) |
Tribal Business | 1040 | Owner (11) , Sole_Proprietor (12) |
Supporting document types
Document types | Document Category |
---|---|
Supporting IRS Documentation - 2019 Year | IRS Doc |
Supporting IRS Documentation - 2020 Year | IRS Doc |
Transaction History to Support Account Verification (3 months) | Bank Statement |
Bank Statements (Supporting Gross Receipts) | Bank Statement |
Eligible Expense Documentation | Eligible Expenses |
Verified POS Report (Square, Toast, NCR, Clover) | Point of Sale Reports |
Non-Verified POS Report (All Other POS Providers) | Point of Sale Reports |
TTB Forms | Point of Sale Reports |
IRS Form 1099-K | Point of Sale Reports |
Multiple Location Document (supporting a hybrid of table 1,2 and 3) | Multiple Location Calculation Support |
Other Supporting Docs | Other Required Documentation |
Calculation Table and API Processing rule
Calculation Table | Applicant Criteria | API Processing Rules |
---|---|---|
Table 1 | Applicants that were in operation prior to or on January 1, 2019 | Ecosystem partners will provide following fields (as applicable) related to Table 1- grant_calculation_method of 1, gross_receipts_2019, gross_receipts_2020, date_of_first_sale which should be less than equal to Jan 1, 2019, ppp_first_draw_sba_loan_number, ppp_first_draw_loan_amount, ppp_second_draw_sba_loan_number, ppp_second_draw_loan_amount, additional PPP Loan details, number_of_locations, grant_amount. SBA system will recalculate Grant amount real time and will send succesful reponse back even if Gross amount calculated is different (say due to PPP Loan details differences). SBA system will look for valid PPP Loan number |
Table 2 | Applicants that began operations partially through 2019 | Ecosystem partners will provide following fields (as applicable) related to Table 2- grant_calculation_method of 2, gross_receipts_2019, gross_receipts_2020, months_in_operation, date_of_first_sale which should be in 2019, ppp_first_draw_sba_loan_number, ppp_first_draw_loan_amount, ppp_second_draw_sba_loan_number, ppp_second_draw_loan_amount,additional PPP Loan details, number_of_locations, grant_amount. SBA system will recalculate Grant amount real time and will send succesful reponse back even if Gross amount calculated is different (say due to PPP Loan details differences).SBA system will look for valid PPP Loan number |
Table 3 | Applicants that began operations on or between January 1, 2020 and March 10, 2021; and for Applicants that have not yet opened but as of March 11, 2021, have incurred eligible expenses: | Ecosystem partners will provide following fields (as applicable) related to Table 3- grant_calculation_method of 3, gross_receipts_signature_date, eligible_expenses, date_of_first_sale which should be between January 1, 2020 and March 10, 2021 or N/A , ppp_first_draw_sba_loan_number, ppp_first_draw_loan_amount, ppp_second_draw_sba_loan_number, ppp_second_draw_loan_amount, additional PPP Loan details, number_of_locations, grant_amount. SBA system will recalculate Grant amount real time and will send succesful reponse back even if Gross amount calculated is different (say due to PPP Loan details differences).SBA system will look for valid PPP Loan number |
Table 4 | If Applicant has more than one locations and using more than 1 table for calculation or have different crietrias within one table | Ecosystem partners will provide following fields (as applicable) related to Table 4 - grant_calculation_method of 4, date_of_first_sale , ppp_first_draw_sba_loan_number, ppp_first_draw_loan_amount, ppp_second_draw_sba_loan_number, ppp_second_draw_loan_amount, additional PPP Loan details, number_of_locations, grant_amount. SBA system will take Grant amount provided by ecosystem partner and will not do recalculation. SBA system will look for valid PPP Loan number |
Maximum characters limitation
Field | Maximum Characters |
---|---|
dba_tradename | 80 |
legal_name | 80 |
address1 | 80 |
address2 | 80 |
signer_email | 80 |
Position (title) | 80 |
first_name | 40 |
last_name | 40 |
city | 40 |