Skip to main content
Version: 1.7.3

RequestByUrl

RequestByUrl

This is a payee-initiated method that allows vendors, contractors, or affiliates to complete Form W-8BEN on their own, using a secure URL generated by the TaxBandits API. You can embed this URL into your application/portal as an iframe.

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/RequestByUrl Endpoint​

Your request must include the following:

  • Authorization Header - Include the Bearer token obtained from OAuth.
  • Payee Reference (Optional) - A unique identifier for the payee (e.g., vendor ID, email, or random ID). This will be used for future references to this recipient.
  • Payee Name and Address (Optional) - Pre-fills the form with payee details.
  • 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. 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.

4. Payee completes the form​

Once your request is submitted, TaxBandits will return a secure URL in the response. You can either:

  • Embed this URL in your web or native app (iframe), or
  • Share the link directly with the respective 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/RequestByUrl
Run in Postman

Request Body

FieldTypeDescription
RequesterObjectCollects the Requestor identifier i.e., TIN or TBS Business Id or PayerRef. If neither is supplied, the default Business will be assumed as the Requester.
    PayerRefStringOptional Unique payer identifier assigned by the client while requesting the payer information using the endpoint Business/RequestByURL.
Size Range: 1-50
    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.
    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
    TINStringOptionalTaxpayer Identification Number. Use this as an alternative for BusinessId or PayerRef.
Size Range: 9-11
Allowed values : "EIN" , "SSN" (Including hyphen)
RecipientObjectCollects the recipient's unique identifier and other basic information of the recipient that will be pre-filled on the Form.
    PayeeRefStringA unique identifier for each recipient completing the Form W-8BEN which will be used for future reference.
Size Range: 1-50
    NameStringOptional Recipient Name. This will be pre-filled on the Form.
Size Range: ..40
    AddressObjectCollects Foreign address details of the recipient.
        Address1StringRecipient’s foreign address line 1 (street address or post office box of that locality). This will be pre-filled on the Form.
Size Range: ..50
        Address2StringOptionalRecipient’s foreign address line 2 (suite or apartment number). This will be pre-filled on the Form.
Size Range: ..50
        CityStringOptionalRecipient’s Foreign City Name. This will be pre-filled on the Form.
Size Range: ..50
        ProviceOrStateNmStringRecipient’s Foreign State or Province Name. This will be pre-filled on the Form.
Size Range: ..50
        CountryStringOptional Recipient's country code. Refer to Static values.
Size Range: 2
Allowed values

"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

        PostalCdStringRecipient's postal code .
Size Range: ..16
CustomizationIdGuidOptional A unique customization identifier generated by TaxBandits after you complete the customization process in the Developer console or the unique ID you received in the response of the PortalCustomization CREATE Endpoint. endpoint.
Note: You can customize the W-9/W-8 page (secure URL) with your own logo, favicon, and primary and secondary colors.
CustomizationObjectCollects the customizations like TIN service, Business Logo and Callback URLs.
    BusinessLogoUrlStringOptional Business Logo that will be displayed on the Form completion page.
Size Range: ..150
    LogoPositionStringOptional The position where your business logo will be placed on the page.
Allowed values

“LEFT”, “CENTER”, “RIGHT”

    InterviewFlowBooleanOptional If TRUE, your vendors will fill the W-8BEN in an interview flow instead of the traditional Form filling flow.
    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.
    ShowDownloadPageBooleanOptional If TRUE, will provide an option for your payees to download their form
    PrefLangStringOptionalLanguage Preference of the form
Allowed values

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

RedirectUrlsObjectCollects the Redirect Urls as ReturnUrl and CancelUrl.
    ReturnUrlStringOptional Return Redirection URL. Set the callback URL redirection once the recipient completes filling the Form W-8BEN.
Size Range: ..150
    CancelUrlStringOptional Cancel Redirection URL. Set the callback URL when the recipient clicks the cancel button on the Form W-8BEN. Note: If you do not provide the Cancel Callback Redirection URL, the cancel button will not be shown to the recipient.
Size Range: ..150
    RedirectTimeNumberOptional Redirection Time. Set the time before redirecting to the callback URL.
Note: Redirect URL is measured in seconds.
Size Range:5-300

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
PayeeRefStringUnique identifier of the recipient.
W8BenUrlStringURL that can be accessed on its own or embedded on the client's website using Iframe or other means.
        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
Note:

The default business details will be considered as the
requester's details.

Request Json​

Request URL for Form W8-BEN with Payer Reference and opt for Customization

{
  "Requester": {
      "PayerRef": "B12345",
      "BusinessId": null,
      "TIN": null,
      "DBAId": null,
      "DBARef": null
  },
  "Recipient": {
      "PayeeRef": "123456",
      "Name": "John",
      "Address": {
          "Address1": "22 St",
          "Address2": "Clair Ave E",
          "City": "Toronto",
          "ProvinceOrStateNm": "Ontario",
          "Country": "CA",
          "PostalCd": "M1R 0E9"
      }
  },
  "Customization": {
      "BusinessLogoUrl": "https://www.spanenterprises.com/Content/Images/span.png",
      "LogoPosition": "CENTER",
      "PrimaryColor": "FFFFFF",
      "SecondaryColor": "222222",
      "ShowDownloadPage": true,
      "PrefLang": "es-ES"
  },
  "RedirectUrls": {
      "ReturnUrl": "https://exampleweblink1.com",
      "CancelUrl": "https://exampleweblink2.com"
  }
}

Response JSON​

{
  "SubmissionId": "3adc8b08-8d3d-4f76-8244-a871c81d72e1",
  "PayeeRef": "123456",
  "W8BenUrl": "https://testlinks.taxbandits.io?uId=2082121e-7614-4901-b0c3-9dce37224b40",
  "Errors": null
}