Request Path

Submit all request requests to the following path.

You will obtain the API endpoint after you register on your account page.

Headers

Query String Parameters

Query string parameters are not supported on this method.

/Request Request application/json

Organization can simply post all the captured request details to the REQUEST method, and TaxStatus will get consent from the taxpayer. This process is easy and straitforward for the taxpayer, and managed completely by TaxStatus. No forms need to be filled out by the taxpayer and the process only takes minutes.

Request Body

Below are the attributes for the Request method.

Attributes

• companyId* The company Id of the company this call is on behalf of. If the call is not on behalf of another company, then the registered company Id TaxStatus assigned during the registration process (used in the euid field in the header).
• loanNumber A unique Id that can be used to identify if the taxpayer is part of a loan. Also, this field is used to group together individuals and buainesses as one transaction over multiple API calls. So if you make a call with and individual and another with the same individual but also a business they need to sign for, use this field and send the same value for both calls. We will thne only have the taxpayer go through one signing event for both themselves and any business they are singing for.
• tin* 9-digit tax id (no spaces or hypens) of the individual (SSN) or company (EIN).
• isCompany* Zero (0) if tin is an SSN or one (1) if tin is an EIN
• fIrstName* First name of taxpayer or business director
• lastName* Last name of taxpayer or business director
• street* Street address of business or personal residence
• city* City for business or personal residence
• state* 2-Digit state abbreviation for business or personal residence
• zip* 5-Digit zip code for business or personal residence
• mobile* Mobile phone for individual or appropriate party if a business
• email* Email address for individual or appropriate party if a business
• businessName (For businesses only) Name of business. Required if business
• title (For businesses only) Title of director authorized to provide consent. Required if business
• callback Webhook that, if provided, will be used to callback company once taxpayer is in the system. The JSON sent will be the same as the Individual or Business calls, whichever is appropriate. Unless transcript information was provided. In that case, the transcripts (see Transcript call) will be sent in the callback. See the Walkthrough page, when authenticated, to test your callback URL. Note: The callback will only POST to an HTTPS endpoint. If the callback is to an HTTP endpoint the callback will redirect to HTTPS.
• needPDF If provided, along with a callback endpoint and transcript information, a boolean as to whether the transcripts, sent in the callback, need to be PDF instead of the standard HTML.
• needWet If provided and the entity needs to have a wet signature on file. If true, the authorization form will be generated and sent to the wetCallback endpoint.
• wetCallback Webhook that, if provided, will be used to callback company and POST the authorization form, filled out, so the company can obtainn a wet signature from the taxpayer.
• landingPageURL The URl of the consent experience where the taxpayer should sign.
• transcripts An optional array indicationg which transcripts need to be ordered, if known. Otherwise do not include transcripts section.
  • transcriptType* One of the transcript types (ACTR, WAID, RECA, RETR)
  • transcriptForm* The form type to be ordered (1040,940,941,INCOME,etc.)
  • transcriptPeriod* The tax year and month concatinated together i.e. - 201812

Example: Request body (Individual)

Example: Request body (Business)

Response Body application/json

The reponse codes for the request call are standard HTML response codes.

Response Codes