Skip to main content
Version: 1.7.3

Get

Get

Use this endpoint to retrieve stored data for a completed W-8BEN form. The response includes the form type, recipient details, submission status, TIN Matching result, and associated payer information. This endpoint can be used to verify form details before filing or to display W-8BEN form information within your application.

Key points​

  • Only completed W-8BEN forms can be retrieved using this endpoint. If the form status is anything other than Completed, no form data will be returned.
  • If BusinessId, or PayeeRef is not provided, TaxBandits will return the completed form associated with the matching PayeeRef under your default business.
  • If multiple completed forms exist for the same PayeeRef, the most recently completed form will be returned.
  • If the PDF URL is included in the response, you can enable URL encryption for added security. Learn more
GET FormW8Ben/Get
Run in Postman

Request Params

FieldTypeDescription
PayeeRefStringUnique identifier of a recipient. Either PayeeRef or Email is required
Size Range: 1-50
EmailStringEmail Address of the recipient.
Size Range: 1-50
BusinessIdGuidOptional Unique Business Identifier. If you do not supply the BusinessId in the request, the BusinessId of the default business will be mapped.
TINStringOptional Taxpayer Identification Number. Use this as an alternative for BusinessId. Values: EIN, SSN
Size Range: 9-11*(Including hyphen)

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
RequesterObjectRequester information.
BusinessIdGuidA unique identifier of the business.
BusinessNmStringBusiness Name of the requester. If the requester is an Individual, then the Payer’s full name will be returned.
FirstNmstringFirst Name of the Individual
MiddleNmstringMiddle Name of the Individual
LastNmstringLast Name of the individual
SuffixstringSuffix of the Individual
TINTypeStringTIN Type of the Requester.
TINStringTaxpayer Identification Number of the requester.
DBAIdStringUnique Identifier for the DBA.
DBARefStringUnique identifier for each DBA. This identifier can be used in future references of the DBA in the API.
PayeeRefStringUnique identifier of the recipient
W8BENStatusStringStatus of the W-8BEN.
StatusTsStringTimestamp of the W-8BEN Status.
FormW8BENRequestTypeStringForm W-8BEN requested Type.
  • URL_API - Form W-8BEN was requested using the RequestByURL method.
  • Email_API - Form W-8BEN was requested using the RequestByEmail method.
  • Email_UI - Form W-8BEN was requested from the TaxBandits UI application.
PdfUrlStringURL to download the completed W-8BEN.
Note: This URL will expire in 24 hours.
EmailStringEmail Address of the recipient. This is the email to which the W-8BEN request was sent.The value will be null if the Form W-8BEN was requested using the API method RequestByURL
FormDataObjectForm W-8BEN data of the recipient.
NmOfIndividualstringName of the Foreign Individual.
CitizenOfCountrystringRecipient country of citizenship.
USTINTypestringTIN type of the recipient. Either SSN or ITIN.
USTINstringRecipient’s TIN
ForeignTINstringForeign TIN of the recipient.
IsFTINNotLegallyRequiredBooleanWhen TRUE, Identifies that benificial owner on line 1 is not legally required to obtain an FTIN from their jurisdiction of residence.
ReferenceNumstringRecipient’s reference number. You can use this field to enter any identification number you have for the recipient.
DOBstringDate of Birth of the recipient
ExpiryDatestringDate of form expiration
PermanentAddressObjectRecipient’s permanent address.
AddressstringRecipient’s Address.
CitystringRecipient’s City
StatestringRecipient’s State
CountrystringRecipient’s Country
PostalCdstringRecipient’s Zip Code
MailingAddressObjectRecipient’s mailing address.
AddressstringRecipient’s Address.
CitystringRecipient’s City
StatestringRecipient’s State
CountrystringRecipient’s Country
PostalCdstringRecipient’s Zip Code
TaxTreatyBenefitsObjectTax Treaty Benefits.
BeneficiaryCountrystringCountry where the recipient claim to be a resident for income tax treaty purposes.
ClaimingProvArticleParastringArticle and paragraph of the treaty benefits.
RateOfWHstringRate of Withholding.
TypeOfIncomestringType of income for which recipient claiming the treaty benefits.
AdditionalConditionsstringAdditional conditions from the tax treaty benefits.
SignatureObjectSignature of the recipient.
SignerNmstringName of the signer.
ErrorsObjectShows detailed error information.

Request Params​

Get the W-8BEN data of a recipient with the PayeeRef and BusinessId.

FormW8Ben/Get?PayeeRef=Pe123451234&BusinessId=7B82B242-1223-4029-9251-C0446298F620

Response JSON​

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

{
"SubmissionId": "4a36dc14-f059-4c89-83cd-ff9e350ed0a0",
"Requester": {
  "BusinessId": "7B82B242-1223-4029-9251-C0446298F620",
  "BusinessNm": "Snowdaze LLC",
  "FirstNm": null,
  "MiddleNm": null,
  "LastNm": null,
  "Suffix": null,
  "TINType": "EIN",
  "TIN": "22-2222222",
  "DBAId": null,
  "DBARef": null
},
"PayeeRef": "snow",
"W8BENStatus": "COMPLETED",
"StatusTs": "2025-02-19 14:36:28 -05:00",
"FormW8BENRequestType": "URL_API",
"PdfUrl": "https://taxbandits-sb-api.s3.amazonaws.com/sample/807f0318-7f5a-4841-9c08-a88b4bf7e7d9.pdf",
"Email": "mark@sample.com",
"FormData": {
  "NmOfIndividual": "Joseph Smith",
  "CitizenOfCountry": "Canada",
  "USTINType": "SSN",
  "USTIN": "111-11-1111",
  "ForeignTIN": null,
  "IsFTINNotLegallyRequired": true,
  "ReferenceNum": "76895",
  "DOB": "07/08/1990",
  "ExpiryDate": "05-01-2028",
  "PermanentAdd": {
    "Address1": "123 E. Main St",
    "Address2": null,
    "City": "Rock Hill",
    "State": "SC",
    "Country": "USA",
    "PostalCd": "29730"
  },
  "MailAdd": {
    "Address1": null,
    "Address2": null,
    "City": null,
    "State": null,
    "Country": null,
    "PostalCd": null
  },
  "W8TaxBenefits": {
    "BeneficiaryCountry": "ZA",
    "ClaimingProvArticlePara": "Article 12(4)",
    "RateOfWH": "10.0",
    "TypeOfIncome": "SOCIAL_SECURITY",
    "AdditionalConditions": "Interest on debt -- India treaty    reduced"
  },
  "Signature": {
    "SignerNm": "Joseph"
  }
},
"Errors": null
}