Skip to main content
Version: 1.7.3

Delete

Use this endpoint to delete a recipient from TaxBandits. In the request JSON, you must provide the RecipientId.

DELETE Recipient/Delete
Run in Postman

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.


"/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

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

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