List
Use this method to list the W-8BENs under a particular business. The W-8BENs can be filtered based on the W-8BEN Statuses and Date Range.
GET FormW8Ben/List
Request Body
Field | Type | Description |
---|---|---|
BusinessId | Guid | Optional Unique identifier of a business. If you do not supply the BusinessId in the request, the BusinessId of the default business will be mapped. |
TIN | String | Optional TIN of the business. If you do not have the BusinessId, you can use the TIN to refer the businessSize Range: 9-11 (including hypen) |
W8BENStatus | String | Optional Status of the W-8BENAllowed values: "Sent", "Order_Created", "Scheduled", "URL_Generated", "Opened", "Completed", "ALL" |
Page | int | Optional Page number that needs to be listed in the Response. If the value is not given, then the page will be defaulted to 1. |
PageSize | int | Optional Number of W-8BEN records to be listed in each page. If the value is not given, then the page size will be defaulted to 100. |
FromDate | String | Optional Lists the W-8BEN records between the date range. |
ToDate | String | Optional Lists the W-8BEN records between the date range. |
Response Body
Field | Type | Description |
---|---|---|
Requester | Object | Requester information. |
  BusinessId | Guid | A unique identifier of the business. |
  BusinessNm | String | Business Name of the requester. If the requester is an Individual, then the Payer’s full name will be returned. |
  TINType | String | TIN Type of the Requester. |
  TIN | String | Taxpayer Identification Number of the requester. |
FormW8BENRecords | Object[] | List of W-8BEN Records. |
  SubmissionId | Guid | Submission ID of the original W-8BEN Request |
  PayeeRef | String | Unique identifier of the recipient |
  NmOfIndividual | String | Recipient Name as given on the Form W-8BEN Line 1. |
  W8BENStatus | String | Status of the W-8BEN. |
  StatusTs | String | Timestamp of the W-8BEN Status |
  PdfUrl | String | URL to download the completed W-8BEN |
  Email | String | Email 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 |
  FormW8BENRequestType | String | Form W-8BEN requested Type.
|
TotalRecords | Int | Number of records available for the business |
TotalPages | Int | Total pages available for the business |
Page | Int | Requested Page Number |
PageSize | Int | Requested Page Size |
Errors | Object | Shows detailed error information. |
Request 1: List with all valid parameters
FormW8Ben/List?BusinessId=387f41d7-b238-455b-b9d7-48f7d48889f5&TIN=124563758&W8BENStatus=Completed&Page=1&PageSize=10&FromDate=03/05/2020&ToDate=03/07/2020
Response 1: The response will list all the W-8BENs under a given BusinessId and TIN. Here TIN refers to the TIN for Business.
{ "Requester": { "BusinessId": "387f41d7-b238-455b-b9d7-48f7d48889f5", "BusinessNm": "John Enterprises", "TINType": "EIN", "TIN": "12-4563758" }, "FormW8BenRecords": [ { "SubmissionId": "8487afa2-ff0e-413e-aa41-ba0b328aac93", "PayeeRef": "Pe123451234", "NmOfIndividual": "ABC Inc", "W8BENStatus": "COMPLETED", "StatusTs": "2021-02-19 14:36:28 -05:00", "PdfUrl": "https://taxbandits-sb-api.s3.amazonaws.com/sample/807f0318-7f5a-4841-9c08-a88b4bf7e7d9.pdf", "Email": "abc@abcinc.com", "FormW8BENRequestType": "URL_API" }, { "SubmissionId": "8487afa2-ff0e-413e-aa41-ba0b328aac93", "PayeeRef": "Pe543221234", "RecipientId": "d94f8462-d509-4636-98dc-aef25fe50ea3", "NmOfIndividual": "Steve Smith", "W8BENStatus": "COMPLETED", "StatusTs": "2021-02-19 14:36:28 -05:00", "PdfUrl": "https://taxbandits-sb-api.s3.amazonaws.com/sample/807f0318-7f5a-4841-9c08-a88b4bf7e7d9.pdf", "Email": "steve@abcinc.com", "FormW8BENRequestType": "Email_API" } ], "TotalRecords": 2, "TotalPages": 1, "Page": 1, "PageSize": 10, "Errors": null}
Request 2: List with BusinessID
FormW8Ben/List?BusinessId=7746f0cd-e8eb-4428-9240-12ea84160ee8
Response 2: A response will list all the W-8BENs that fall under the given BusinessId.
{ "Requester": { "BusinessId": "7746f0cd-e8eb-4428-9240-12ea84160ee8", "BusinessNm": "John Enterprises", "TINType": "EIN", "TIN": "22-2222222" }, "FormW8BENRecords": [ { "SubmissionId": "8487afa2-ff0e-413e-aa41-ba0b328aac93", "PayeeRef": "Pe123451234", "NmOfIndividual": "ABC Inc", "W8BENStatus": "COMPLETED", "StatusTs": "2021-02-19 14:36:28 -05:00", "PdfUrl": "https://taxbandits-sb-api.s3.amazonaws.com/sample/807f0318-7f5a-4841-9c08-a88b4bf7e7d9.pdf", "Email": "abc@abcinc.com", "FormW8BENRequestType": "URL_API" }, { "SubmissionId": "8487afa2-ff0e-413e-aa41-ba0b328aac93", "PayeeRef": "Pe543221234", "RecipientId": "d94f8462-d509-4636-98dc-aef25fe50ea3", "NmOfIndividual": "Steve Smith", "W8BENStatus": "COMPLETED", "StatusTs": "2021-02-19 14:36:28 -05:00", "PdfUrl": "https://taxbandits-sb-api.s3.amazonaws.com/sample/807f0318-7f5a-4841-9c08-a88b4bf7e7d9.pdf", "Email": "steve@abcinc.com", "FormW8BENRequestType": "Email_API" } ], "TotalRecords": 2, "TotalPages": 1, "Page": 1, "PageSize": 10, "Errors": null}
Request 3: Requesting to list all W-8BEN for given Business TIN.
FormW8Ben/List?TIN=22-2222222
Response 3: W-8BEN corresponds to the given TIN and will be listed as an array.
{ "Requester": { "BusinessId": "7746f0cd-e8eb-4428-9240-12ea84160ee8", "BusinessNm": "John Enterprises", "TINType": "EIN", "TIN": "22-2222222" }, "FormW8BenRecords": [ { "SubmissionId": "8487afa2-ff0e-413e-aa41-ba0b328aac93", "PayeeRef": "Pe123451234", "NmOfIndividual": "ABC Inc", "W8BENStatus": "COMPLETED", "StatusTs": "2021-02-19 14:36:28 -05:00", "PdfUrl": "https://taxbandits-sb-api.s3.amazonaws.com/sample/807f0318-7f5a-4841-9c08-a88b4bf7e7d9.pdf", "Email": "abc@abcinc.com", "FormW8BENRequestType": "URL_API" }, { "SubmissionId": "8487afa2-ff0e-413e-aa41-ba0b328aac93", "PayeeRef": "Pe543221234", "RecipientId": "d94f8462-d509-4636-98dc-aef25fe50ea3", "NmOfIndividual": "Steve Smith", "W8BENStatus": "COMPLETED", "StatusTs": "2021-02-19 14:36:28 -05:00", "PdfUrl": "https://taxbandits-sb-api.s3.amazonaws.com/sample/807f0318-7f5a-4841-9c08-a88b4bf7e7d9.pdf", "Email": "steve@abcinc.com", "FormW8BENRequestType": "Email_API" } ], "TotalRecords": 2, "TotalPages": 1, "Page": 1, "PageSize": 10, "Errors": null}
Request 4: List without BusinessID or TIN
FormW8Ben/List?W8BENStatus=Completed&Page=1&PageSize=10&FromDate=03/05/2020&ToDate=03/07/2020
Response 4: Listing based on the given from date & to date, page size details.
{ "Requester": { "BusinessId": "7746f0cd-e8eb-4428-9240-12ea84160ee8", "BusinessNm": "John Enterprises", "TINType": "EIN", "TIN": "22-2222222" }, "FormW8BenRecords": [ { "SubmissionId": "8487afa2-ff0e-413e-aa41-ba0b328aac93", "PayeeRef": "Pe123451234", "NmOfIndividual": "ABC Inc", "W8BENStatus": "COMPLETED", "StatusTs": "2021-02-19 14:36:28 -05:00", "PdfUrl": "https://taxbandits-sb-api.s3.amazonaws.com/sample/807f0318-7f5a-4841-9c08-a88b4bf7e7d9.pdf", "Email": "abc@abcinc.com", "FormW8BENRequestType": "URL_API" }, { "SubmissionId": "8487afa2-ff0e-413e-aa41-ba0b328aac93", "PayeeRef": "Pe543221234", "RecipientId": "d94f8462-d509-4636-98dc-aef25fe50ea3", "NmOfIndividual": "Steve Smith", "W8BENStatus": "COMPLETED", "StatusTs": "2021-02-19 14:36:28 -05:00", "PdfUrl": "https://taxbandits-sb-api.s3.amazonaws.com/sample/807f0318-7f5a-4841-9c08-a88b4bf7e7d9.pdf", "Email": "steve@abcinc.com", "FormW8BENRequestType": "Email_API" } ], "TotalRecords": 2, "TotalPages": 1, "Page": 1, "PageSize": 10, "Errors": null}