Request Method POST

The REQUEST method is used to request consent be obtained by Tax Status, on your behalf, and the transcripts in the request be obtained from the IRS. You do not need to supply any transcript information during the request. it is optional, but if a callback is supplied, the transcripts will be delivered to the callback once the taxpayer is in the system.


Request Path

Submit all verify requests to the following path.

Path

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


Headers

Authorization
euid

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 Tax Status will get consent from the taxpayer. This process is easy and straitforward for the taxpayer, and managed completely by Tax Status. 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.
  • 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 formed, filled out, so the company can obtainn a wet signature from the taxpayer.
  • 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)

{ "companyId":"enco45100", "loanNumber": "LN-00987", "tin":"222222222", "isCompany": 0, "firstName": "Jane", "lastName": "Doe", "street": "123 Elm St", "city": "Los Angeles", "state": "CA", "zip": "90049", "mobile":"3105555555", "email":"janedoe@ggmail.com", "businessName" : "", "title": "", "callback": "https://somedomain.com/tax", "needPDF":false, "needWet":false, "transcripts": [{ "transcriptForm": "1040", "transcriptType": "RECA", "transcriptPeriod": ["202012", "201912", "201812"] }, { "transcriptForm": "INCOME", "transcriptType": "WAID", "transcriptPeriod": ["202012", "201912", "201812"] } ] }

Example: Request body (Business)

{ "companyId":"enco45100", "tin":"555555555", "isCompany": 0, "firstName": "Linda", "lastName": "Doe", "street": "444 First St", "city": "Phoenix", "state": "AZ", "zip": "85002", "mobile":"6135555555", "email":"lindadoe@ggmail.com", "businessName" : "ACME Inc", "title": "CEO", "callback": "https://somedomain.com/tax", "needPDF":true, "needWet":true, "wetCallback":"https://somedomain.com/doc", "transcripts": [{ "transcriptForm": "1120", "transcriptType": "ACTR", "transcriptPeriod": ["202012", "201912", "201812"] }, { "transcriptForm": "INCOME", "transcriptType": "WAID", "transcriptPeriod": ["202012", "201912", "201812"] } ] }

Response Body application/json

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

Response Codes

HTTP Status Code Description Explanation
200 Accepted/OK The request has been accepted with no issues
400 Bad Request You are missing some required fields or the Json in the body is missing or malformed
403 Forbidden You do not have authorization to make this call. Possibly your comapany Id is invalid or you are calling on behalf of a company with which you dont have authority.

© 2022 - Tax Status Inc.