Skip to main content
Version: 1.7.3

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
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidA unique identifier of the submission.                                                   
PayeeRefStringA unique identifier of the recipient.
(Either PayeeRef or Email is required)
Size Range: 1-50.
EmailStringEmail address of the recipient.
Size Range: 1-50.
PhoneStringThe phone number of the recipient
Size Range: 4-16
CountryPhoneCodeStringRecipient’s country code. If not provided, the US will be selected by default.
Size Range: 2
Allowed values

"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

Response Body

FieldTypeDescription
WhCertificateRecordsObject[]Details of the WhCertificates requested to be deleted.
    SubmissionIdGuidA unique identifier of the submission.
    PayeeRefStringA unique identifier of the recipient.
    EmailStringEmail address of the recipient.
    PhoneStringThe phone number of the recipient
    CountryPhoneCodeStringRecipient’s country code.
    WHStatusStringStatus of the WhCertificate.
    StatusTsStringTimestamp of the WhCertificate status.
ErrorsObject[]Detailed error information.
    IdstringError ID number. This ID is assigned by TaxBandits and it is unique for each error.
    NamestringName of the errored node.
    MessagestringShows the error message.

Request Params​

Delete an existing WhCertificate for the given SubmissionId.

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

Response JSON​

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

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