Skip to main content
Version: 1.7.3

Form W-8BEN Status Change

When the recipient submits Form W-8BEN, you will be notified via this Webhook. The Webhook payload will have W-8BEN details.

If recipients fill in either W-9 or W-8BEN, you can use the WhCertificate Status Change Webhook instead.

Steps to Configure Webhook​ for Form W-8BEN 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 ‘Form W-8BEN Status Change’.

Form W-8BEN

  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.

Different Statuses​

Following are the different types of form statuses that you will receive through Webhooks

  • Completed - Recipient has completed and signed the Form W-8BEN.

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 every time your recipients complete and submit a W-8 BEN. The request’s POST parameter will contain JSON data.

Here is the sample Webhook Post:

    {
    "SubmissionId": "4a811a40-e2ff-47a6-9c11-8126f16badb4",
    "Requester": {
        "BusinessId": "16b7bb6c-1865-4740-9ef9-a0de62157af3",
        "PayerRef": "Snow123",
        "BusinessNm": "Snowdaze LLC",
        "FirstNm": null,
        "MiddleNm": null,
        "LastNm": null,
        "Suffix": null,
        "TINType": "EIN",
        "TIN": "83-3776789",
        "DBAId": null,
        "DBARef": null
    },
    "PayeeRef": "Pe6828",
    "RecipientId": "41228f6e-9640-4912-a9ab-8aece35bd7fa",
    "W8BENStatus": "COMPLETED",
    "StatusTs": "2024-11-25 01:44:19 -05:00",
    "FormW8BENRequestType": "URL_API",
    "PdfUrl": "https://s3.amazonaws.com/taxbandits-sb-api/4e1148fe-53bb-4018-8c39-c74297d3ebfc.Pdf",
    "Email": null,
    "FormData": {
        "NmOfIndividual": "Shawn Williams Sr",
        "FirstNm": "Shawn",
        "MiddleNm": null,
        "LastNm": "Williams",
        "Suffix": "Sr",
        "CitizenOfCountry": "Afghanistan",
        "USTINType": "SSN",
        "USTIN": "374-45-7836",
        "ForeignTIN": "27236572366",
        "IsFTINNotLegallyRequired": false,
        "ReferenceNum": "Pe6828",
        "DOB": null,
        "ExpiryDate": "12/31/2027",
        "PermanentAddress": {
            "Address1": "22 St",
            "Address2": "Clair Ave E",
            "City": "Toronto",
            "ProvinceOrStateNm": "Ontario",
            "Country": "Canada",
            "PostalCd": "M1R 0E9"
        },
        "MailingAddress": {
            "Address1": "22 St",
            "Address2": "Clair Ave E",
            "City": "Toronto",
            "ProvinceOrStateNm": "Ontario",
            "Country": "Canada",
            "PostalCd": "M1R 0E9"
        },
        "TaxTreatyBenefits": {
            "BeneficiaryCountry": null,
            "ClaimingProvArticlePara": null,
            "RateOfWH": "0.0",
            "TypeOfIncome": null,
            "AdditionalConditions": null
        },
        "Signature": {
            "SignerNm": "Shawn "
        }
    },
    "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.