Delete
Delete
Use this endpoint to delete a W-8BEN form associated with a specific recipient. This is helpful when a form is submitted with incorrect details or it’s a duplicate.
Key Points
- Deletion is permanent and cannot be undone.
- You must provide valid identifiers such as the PayeeRef and the associated BusinessId (or TIN) to perform the deletion.
DELETE FormW8Ben/Delete Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique Identifier for a Submission. |
| PayeeRef | String | Unique identifier of a recipient. Either PayeeRef or Email is required Size Range: 1-50 |
| String | Email Address of the recipient. Size Range: 1-50 |
Response Body
| Field | Type | Description |
|---|---|---|
| FormW8BENRecords | Object | Details of the W-8BENs requested for delete |
| SubmissionId | Guid | Unique identifier of a submission. |
| PayeeRef | String | Unique identifier of the recipient |
| String | Email Address of the recipient. | |
| W8BENStatus | String | Status of the W-8BEN |
| StatusTs | String | Timestamp of the status |
| Errors | Object | Shows detailed error information. |
| Id | string | Error ID number. This ID is assigned by TaxBandits and it is unique for each error. |
| Name | string | Name of the errored node. |
| Message | string | Shows the error message |
Request Params
- Sample 1
- Sample 2
- Sample 3
Delete a recipient with SubmissionId
FormW8Ben/Delete?SubmissionId=019c8aec-41fe-4b80-883a-441665dc004a
Delete a recipient with PayeeRef
FormW8Ben/Delete?PayeeRef=Pe123451234
Delete a recipient with Email
FormW8Ben/Delete?Email=steve@abcinc.com
Response JSON
- 200
- 400
- 404
Success Response - This is a sample response for successful API requests.
{
"FormW8BENRecords": [
{
"SubmissionId": "019c8aec-41fe-4b80-883a-441665dc004a",
"PayeeRef": "Pe123451234",
"Email": "mark@sample.com",
"W8BENStatus": "DELETED",
"StatusTs": "2025-02-22 04:24:09 -05:00"
}
],
"Errors": null
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"FormW8BENRecords": null,
"Errors": [
{
"Id": "F08-100059",
"Name": "EmailorPayeeReforSubmissionIdorPhone",
"Message": "At-least one parameter is required (Submissionid, Email, PayeeReference or Phone)"
}
]
}
{
"FormW8BENRecords": null,
"Errors": [
{
"Id": "F00-100198",
"Name": "NotFound",
"Message": "No records found"
}
]
}