Skip to main content
Version: 1.7.3

ExpireLink

ExpireLink

Use this endpoint to cancel a pending W-9/W-8 collection request before the recipient completes the form. Once the link expires, the recipient can no longer access the secure URL. This can be helpful when the requests are sent to the wrong email address or outdated requests that need to be canceled before sending a corrected request.

Key points​

  • This endpoint applies only to requests in Pending status. Completed or already expired requests are not affected.
  • Expiring the link does not delete the W-9/W-8 form record. Only the secure URL becomes inaccessible to the recipient.
POST WhCertificate/Expirelink
Run in Postman

Request Params

FieldTypeDescription
BusinessIdGuidTaxBandits Unique Business Identifier. This ID is generated by TaxBandits after you create a business in your account using the Business endpoint.
TINstringOptional Taxpayer Identification Number. Use this as an alternative for BusinessId or PayerRef.
Size Range: 9-11
Allowed values

"EIN", "SSN" (Including hyphen)

DBAIdGuidUnique Identifier for the DBA.

Response Body

FieldTypeDescription
BusinessIdGuidUnique identifier of a Business.
MessagestringShows the status of secure URL link
Errorsobject[]Collection of errors for the Recipient
   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​

Expire the secure URL generated for the payer.

whcertificate/expirelink?BusinessId=61536213-43f7-4a75-ba8c-c464f5069b8c

Request JSON​

This is a sample response for successful API requests.

{
  "BusinessId": "61536213-43f7-4a75-ba8c-c464f5069b8c",
  "Message": "WhCertificate URL for the business has expired",
  "Errors": null
}