We have prepared this walkthrough to show you step-by-step how to use the API to collect taxpayer consent and download IRS data and transcripts. In the production environment,
the company will need to have consent granted by the taxpayer, to the company, for all calls except VERIFY and CONSENT.
Once you register, are approved, and login, you will be able to see the API endpoint, Oauth keys, and your registered company Id.
Due to the sensitive nature of tax information, we can not allow you to use real social security numbers and pull real taxpayer information. Therefore we have created some test data and mapped out example use-cases so you can create and test your applications. Use the following taxpayers when developing your application against the Test environment.
TaxStatus uses OAuth2 to authenticate and authorize the API calls. For more information on OAuth2 you can check
here. The choreography
needs to call to authenticate and get an authorization token which will need to be included in the header of each call.
The client credentials will be UTF8 encoded in the body of the call. All attributes listed above are required.
The following is a sample call:
The following is a list of the fields returned in the OAuth response.
The access token that was issued by the authorization server. This needs to be in the header for all API calls.
The type of token this is, will just the string “bearer”.
The server should reply with the duration of time the access token is granted for.
Example of a successful token response:
HTTP/1.1 200 OK
In the Request call, you may use a callback to have your system informed once the taxpayer data is available. If provided, the TaxStatus
system will POST a JSON object to the endpoint provided. The JSON sent will be the same as the Individual or Business calls, whichever is appropriate.
Note: The callback will only POST to an HTTPS endpoint. If the callback is to an HTTP endpoint the callback will redirect to HTTPS.
TaxStatus has additional tools to help with integrating to your company.
Once you register, are approved, and login, you will