ExpireLink

ExpireLink

Use this endpoint to deactivate a previously generated secure URL for a payer.

Once expired, the URL will no longer allow access to the W-9/W-8 form completion page, preventing further submissions through that link.

POST WhCertificate/Expirelink 

Request Params

Field	Type	Description
BusinessId	Guid	TaxBandits Unique Business Identifier. This ID is generated by TaxBandits after you create a business in your account using the Business endpoint.
TIN	string	Optional Taxpayer Identification Number. Use this as an alternative for BusinessId or PayerRef. Size Range: 9-11 Allowed values "EIN", "SSN" (Including hyphen)
DBAId	Guid	Unique Identifier for the DBA.

Response Body

Field	Type	Description
BusinessId	Guid	Unique identifier of a Business.
Message	string	Shows the status of secure URL link
Errors	object[]	Collection of errors for the Recipient
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

Expire the secure URL generated for the payer.

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

Sample 2

Expire the secure URL generated for a particular DBA of the payer.

WhCertificate/expirelink?TIN=26-3537385&DBAId=3e23954d-77cc-4607-b3ad-2002fe061c01

Request JSON

Response 1

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
}

Response 2

This is a sample response for successful API requests.

{
  "BusinessId": "346a9ee1-8c36-4f20-b11c-b565dc911d84",
  "Message": "WhCertificate URL for the business has expired",
  "Errors": null
}