Whcertificate Reconciliation Report

Whcertificate Reconciliation Report

GET Reports/WhFormsReconcileReport 

Run in Postman

Use this endpoint to retrieve the count and current status of W-9/W-8 requests initiated across payers in your account.

Provide the BusinessId or PayerRef along with the date range for the period you wish to generate the report, and the response will include a complete summary of WhCertificate requests along with their statuses. Click here to view the complete list of statuses available for W-9/W-8 forms.

Request Params

Field	Type	Description
BusinessId	Guid	Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you have 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	A 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
FromDate	string	Optional Enter a date from which the form W9/W8 records need to be listed in MM/DD/YYYY format.
ToDate	string	Optional Enter a date till which the W9/W8 records created are to be listed in MM/DD/YYYY format.

Response Body

Field	Type	Description
BusinessId	Guid	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.
BusinessNm	string	Name of the business
TIN	String	Taxpayer Identification Number of the requester.
PayerRef	string	A unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API
WithHoldingFormsSummary	object	Returns withholding forms summary
WhCertificate	object	Returns the summary of WhCertificate
URL_GENERATED	number	Returns total number of forms in URL_GENERATED status
ORDER_CREATED	number	Returns total number of forms in ORDER_CREATED status
BOUNCED	number	Returns total number of forms in BOUNCED status
SENT	number	Returns total number of forms in SENT status
OPENED	number	Returns total number of forms in OPENED status
SCHEDULED	number	Returns total number of forms in SCHEDULED status
FormW9	object	Returns the summary of W9
URL_GENERATED	number	Returns total number of forms in URL_GENERATED status
ORDER_CREATED	number	Returns total number of forms in ORDER_CREATED status
BOUNCED	number	Returns total number of forms in BOUNCED status
SENT	number	Returns total number of forms in SENT status
OPENED	number	Returns total number of forms in OPENED status
COMPLETED	number	Returns total number of forms in COMPLETED status
COMPLETED_AND_TIN_MATCH_INPROGRESS	number	Returns total number of forms in COMPLETED_AND_TIN_MATCH_INPROGRESS status
INVALID	number	Returns total number of forms in INVALID status
FormW8BEN	object	Returns the summary of W8 BEN
URL_GENERATED	number	Returns total number of forms in URL_GENERATED status
ORDER_CREATED	number	Returns total number of forms in ORDER_CREATED status
SCHEDULED	number	Returns total number of forms in SCHEDULED status
EXPIRED	number	Returns total number of forms in EXPIRED status
BOUNCED	number	Returns total number of forms in BOUNCED status
SENT	number	Returns total number of forms in SENT status
OPENED	number	Returns total number of forms in OPENED status
COMPLETED	number	Returns total number of forms in COMPLETED status
FormW8BENE	object	Returns the summary of W8BENE
OPENED	number	Returns total number of forms in OPENED status
COMPLETED	number	Returns total number of forms in COMPLETED status
FormW8ECI	object	Returns the summary of W8ECI
OPENED	number	Returns total number of forms in OPENED status
COMPLETED	number	Returns total number of forms in COMPLETED status

Request Params

"Reports/WhFormsReconcileReport?BusinessId=bcc0548a-d44f-4852-be9a-b33566e19ff6&PayerRef=Pe8841&FromDate=11/11/2024&ToDate=03/25/2025"

Response JSON

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

{
    "BusinessId": "8dd045f9-88c1-4694-a713-7b21e406ba03",
    "BusinessNm": "SnowDaze LLC",
    "TIN": "474-29-1927",
    "PayerRef": "Payer123",
    "WithHoldingFormsSummary": {
        "WHCertificate": {
            "URL_GENERATED": 13,
            "ORDER_CREATED": 0,
            "OPENED": 0,
            "SCHEDULED": 0,
            "BOUNCED": 2,
            "SENT": 9
        },
        "FormW9": {
            "URL_GENERATED": 15,
            "ORDER_CREATED": 0,
            "SCHEDULED": 4,
            "BOUNCED": 0,
            "SENT": 12,
            "OPENED": 24,
            "COMPLETED": 88,
            "COMPLETED_AND_TIN_MATCH_INPROGRESS": 0,
            "INVALID": 4
        },
        "FormW8BEN": {
            "URL_GENERATED": 2,
            "ORDER_CREATED": 0,
            "SCHEDULED": 1,
            "BOUNCED": 0,
            "SENT": 1,
            "EXPIRED": 0,
            "OPENED": 16,
            "COMPLETED": 24
        },
        "FormW8BENE": {
            "OPENED": 5,
            "COMPLETED": 2
        },
        "FormW8ECI": {
            "OPENED": 2,
            "COMPLETED": 6
        }
    },
    "Errors": null
}