Skip to main content
Version: 1.7.3

RequestByEmail

RequestByEmail

This is a payer-initiated method where you can use our API to send an email request containing a unique secure URL to each payee (recipient) for completing Form W-8BEN.

How it works​

1. OAuth 2.0 Authentication​

As with any TaxBandits API call, begin by authenticating through the OAuth 2.0 flow to obtain an access token. This token must be included in the request header as a Bearer token. Refer to the OAuth 2.0 Authentication guide for details on JWT authentication and token handling.

2. Create Business​

Before initiating a W-8BEN request, ensure at least one business (payer) has been created using the Business endpoint. This is a mandatory step.

3. Call the [POST] FormW8BEN/RequestByEmail Endpoint​

Your request must include the following:

  • Authorization Header - Include the Bearer token obtained from OAuth.
  • Payee Email Address - The form completion secure URL will be sent here.
  • Payee Reference (Optional) - A unique ID for referencing the payee in future API calls.
  • Payee Name and Address (Optional) - If included, this info will be pre-filled in the form.
  • Business Identifier (Optional) - Provide the BusinessId or TIN to identify the payer associated with the request. If omitted, the form will be tied to the first business in your account.
  • DBA Reference (Optional) - Used to display a specific DBA name as the requester on the form.
  • Customizations (Optional) - You may include branding customization in the request, such as logo, theme colors, etc, and the redirection URLs where you want the payee to be redirected once they submit the form. You may also include a 'CustomizationId' if you’ve generated one. Learn more
  • Languages (Optional) – Specify the language for the form. Recipients can also change their preferred language if needed. Supported languages: English, French, Spanish, German, Ukrainian and Portuguese

4. Payee completes the form​

TaxBandits will send an email with a secure URL to the payee. Upon clicking the secure URL, the payee can complete Form W-8BEN, e-sign, and submit it.

5. Get notified​

  • Webhooks - If you’ve configured Webhooks for the event type 'Form W-8BEN Status Change' webhook, you will receive a webhook notification once the payee submits the form. The Webhook payload includes payee details (name, TIN, address) and a link to download the completed form. Learn more
  • Status endpoint - Alternatively, you can also use the Status endpoint to retrieve the status.
  • Web messaging - Instead of Webhooks, you can choose to receive notifications via web messaging. For more information, click here.
POST FormW8Ben/RequestByEmail
Run in Postman

Request Body

FieldTypeDescription
SubmissionManifestobjectSubmissionManifest provides brief information about submission and the services opted for.
IsReminderEnabledBooleanOptional When enabled, reminder emails are triggered if the withholding certificate is not completed
ReminderSchdDaysNumberFrequency of reminder emails sent to complete W-9/W-8 forms.
RequesterobjectCollects the Requester identifier, i.e., TIN (or) Business ID/PayerRef generated by TaxBandits. If neither is supplied, the default Business will be assumed as the Requester.
    BusinessIdGuidOptional TaxBandits Unique Business Identifier. This ID is generated by TaxBandits after you create a business in your account using the Business endpoint. If you do not provide the BusinessId in the request, then the URL will be generated against the default business, i.e., the first business created in your account.
    PayerRefGuidOptionalCollects the Requester identifier, i.e., TIN (or) Business ID/PayerRef generated by TaxBandits. If neither is supplied, the default Business will be assumed as the Requester.
    TINStringOptional Taxpayer Identification Number. Use this as an alternate for BusinessId. (Values: EIN, SSN)
Size Range: 9-11
Allowed values

"EIN", "SSN" (Including hyphen)

    DBAIdStringOptionalUnique Identifier for the DBA.
    DBARefStringOptionalA Unique identifier for each DBA. This identifier can be used in future references for the DBA in the API.
Size Range: 1-50
Recipientsobject[]Collects the recipient's unique identifier and other basic information that will be pre-filled on the Form.
    PayeeRefStringOptional A unique identifier for each recipient completing the Form W-9 for future reference.
Size Range: 1-50
    NamestringName of the recipient.
Size Range: ..40
    EmailstringEmail Address of the recipient. This is the email address to which the W-9 request email will be sent.
Size Range: ..100
WebhookRefGuidOptional A unique identifier of the Webhooks that TaxBandits generates against each Callback URL when adding it to the console site.
If you pass the WebhookRef in the request JSON, we will post the webhook response to the corresponding Callback URL. If you don't pass one, the webhook response will be posted to the default Callback URL.
CustomizationIdGuidOptional A unique identifier generated by TaxBandits upon completing the portal customization in the Developer Console, or returned in the response from the PortalCustomization/Create endpoint.
EmailCustomizationIdGuidOptional A unique identifier generated by TaxBandits upon completing the email customization in the Developer Console, or returned in the response from the EmailCustomization/Create endpoint.
CustomizationObjectOptional Collects the customizations like TIN service, Business Logo and Callback URLs.
    BusinessLogoUrlStringOptional Gets the Business Logo. If given the business logo will be shown in the Iframe page.
Size Range: ..150
    LogoPositionStringOptional Optional The position where your business logo will be placed on the page.
Allowed values

"LEFT", "CENTER", "RIGHT"

    InterviewFlowBooleanOptional As an alternative to direct-form entry, provide your recipients with an interview-style W-9/W-8 completion.
    PrimaryColorStringOptional The color theme of the iframe page will be customized with this primary color.
    SecondaryColorStringOptional The color theme of the iframe page will be customized with this secondary color.
    PrefLangStringOptionalLanguage Preference of the form
Allowed values

"en-US", "es-ES", "fr-FR","de-DE","uk-UA","pt-PT"

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
RequesterObjectRequester information.
    BusinessIdGuidA unique identifier of the business.
    BusinessNmStringRequester Name. If the requester is a Business, then the Business Name will be returned. If the requester is an Individual, then the Payer’s full name will be returned.
    FirstNmStringFirst Name of the Individual
Size Range: ..20
    MiddleNmStringMiddle Name of the Individual
Size Range: ..20
    LastNmStringLast Name of the Individual
Size Range: ..20
    SuffixStringSuffix of the Individual
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

    TINTypeStringTIN Type of the Requester.
    TINStringTaxpayer Identification Number of the requester.
FormW8BENRecordsObjectDetails of Form W-8BEN requests given in the request.
    SuccessRecordsObjectRecipients with no error in the request
        PayeeRefStringUnique identifier of the recipient.
        EmailStringEmail Address of the recipient to which W-8BEN request was sent.
        W8BENStatusStringStatus of the W-8BEN.
        StatusTsStringTimestamp of the W-8BEN status.
    ErrorRecordsObjectDetails of the recipients with errors.
        PayeeRefStringAn unique identifier of a recipient.
        EmailStringEmail Address of the recipient given in the request.
        Errorsobject[]Collection of errors for the recipient.
            IdstringError ID number. This ID is assigned by TaxBandits and it is unique for each error.
            NamestringName of the errored node.
            MessagestringShows the error message.
Errorsobject[]There are a variety of errors in the request. Some of the errors listed under this object are,
  • You should have at-least one business in your account to request W-8BEN
  • Insufficient credits in the account

Request JSON​

Send W-8BEN email requests to recipients by giving the BusinessId (Requester) and recipients information. Make sure the Form W-8BEN Status Change webhook is configured.

{
  "SubmissionManifest": {
      "IsReminderEnabled": true,
      "ReminderSchdDays": 10
  },
  "Requester": {
      "BusinessId": null,
      "PayerRef": "Payer1",
      "TIN": "23-0420932",
      "DBAId": "dfb13337-f49b-42fb-b989-07c774a7b81c",
      "DBARef": "#001"
  },
  "Recipients": [
      {
          "PayeeRef": "Pay123",
          "Name": "Mark Davis",
          "Email": "mark@sample.com"
      }
  ],
  "WebhookRef":"99db0874-e749-48d6-b96f-de6447d03667"
}

Response JSON​

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

{
  "SubmissionId": "b78e2c23-bfa2-49e2-bf2a-f2141dbfa61c",
  "Requester": {
      "BusinessId": "c2a7f62d-ca28-49ae-ac74-cf8b69486545",
      "PayerRef": "Payer1",
      "BusinessNm": "Snowdaze LLC",
      "TINType": "EIN",
      "TIN": "34-9058095",
      "DBAId": "0f51f0c9-ecb4-476b-b48a-976eacbaed2a",
      "DBARef": "3212"
  },
  "FormW8BenRecords": {
      "SuccessRecords": [
          {
              "PayeeRef": "9566647097",
              "Email": "mark@sample.com",
              "W8BenStatus": "ORDER_CREATED",
              "StatusTs": "2024-04-05 11:50:21 -04:00"
          }
      ],
      "ErrorRecords": null
  },
  "Errors": null
}