Skip to main content
Version: 1.7.3

TIN Matching Status Change

When the status of TIN Matching changes, you will be notified via this Webhook. The payload will have TIN Matching order status, Timestamp on when the status change occurred, and the number of TIN Matching attempts remaining for the particular recipient TIN.

If TIN Matching is opted as part of Form W-9 or WhCertificate endpoints, the TIN Matching status will be provided in the respective Webhook itself (WhCertificate Status Change or Form W-9 Status Change).

Steps to Configure Webhook​ for TIN Matching Status Change​

  1. Log in to the Developer Console Site. Navigate to Settings >> Webhook Notifications.

  2. Click the Add Webhook button and choose the Event Type as ‘TIN Matching Status Change’.

TIN Matching Status

  1. Enter the callback URL and click on the Submit button. Ensure that the callback URL you enter is valid, as the API will authenticate this URL by posting a sample JSON. The URL will be activated only when we receive the 200 response. You must follow these best practices to have a valid callback URL for Webhook.

  2. Then, provide a Notify email. This email will be used by TaxBandits to notify you regarding any failed attempts of Webhook posting.

Status Codes​

Following are the different types of status codes that you will receive through Webhooks

  • Order Created - The TIN Matching order is created in Taxbandits. The TIN Matching request is yet to be sent to the IRS.

  • Sent to Agency - The order has been sent to the IRS for TIN verification, and TaxBandits is waiting for the response from the IRS. Usually, the IRS takes one business day to complete the TIN verification process

  • Success - The recipient’s Name and TIN combination match the records in the IRS database.

  • Failed - The recipient’s Name and TIN combination do not match the records in the IRS database.

Receive Webhook Requests from API:​

Once the Webhooks are configured, and the callback URL is authenticated by receiving a 200 response using a sample post, our API will start issuing an HTTP Post to the URL once the status of TIN Matching is changed. The request’s POST parameter will contain JSON data.

Here is the sample Webhook Post:

    {
        "SubmissionId": "d77a9c79-7c0f-48cc-b43b-62bd88f76818",
        "RecordId": "3e8092d9-6615-467f-9112-ab2c2c5c64f8",
        "SequenceId": "qq45",
        "RecipientId": "8a987db5-2d66-4183-a427-74696bccf853",
        "Name": "William Carter",
        "TINType": "EIN",
        "TIN": "XX-XXX8050",
        "Status": "SUCCESS",
        "StatusTs": "2023-11-24 02:17:42 -05:00",
        "NumOfAttemptsRmng": null,
        "Errors": null
    }

Respond to Webhook Post from API​

You must respond to the Webhook post by sending an HTTP 200 OK Response. Any other code other than 200 will be treated as an incomplete call. This API does not support 301 redirects, which will be treated as an error. Learn more

You are required to initiate a response to our Webhook request within 5 seconds, if not, the request will be treated as timeout. If the API doesn’t receive a response during the 5-second time window or in case of an error, it will attempt to retry the connection a total of 9 times within 24 hours.

Before you respond to a Webhook request, you must validate if the request was sent from TaxBandits. To learn how to validate Webhook requests, click here.