Skip to main content
Version: 1.7.3

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.

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

DELETE Recipient/Delete

Request Params

FieldTypeDescription
BusinessIdGuidUnique identifier of a business.
RecipientIdGuidA unique identifier generated by TaxBandits for a Recipient. You can use this ID for your future reference to Update.

Response Body

FieldTypeDescription
    RecipientIdGuidA unique identifier generated by TaxBandits for a Recipient. You can use this ID for your future reference to Update.
    RecipientStatusstringShows the status of the record.
    Errorsobject[]Shows detailed error information.
        IdstringReturns the validation error code.
        NamestringName of the validation error.
        MessagestringDescription of the validation error.
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
ResponseDescriptionAction
200
Success Response - This is a sample response for successful API requests.
Response: 200
{
"RecipientId": "ab22017d-c5c7-43f9-8115-21fc78b14b62",
"RecipientStatus": "DELETED",
"Errors": null
}