Skip to main content
Version: 1.7.0

List

This endpoint can be used to list the W-9s under a particular business. If you do not have the BusinessId, you can use the TIN to refer the business.

The W-9s can be filtered based on the W-9 Status and Date Range.

GET FormW9/List 
Run in Postman

Request Params

FieldTypeDescription
BusinessIdGuidOptional A unique identifier of a business. If you do not provide the BusinessId in the request, the BusinessId of the default business will be mapped automatically.
TINStringOptional TIN of the business. If you do not have the BusinessId, you can use the TIN to refer to the business.
Size Range: 9-11
W9StatusStringOptional Status of the W-9
Allowed values

"Sent", "Order_Created", "Scheduled", "URL_Generated", "Opened", "Completed", "Completed_and_TINMatching_Inprogress", "Invalid", "Delivered", "Bounced", "ALL"

PageintOptional Page number that needs to be listed in the response. If the value is not given, then the page number will default to 1.
PageSizeintOptional Number of W-9 records to be listed on each page. If the value is not given, then the page size will default to 100.
FromDateStringOptional List the W-9 records between the specified date range.
Date format - MM/DD/YYYY
ToDateStringOptional List the W-9 records between the specified date range.
Date format - MM/DD/YYYY

Request Params

List with all valid parameters

FormW9/List?BusinessId=387f41d7-b238-455b-b9d7-48f7d48889f5&TIN=124563758&W9Status=Completed&Page=1&PageSize=10&FromDate=03/05/2020&ToDate=03/07/2020

Response Body

FieldTypeDescription
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.
    TINTypeStringTIN Type of the requester.
    TINStringTaxpayer Identification Number of the requester.
FormW9RecordsObject[]List of W-9 Records
    SubmissionIdGuidSubmission ID of the original W-9 Request
    PayeeRefStringA unique identifier of the recipient
    Line1NmStringRecipient Name as given on the Form W-9 Line 1.
    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.
    PdfUrlStringURL to download the completed W-9
    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.
    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.
TotalRecordsIntNumber of records available for the business
TotalPagesIntTotal pages available for the business
PageIntRequested Page Number
PageSizeIntRequested Page Size
ErrorsObject[]Detailed error information.
    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 list all the W-9s under the given BusinessId and TIN. Here, TIN refers to the TIN of the business.

{
"Requester": {
"BusinessId": "7746f0cd-e8eb-4428-9240-12ea84160ee8",
"BusinessNm": "ABC LLC",
"TINType": "EIN",
"TIN": "22-2222222"
},
"FormW9Records": [
{
"SubmissionId": "8487afa2-ff0e-413e-aa41-ba0b328aac93",
"PayeeRef": "Pe123451234",
"Line1Nm": "ABC Inc",
"W9Status": "COMPLETED",
"StatusTs": "2021-02-19 14:36:28 -05:00",
"TINMatching": {
"Status": "SUCCESS",
"StatusTs": "2021-06-10 07:16:01 -04:00",
"Errors": null
},
"PdfUrl": "https://taxbandits-sb-api.s3.amazonaws.com/sample/807f0318-7f5a-4841-9c08-a88b4bf7e7d9.pdf",
"Email": ""sample@bodeem.com"",
"FormW9RequestType": "URL_API"
},
{
"SubmissionId": "8487afa2-ff0e-413e-aa41-ba0b328aac93",
"PayeeRef": "Pe543221234",
"Line1Nm": "Seve Smith",
"W9Status": "COMPLETED",
"StatusTs": "2021-02-19 14:36:28 -05:00",
"TINMatching": {
"Status": "SUCCESS",
"StatusTs": "2021-06-10 07:16:01 -04:00",
"Errors": null
},
"PdfUrl": "https://taxbandits-sb-api.s3.amazonaws.com/sample/807f0318-7f5a-4841-9c08-a88b4bf7e7d9.pdf",
"Email": "sample@bodeem.com",
"FormW9RequestType": "Email_API"
}
],
"TotalRecords": 2,
"TotalPages": 1,
"Page": 1,
"PageSize": 10,
"Errors": null
}