Webhook

By configuring Webhooks, you can receive automated notifications of the Instant TIN Matching status.

note

As the TINs are validated with the IRS database, there may be a few occasions when the IRS has “Intermittent Issues”. During this period, TaxBandits will provide the TIN Matching status as “ON HOLD”. Once the IRS database is ready, we will complete the TIN Matching and provide the status instantly via Webhook (if configured).

Follow the steps below to configure the Webhooks for Instant TIN Matching.

1. Log in to the Developer Console – sandbox.taxbandits.com

2. Navigate to Settings >> Webhooks.

3. Click the Add Webhook button, choose the Event Type as Instant TIN Matching, add your Webhook callback URL, and Notify Email.

Response Body

Field	Type	Description
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.

Response JSON

{
  "RecordId": "9d21a560-a49c-49aa-9939-1ca816f0291d",
  "RefId": null,
  "TINStatusCode": "TIN-001",
  "TINStatus": "SUCCESS",
  "TINStatusMsg": "TIN and Name combination matches IRS records.",
  "Errors": null
}