Update Method POST

The UPDATE method allows a company to request an update of all the taxpayer's information immediately. This call will get the latest data, for the given taxpayer, from the IRS. This can be used in the case of final loan closing or annual loan audits, to get the latest transcripts without needing to involve the taxpayer.

Request Path

Submit all update requests to the following path.

Path

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


Headers

Each request must an OAuth2 tokan and your company Id, assigned by TaxStatus, in the header.

Authorization
euid

Query String Parameters

Query string parameters are not supported on this method.


/Update Request application/json

Post the following JSON object in the body.

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.
  • tin* 9-digit tax id (no spaces or hypens) of the individual or business taxpayer
  • isCompany* Zero (0) if tin is an SSN or one (1) if tin is an EIN

Example call request body for the Update method.

{ "companyId": "enco45100", "tin": "222222222", "isCompany": 0 }

Response Body application/json

The reponse codes for the Update 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.