GetPDF
GetPDF
This endpoint can be used to generate the PDF copies of the generated Form W-3. You can request the PDFs using any of the following:
- SubmissionId only – To generate PDFs for all records under the submission.
- SubmissionId with RecordIds – To generate PDFs for specific recipient records.
How it works
1. Once the request is processed successfully, a webhook will be triggered containing the download link(s).
2. A separate ZIP file will be generated for each record. Each ZIP file will include copies of the recipient’s form.
3. The files are not encrypted and can be downloaded directly. For security, the download link will expire in 24 hours after Webhook delivery.
4. You can also choose the TIN masking option, allowing the recipient’s TIN to be either masked or unmasked based on your preference.
POST FormW3/GetPDF Request Body
| Field | Type | Description |
|---|---|---|
| TaxYear | string | Tax Year you want to generate the Form W3. Allowed values: "2023","2024","2025" |
| EIN | string | EIN of the Business. |
Response Body
| Field | Type | Description |
|---|---|---|
| StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
| StatusName | string | Name of the status code. |
| StatusMessage | string | Detailed status message. |
| AttachmentCount | string | Total number of Form W3 pdf generated. |
| AttachmentW3 | byte[] | Byte array of Form W3 pdf. |
| Errors | object[] | Shows detailed error information. |
| Code | string | Returns the validation error code. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
| Type | string | Type of validation error. |
Request JSON
{
"TaxYear": "2025",
"EIN": "003333332"
}
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"AttachmentCount": "1",
"Errors": null,
"AttachmentW3": "JVBERi0xLjMKJcOHw6zCj8KiCjEgMCBvYmoKPDwvVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKL0Fjcm9Gb3JtIDQgMCBSCi9NZXRhZGF0YSA3IDAgUgo+PgplbmRvYmoKCjIgMCBvYmoKPDwvVHlwZSAvUGFnZXMKL0tpZHM"
}