Delete

Delete

Use this endpoint to delete a WHCertificate (Form W-9 or W-8) 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 WhCertificate/Delete 

Request Params

Field	Type	Description
SubmissionId	Guid	A unique identifier of the submission.
PayeeRef	String	A unique identifier of the recipient. (Either PayeeRef or Email is required) Size Range: 1-50.
Email	String	Email address of the recipient. Size Range: 1-50.

Response Body

Field	Type	Description
WhCertificateRecords	Object[]	Details of the WhCertificates requested to be deleted.
SubmissionId	Guid	A unique identifier of the submission.
PayeeRef	String	A unique identifier of the recipient.
Email	String	Email address of the recipient.
WHStatus	String	Status of the WhCertificate.
StatusTs	String	Timestamp of the WhCertificate status.
Errors	Object[]	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

Delete an existing WhCertificate for the given SubmissionId.

WhCertificate/Delete?Submissionid=a4f8cb95-016f-435e-95e6-105487d57cbf

Sample 2

Delete an existing WhCertificate for the given PayeeRef.

WhCertificate/Delete?PayeeRef=RE2132565

Sample 3

Delete an existing WhCertificate for the given SubmissionId.

WhCertificate/Delete?Submissionid=6586346e-5ba9-49d8-aece-97cea94b5e53

Sample 4

Delete an existing WhCertificate for the given Email.

WhCertificate/Delete?Email=shawn@sample.com

Response JSON

Response 1

All WhCertificate will be deleted for the given SubmissionId

{
  "WhCertificateRecords": [
      {
          "SubmissionId": "a21325eb-d9e7-441f-a828-78e43f241ade",
          "PayeeRef": "RE2132565",
          "Email": null,
          "WHStatus": "DELETED",
          "StatusTs": "2024-07-22 01:01:50 -04:00"
      }
  ],
  "Errors": null
}

Response 2

All WhCertificate will be deleted for the given PayeeRef

{
  "WhCertificateRecords": [
      {
          "SubmissionId": "320908a8-7bd7-4ce2-b71b-ea6d23210f3c",
          "PayeeRef": "RE2132565",
          "Email": null,
          "WHStatus": "DELETED",
          "StatusTs": "2024-07-22 05:16:10 -04:00"
      },
      {
          "SubmissionId": "e858dd77-b469-40fb-aca2-5b0d8afb2ce8",
          "PayeeRef": "RE2132565",
          "Email": "mark@sample.com",
          "WHStatus": "DELETED",
          "StatusTs": "2024-07-22 05:16:10 -04:00"
      }
  ],
  "Errors": null
}

Response 3

You'll get the below response if your API request contains a submission ID that's invalid or not found in our database.

{
  "WhCertificateRecords": null,
  "Errors": [
      {
          "Id": "F00-100146",
          "Name": "Submission Id",
          "Message": "Submission Id is invalid"
      }
  ]
}

Response 4

All WhCertificate will be deleted for the given Email

{
  "WhCertificateRecords": [
      {
          "SubmissionId": "5dce6c0a-9168-40d5-9e11-43f0966197d3",
          "PayeeRef": "908786545",
          "Email": "shawn@sample.com",
          "WHStatus": "DELETED",
          "StatusTs": "2024-07-22 05:31:16 -04:00"
      }
  ],
  "Errors": null
}