Skip to main content
Version: 1.7.3

Get

This endpoint will return the completed W-9 of a particular recipient. The response will comprise the W-9 information, such as the Name, Address, and TIN, along with a link to download the completed Form W-9.

Key Points

  • Only the W-9s with the ‘COMPLETED’ and ‘COMPLETED_AND_TIN_MATCH_INPROGRESS’ statuses can be retrieved using the Get method.
  • If you do not provide the BusinessId in the request, then the W-9 that matches the Email or PayeeRef linked to the default business will be retrieved.
  • If there are multiple W-9s for the same Email or PayeeRef, the most recently completed W-9 will be retrieved.
GET FormW9/Get
Run in Postman

Request Params

FieldTypeDescription
PayeeRefStringA unique identifier of the 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 provide the BusinessId in the request, the BusinessId of the default business will be mapped.
TINStringOptional Taxpayer Identification Number.Use this as an alternate for BusinessId. (Values: EIN, SSN)
Size Range: 9-11

Request Params

Get the W-9 data of the recipient with PayeeRef and BusinessId

FormW9/Get?PayeeRef=TN33&BusinessId=64581600-1e9b-4b4e-813c-6a1a22232c4e

Response Body

FieldTypeDescription
SubmissionIdGuidA Unique identifier of the submission.
RequesterObjectRequester information.
    BusinessIdGuidA unique identifier of the business.
    PayerRefstringA unique identifier of the recipient(Either PayeeRef or Email is required)
    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
    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.
PayeeRefStringA unique identifier of the recipient.
RecipientIdGuidA unique ID generated by TaxBandits after the return is created and will be returned in the response. You can use this id for your future reference to update.
W9StatusStringStatus of the W-9.
StatusTsStringTimestamp of the W-9 Status
TINMatchingObjectTIN Matching information.
    StatusStringTIN Matching status.
    StatusTsStringTimestamp of the TIN Matching Status.
    ErrorsStringShows the detailed error message.
FormW9RequestTypeStringForm W-9 requested Type.
  • URL_API - Form W-9 was requested using the RequestByURL method.
  • Email_API - Form W-9 was requested using the RequestByEmail method.
  • Email_UI - Form W-9 was requested from the TaxBandits UI application.
PdfUrlStringURL to download the completed W-9.
Note: This URL will expire in 24 hours.
EmailStringEmail Address of the recipient. This is the email to which the W-9 request was sent. The value will be null if the Form W-9 was requested using the RequestByUrl method.
FormDataObjectForm W-9 data of the recipient
    Line1NmstringName as shown on the income tax return
    Line2NmstringBusiness name/disregarded entity name (if different from Line1 Name)
    FirstNmstringFirst Name of the Individual
    MiddleNmstringMiddle Name of the Individual
    LastNmstringLast Name of the individual
    SuffixstringSuffix of the Individual
    TINTypestringTIN type of the recipient.(EIN or SSN)
    TINstringRecipient’s TIN
Size Range: 9
    AddressObjectRecipient’s complete address
        Address1stringRecipient’s Address 1 (number, street)
Size Range: 46
        Address2stringRecipient’s Address 2 (apt. or suite no.)
Size Range: 46
        CitystringRecipient’s City
Size Range: 50
        StatestringRecipient’s State
Size Range: 2
        ZipCdstringRecipient’s Zip Code
Size Range: 5..10
    AccountNumstringRecipient’s account number. You can use this field to enter any identification number you have for the recipient.
    FederalTaxClassificationstringU.S. Federal Tax Classification of the person whose name is entered on Line 1
    IsLine3bBooleanIf TRUE, identifies that the recipient is
  1. Either a partnership, trust or estate that has foreign partners, owners, or beneficiaries and the recipient is providing this form to a partnership, trust, or estate, in which they have an ownership interest. (or)
  2. Received a Form W-8 from any partner, owner, or beneficiary establishing foreign status (or)
  3. Received a Form W-9 from any partner, owner, or beneficiary that has checked the box on line 3b.
    ExemptPayeeCdstringThis code indicates that the recipient is exempt from backup withholding
    ExemptFromFATCAstringThis code indicates that the recipient is exempt from reporting under FATCA.
    IsBackUpWHBooleanIf True identifies that the recipient have been notified by the Internal Revenue Service (IRS) that they are subject to backup withholding.
        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

Response JSON

The response will have the completed W-9 information for the given Payee Reference corresponding to the BusinessId. In addition, the Response Payload will also have the PdfUrl link to download the W-9.

{
    "SubmissionId": "bf8e19da-2549-4c96-9bb4-866976a8d3d2",
    "Requester": {
        "BusinessId": "522368c3-50ac-4501-a0a2-140d57ddbd3d",
        "PayerRef": null,
        "BusinessNm": "Snowdaze LLC",
        "FirstNm": null,
        "MiddleNm": null,
        "LastNm": null,
        "Suffix": null,
        "TINType": "EIN",
        "TIN": "33-2145701",
        "DBAId": null,
        "DBARef": null
    },
    "PayeeRef": "pay2148",
    "RecipientId": "9e1642f1-a0da-4bab-ab92-279a0edad795",
    "W9Status": "COMPLETED_AND_TIN_MATCH_INPROGRESS",
    "StatusTs": "2024-07-30 06:51:38 -04:00",
    "TINMatching": {
        "Status": "ORDER_CREATED",
        "StatusTs": "2024-07-30 06:52:12 -04:00",
        "Errors": null
    },
    "FormW9RequestType": "URL_API",
    "PdfUrl": "https://s3.amazonaws.com/taxbandits-dev-api/9cda7b2f-70e5-43bc-8062-e88b37bdcd2b.Pdf",
    "Email": "shawn@sample.com",
    "FormData": {
        "Line1Nm": "Delights LLC",
        "Line2Nm": "lights",
        "FirstNm": null,
        "MiddleNm": null,
        "LastNm": null,
        "Suffix": null,
        "TINType": "EIN",
        "TIN": "XX-XXX6835",
        "Address": {
            "Address1": "71 SAINT NICHOLAS DR",
            "Address2": null,
            "City": "NORTH POLE",
            "State": "AK",
            "ZipCd": "99705-7752"
        },
        "AccountNum": "236586",
        "FederalTaxClassification": "C Corporation",
        "IsLine3b": false,
        "ExemptPayeeCd": "1",
        "ExemptFromFATCA": "F",
        "IsBackUpWH": true
    },
    "Errors": null
}