LinkWhCertificate
If you're managing a Gig economy or Affiliate platform and your vendors or recipients work for multiple businesses or payers, instead of requesting separate W-9s from the same vendor or recipient for each business, you can use this endpoint to copy the W-9, W-8BEN, or W-8BEN-E form (WhCertificate) of a recipient or vendor that was already created under one payer to multiple other payers.
Your request JSON must include,
- New Payer Details: Provide the BusinessId or PayerRef of the payers for whom you want to copy the WhCertificate.
- Source Details: Provide the BusinessId or PayerRef of the payer where the WhCertificate currently exists. RecipientId or PayeeRef of the vendor or recipient.
Upon a successful request, the WhCertificate will be copied to the new payers, and a new RecipientId will be assigned for the vendor or recipient under each new business. If you didn't include PayeeRef in your request, the recipient's existing PayeeRef will be mapped.
POST WHCertificate/LinkWhCertificate
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. |
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 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. |
Response JSON
{
"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
}