Guidance on how to fulfill a requirement.
The guidance object provides additional information about how to fulfill a requirement. For instance, this guidance information can include a list of the document type accepted for a particular documentation request, or it can include information about the funding state and retry status of a failed payroll debit.
Below is the list of document options provided via the guidance object's document_options
for document upload requirements.
Requirement | Document Option Name and Label |
---|---|
signatory_identity_verification | signatory_photo_id - Non-expired government-issued photo ID for authorized signer |
signatory_authorization_verification | articles_of_incorporation - Articles of Incorporation (Company registration document) articles_of_incorporation_signatory_amendment - Amendment to Articles of Incorporation showing the addition of Signer |
company_identity_verification | articles_of_incorporation - Articles of Incorporation (Company registration document) bank_statement - Full bank statement including bank name, account number, and account owner's name and address |
federal_ein_verification | ss4 - IRS Form SS4 cp_575 - IRS Form CP-575 (This option is not recommended and will be removed soon.) 147_C - IRS Form 147-C (This option is not recommended and will be removed soon.) 940 - IRS Form 940 (This option is not recommended and will be removed soon.) 941 - IRS Form 941 (This option is not recommended and will be removed soon.) 943 - IRS Form 943 (This option is not recommended and will be removed soon.) 944 - IRS Form 944 (This option is not recommended and will be removed soon.) 945 - IRS Form 945 (This option is not recommended and will be removed soon.) |
company_financial_verification (enables 2-day upgrade) | profit_and_loss - Profit & Loss Statement balance_sheet - Balance Sheet cash_flow_statement - Cash Flow Statement bank_statement - Two months of bank statements including bank name, account number, account owner's name and address, and monthly balances |
state_registration_verification | state_registration - State registration document, proving registration of company in the state of legal address |
bank_account_verification | bank_letter - Bank letter, on bank letterhead, including last four of the account number and account owner’s name bank_statement - Full bank statement including bank name, account number, and account owner's name and address |
bank_account_identity_verification | bank_account_owner_id - Non-expired government-issued photo ID for the owner of the bank account or an Articles of Incorporation or similar company registration document if the account is owned by a business. The guidance object contains an account_owners field representing the list of owners whose ID we are requesting for. The provided ID can be for any of the owners listed in account_owners . |
For funding failure requirements, the guidance object will contain information about the failed debit recovery status. This information is available via the funding_detail
object, and contains the failed payment ID, payroll ID, as well as a funding status and funding message pair. These last two fields can take on the following values during the funding recovery lifecycle:
Funding status | Funding message |
---|---|
failed | The employer has failed to fund payroll. |
ach_redebit_inflight | An ACH redebit attempt has been issued for this employer. |
ach_redebit_awaiting_return_window | An ACH redebit attempt has successfully completed for this employer, and is waiting for the three day ACH return window to clear on YYYY-MM-DD. |
expecting_wire | Check is waiting for the failed debit attempt to be retried via wire. |
resolved | The payroll has been successfully funded and the funding failure has been resolved. |