Status

Status

This endpoint can be used to retrieve the status of your instant TIN Matching requests. Listed below are the different types of statuses available.

Status Code	Description
TIN-001	SUCCESS – The recipient’s TIN and name combination matches the IRS records
TIN-002	FAILED – The recipient’s TIN and name combination doesn’t match the IRS records
TIN-003	ON HOLD – The IRS system is experiencing intermittent issues, and the TIN Matching hasn’t started yet.

GET InstantTINMatch/Status 

Request Params

Field	Type	Description
RecordId	Guid	A unique identifier generated by TaxBandits when the TIN Matching request is created.
RefId	String	A unique identifier provided for each Instant TIN Matching request.

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message.
RecordId	Guid	A unique identifier generated by TaxBandits when an Instant TIN Matching request is created.
RefId	string	A unique identifier for each Instant TIN Matching request.
TINStatusCode	string	Returns status code for the Instant TIN Matching request.
TINStatus	string	TIN Matching order status
TINStatusMsg	string	Detailed TIN matching status message
Errors	object[]	An array of errors for the recipient.
Id	string	Error ID number. This ID is assigned by TaxBandits, and it is unique for each error.
Name	string	Name of the errored node.
Message	string	Shows the error message.

Request Params

"InstantTINMatch/Status?RecordId=24ef4269-c356-4f0f-ac73-538235f566de&RefId=8596"

Response JSON

200

Success Response - This is a sample response for successful API requests.

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "RecordId": "34ef4269-c356-4f0f-ac73-538235f566de",
  "RefId": null,
  "TINStatusCode": "TIN-001",
  "TINStatus": "SUCCESS",
  "TINStatusMsg": "TIN and Name combination matches IRS EIN records.",
  "Errors": null
}

400

Bad Request Response - You'll get the below response when your API requests contain any validation errors.

{
  "StatusCode": 400,
  "StatusName": "BadRequest",
  "StatusMessage": "Validation error has occurred",
  "RecordId": null,
  "RecipientId": null,
  "RefId": null,
  "TINStatusCode": null,
  "TINStatus": null,
  "TINStatusMsg": null,
  "Errors": [
      {
          "Id": "F00-100191",
          "Name": "RecordId",
          "Message": "RecordId is invalid"
      }
  ]
}

401

Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

{
"StatusCode": 401,
"StatusName": "Unauthorized",
"StatusMessage": "Invalid authorization credentials",
"Errors": [
   {
       "Id": "AUTH-100018",
       "Name": "Authorization",
       "Message": "JWT EXPIRED"
   }
]
}