[Archived - SDK v1.x] Editing Tax Documentation

This document is relevant only for TaxBit SDK v1.x consumers. The SDK package and document may not be updated regularly.

A few scenarios exist where a customer may need to edit or re-certify their tax documentation:

  • If you have sent tax documentation to TaxBit's servers through a separate ingestion process, your customer will need to make any modifications and certify that tax documentation.
  • After a customer certifies and submits tax documentation using the collection form, TaxBit validates some of the data asynchronously. For example, TaxBit will validate the submitted name and tax ID with the IRS. If the IRS declares the name and tax ID combination invalid, you will likely need to show the collection form when the customer returns to your application for them to correct their name and tax ID.
  • The tax documentation has expired, and you need the customer to make any updates and re-certify their data.

We'll cover how to detect these different scenarios later.

To allow customers to edit or re-certify their tax documentation, call loadEditForm instead of loadCreateForm. Here is an example of how you would call loadEditForm.

taxBit.ui.taxDocumentation.loadEditForm({  
  hostElement: document.querySelector("#tax-info-container")
});

Note: There is a difference between these two methods. The loadCreateMethod will allow you to pass a documentType and data, whereas the loadEditForm method will not. If you're using loadEditForm, TaxBit will use any tax documentation already on our servers to populate the form fields.

When you call loadEditForm, the SDK may cater the experience to particular remediation flows. For example, suppose the IRS has declared the customer's name and tax ID combination invalid. In that case, the SDK will explain this to your customer and provide a simplified workflow for correcting the information.

The return value of loadEditForm is the same as loadCreateMethod, as described in Collecting Tax Documentation.