Delete

Delete

This endpoint can be used to delete a specific recipient created in TaxBandits API. Your request JSON must include the RecipientId of the recipient you need to delete.

Note:

Recipients cannot be deleted if any tax forms are already associated with them.

DELETE Recipient/Delete

Run in Postman

Request Params

Field	Type	Description
BusinessId	Guid	Unique identifier of a business.
RecipientId	Guid	A unique identifier generated by TaxBandits for a Recipient. You can use this ID for your future reference to Update.

Response Body

Field	Type	Description
RecipientId	Guid	A unique identifier generated by TaxBandits for a Recipient. You can use this ID for your future reference to Update.
RecipientStatus	string	Shows the status of the record.
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error code.
Name	string	Name of the validation error.
Message	string	Description of the validation error.

Payload

Request Params

Recipient/Delete?BusinessId=77cabe33-ce9f-4d65-83ea-1d3d67d4a11a&RecipientId=cab20c84-191b-4adb-8847-561b92f63950&BusinessTINType=EIN&BusinessTIN=42-3313993&RecipientTIN=387-55-2282&RecipientTINType=SSN

Response Json

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

Response: 200

{
  "RecipientId": "ab22017d-c5c7-43f9-8115-21fc78b14b62",
  "RecipientStatus": "DELETED",
  "Errors": null
}

Node.js

Python

Java

.NET C#