LinkWhCertificate

LinkWhCertificate

Use this endpoint to associate an existing W-9/W-8 certificate with one or more additional payers — without requesting a new form from the recipient. The recipient's existing certificate is reused and mapped to the new payer.

When to use

• A vendor or contractor works for more than one payer.
• Ideal for marketplace and multi-payer platforms where the same vendor, contractor, or service provider works with multiple businesses under your platform

Key points

• Linking a form does not modify the original W-9/W-8 form or the information submitted by the recipient.
• Each payer link is maintained separately and can be retrieved or reviewed individually.
• TIN Matching results from the original form apply to all linked payers. No re-match required.

POST WHCertificate/LinkWhCertificate 

Run in Postman

Request Body

Field	Type	Description
BusinessDetails	Object[]	Contains information about the business for which the withholding certificate information should be duplicated.
BusinessId	Guid	Optional Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
PayerRef	String	Optional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API. Size Range: ..50
PayeeRef	String	Optional An unique identifier for each payee completing their information. This identifier can be used in future references of the payee in the API. Size Range: ..50
SrcWHCertificate	Object	Contains information about the source Withholding Certificate details.
BusinessId	Guid	Optional Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
PayerRef	String	Optional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API. Size Range: ..50
RecipientId	Guid	A unique identifier generated by TaxBandits for a Recipient of the source Withholding Certificate. You can use this ID for your future reference to Update.
PayeeRef	String	A unique identifier for each payee completing their information.

Response Body

Field	Type	Description
DupWHCertificate	Object	It will show detailed information about duplicated Withholding certificate details against each business.
SubmissionId	Guid	Unique identifier of a submission
FormType	String	Gets the type of Withholding certificate form (W9/W8BEN/W8 BEN-E)
BusinessId	Guid	Unique identifier of a Business.
PayerRef	String	Unique identifier of the payer.
RecipientId	Guid	An unique identifier generated by TaxBandits for a Recipient when a Withholding certificate is duplicated. You can use this ID for your future reference to Update.
PayeeRef	String	An unique identifier for each payee completing their information.
Errors	Object[]	Shows detailed error information.
Id	String	Returns the validation error code.
Name	String	Name of the validation error.
Message	String	Description of the validation error.

Request JSON

{
 "BusinessDetails": [    
   {
     "BusinessId": "5b88e3f6-bf34-4e5b-8f8b-7a81bc357e8c",
     "PayerRef": null,
     "PayeeRef": "Sequence1"
   }
 ],
 "SrcWHCertificate": {
   "BusinessId": "8803c2ef-640f-4991-b8c7-080e62877e10",
   "PayerRef": null,
   "RecipientId": "8175ea52-a93c-44de-8ae8-b38f6fa7d326",
   "PayeeRef": null
 }
}

Response JSON

200

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

{
  "DupWHCertificate": [
      {
          "SubmissionId": "d8ca660f-3001-4ec0-a4b9-e6dc509e18c6",
          "FormType": "FormW8BENE",
          "BusinessId": "5b88e3f6-bf34-4e5b-8f8b-7a81bc357e8c",
          "PayerRef": null,
          "RecipientId": "d4d19125-3457-49f3-a9ff-ae474e5cbc88",
          "PayeeRef": "Sequence1"
      }
  ],
  "Errors": null
}

400

Bad Request Response - You'll get the below response when your API requests contain any validation errors.

{
"DupWHCertificate": null,
"Errors": [
  {
    "Id": "F75-100237",
    "Name": "SrcWHCertificate",
    "Message": "The SrcWHCertificate details have not completed any of the W-9, W-8BEN, W8-IMY, W8-EXP or W-8BENE forms."
  }
]
}

401

Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

{
  "StatusCode": 401,
  "StatusName": "Unauthorized",
  "StatusMessage": "Invalid authorization credentials",
  "Errors": [
      {
          "Id": "AUTH-100025",
          "Name": "Authorization",
          "Message": "Authorization should not be empty"
      }
  ]
}