API Walkthrough

The normal flow for organizations using the API is to call either the TAXPAYERS or REQUEST to collect taxpayer information or have TaxStatus collect consent. If you wish to collect the taxpayer's authorization in your flow, use the TAXPAYERS method. Once the IRS has recorded the consent, organizations can call the INDIVIDUAL or BUSINESS methods to pull the summary of the taxpayers history. If you need the actual transcripts for the taxpayer, call the TRANSCRIPT method or to get all the fields as key value pairs, you can call the TRANSCRIPTDETAIL method. To update the taxpayers data to the most recent/current time, call the UPDATE method.

We can help with this flow and give you options on the best ways to collect consent from the taxpayer.

We recommend you explore the API using the API Walkthrough. Once you register, and are approved, this page will provide everything you need to test our APi in our development sandbox.

Collecting Consent in Your Own Flow

Taxpayers own their own tax data. In order for you to obtain a taxpayer's tax data, they need to authorize the IRS to allow you to see their data. This is done by having the taxpayer agree to language stating who can see it and what they will do with it. During your consent process, you will need to gather information around the taxpayer and send it to TaxStatus. We will not have the taxpayer fillout any information, that we need,more than once. So if you provide everything we need to get IRS authorization, the taxpayere will only need to agree to the IRS language and then electronically sign. TaxStatus will handle this process.

If you choose to host the consent process, you will need to have an iFrame or open a new tab from TaxStatus to show the IRS approved language to the taxpayer and have them agree, to be compliant with the IRS. This text can have business rules around it so you can add language specific to your company. Here is a breif description of how it works:

• Your onboarding flow will gather the necessary info from the taxpayer (name, address, TIN, etc.)
• You then makd the TAXPAYERS call and POST the information to TaxStatus
• The response will be a unique URL (ConsentLink) that you will call from an iFrame or you can redirect to it.
• Taxpayer will then see the consent walkthrough (wizard), which will have all the values from the TAXPAYERS call. The user will then see the IRS langauage and agree to it, filling out first, last, and current date (signing).
• Once taxpayer completes the walkthrough, the iFrame or browser can redirect to the success URL if provided to TaxStatus during company onboarding