Skip to main content
Version: 2.0.0

Instant TIN Matching

This webhook can be configured to receive real-time notifications about the status of Instant TIN Matching initiated for your recipients.

Steps to Configure​

  1. Log in to Developer Console
    Navigate to 'Settings' → 'Webhook Notifications'.

  2. Add a webhook
    Click 'Add Webhook' and select the event type 'Instant TIN Matching'.

InstantTINMatching

  1. Provide a callback URL
    Enter a valid HTTPS callback URL (maximum 500 characters). Ensure that your callback URL follows these best practices.

    • The API validates this URL by sending a sample JSON payload.
    • The webhook will be activated only after your endpoint responds with an HTTP 200 status code.

  2. Configure a notification email
    Provide a notification email address. TaxBandits will use this email to alert you if webhook delivery attempts fail.

Statuses available​

The following are the different statuses available for Instant TIN Matching.

  • Success - TIN and Name combination match the IRS records
  • Failed - TIN and Name combination doesn't match the IRS records

Receiving webhook requests​

Once the webhook is configured and the callback URL is successfully authenticated, TaxBandits will send an HTTP POST request to your callback URL whenever a filing status changes.

Each request contains a JSON payload with submission details and record-level status information.

Sample webhook payload​

{
  "RecordId": "5e2433ef-0d2e-4d8d-beba-06dac739a9fc",
  "WebhookRef": "1bccb2e5-a57c-4786-9ff2-ad573b5f9d0d",
  "RefId": "P1235",
  "TINStatusCode": "TIN-001",
  "TINStatus": "SUCCESS",
  "TINStatusMsg": "TIN has been verified successfully",
  "Errors": null
}

Responding to webhook requests​

Your application must respond with HTTP 200 OK to acknowledge receipt of a webhook request.

  • Any response other than 200 is treated as a failed delivery
  • HTTP redirects (301) are not supported and are treated as errors
  • Your endpoint must respond within 5 seconds, or the request is considered a timeout

If a webhook delivery fails or times out, TaxBandits will retry the request up to 9 times within 24 hours.

Validating webhook requests​

Before processing a webhook payload, you must verify that the request originated from TaxBandits.Refer to the Webhook validation documentation to learn how to authenticate incoming webhook requests.