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-9 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-9 request, ensure at least one business (payer) has been created using the Business endpoint. This is a mandatory step.

3. Call the [POST] FormW9/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-9, e-sign, and submit it.

5. Get notified​

  • Webhooks - If you’ve configured Webhooks for the event type 'Form W-9 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.

Automate TIN Matching
If you want to validate the TINs automatically once collected, you can set the IsTINMatching as TRUE in your request JSON.

POST FormW9/RequestByUrl
Run in Postman

Request Body

FieldTypeDescription
RequesterObjectCollects the Requestor identifier i.e., TIN or TaxBandits 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.
    TINStringOptionalTaxpayer Identification Number. Use this as an alternative for BusinessId or PayerRef.
Size Range: 9-11
    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
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-9 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 US address details of the recipient.
        Address1StringOptional Recipient US Address 1 (street address or post office box of that locality). This will be pre-filled on the Form.
Size Range: ..46
        Address2StringOptional Recipient US Address 2 (suite or apartment number). This will be pre-filled on the Form.
Size Range: ..46
        CityStringOptionalRecipient US City. This will be pre-filled on the Form.
Size Range: ..50
        StateStringOptionalRecipient US State Code. This will be pre-filled on the Form.
Size Range: 2
Allowed values

"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"

        ZipCdStringOptionalRecipient Zip Code. In the format 99999 or 99999-9999. This will be pre-filled on the Form.
Size Range: 5..10
    IsTINMatchingBooleanOptionalTIN Matching will be enabled when the value is set as True. Once the recipient completes Form W-9, TaxBandits will match the Recipient's Name and SSN with the IRS database and notify the client via the webhook with the TIN results.
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.
CustomizationObjectOptionalCollects 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 Gets the position in which the logo should be displayed.
Allowed values

“LEFT”, “CENTER”, “RIGHT”

    InterviewFlowBooleanOptional If TRUE, your vendors will fill the W-9 in an interview flow instead of the traditional Form filling flow.
    PrimaryColorStringOptional Gets the primary color for the portal. You can use this to customize the color theme of the portal to match with your application color
    SecondaryColorStringOptional Gets the secondary color for the portal. You can use this to customize the color theme of the portal to match with your application color
    RedirectUrlsObjectCollects the Redirect Urls as ReturnUrl and CancelUrl.
    PrefLangStringOptionalGets the default display language for the portal. If not set, English will be shown.
Allowed values

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

ShowDownloadPageBooleanOptional If TRUE, your vendors will have the option to download the completed W-9 form.
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-9.
Size Range: ..150
    CancelUrlStringOptional Cancel Redirection URL. Set the callback URL when the recipient clicks the cancel button on the Form W-9. 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.
W9UrlStringURL 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

Request Json​

Request URL for Form W-9 with Payer Reference and opt for Customization and TIN Matching

{
  "Requester": {
      "PayerRef": "D12345",
      "BusinessId": null,
      "TIN": null,
      "DBAId": null,
      "DBARef": null

  },
  "Recipient": {
      "PayeeRef": "123456",
      "Name": "John",
      "IsTINMatching": true
  },
  "Customization": {
      "BusinessLogoUrl": "https://www.spanenterprises.com/Content/Images/span.png",
      "LogoPosition": "CENTER",
      "InterviewFlow": true,
      "PrimaryColor": "#E61A1A",
      "SecondaryColor": "#18F244",
      "ShowDownloadPage": true,
      "PrefLang": "es-ES"
  },
  "RedirectUrls": {
      "ReturnUrl": "https://example.com",
      "CancelUrl": "https://example.com"
  }
}

Response JSON​

{
  "SubmissionId": "6e3195f2-4a56-4349-bb19-69d5f1bb5393",
  "PayeeRef": "123456",
  "W9Url": "https://testlinks.taxbandits.io?uId=6ccae518-e6f8-4c1c-83d9-767bb9949a02",
  "Errors": null
}