RequestPostalWithAttachment
RequestPostalWithAttachment
Use this endpoint to enable postal mailing of recipient copies, along with any supporting attachments, for 1099 and W-2 forms that have already been transmitted to the IRS or SSA. Your request must contain the ‘RecordId’ of the transmitted forms.
Key Points
- Mask TIN in attachments before uploading.
- Provide either PDFByteArray or FilePath for each RecordId (not both).
- If multiple PDFs are uploaded for the same RecordId, the latest upload replaces earlier ones.
- Limits: Up to 100 PDFs or a total of 100 MB per submission. Each ByteArray must not exceed 2 MB.
POST Utility/RequestPostalWithAttachment Request Body
| Field | Type | Description |
|---|---|---|
| Records | object[] | Object to get the record details |
| RecordId | RecordId | Unique identifiers of the records given by TaxBandits |
| PDFByte | ByteArray | Byte array of the PDF document |
| FilePath | String | File path of the PDF document |
Response Body
| Field | Type | Description |
|---|---|---|
| TotalRecords | String | Returns the count of total records |
| TotalSuccess | String | Returns the count of total success records |
| TotalErrors | String | Returns the count of total error records |
| SuccessRecords | Object[] | Object contains the success records |
| RecordId | Guid | A unique Identifier of the records generated by TaxBandits |
| Status | String | Returns the status of the postal order. |
| StatusTs | String | Returns the date and time of the postal order created. |
| Info | String | Returns the information about the Postal mailing service. |
| ErrorRecords | Object[] | Object contains the error records |
| RecordId | Guid | A unique Identifier of the records generated by TaxBandits |
| Errors | object[] | Shows detailed error information |
| Id | string | Returns the validation error ID |
| Name | string | Name of the validation error |
| Message | string | Description of the validation error |
| Errors | object[] | Shows detailed error information |
| Id | string | Returns the validation error ID |
| Name | string | Name of the validation error |
| Message | string | Description of the validation error |
Request JSON
{
"Records": [
{
"RecordID": "CBCE0DB1-0F4B-4D53-B629-5EAE340F5C66",
"PDFByte": null,
"FilePath": null
},
{
"RecordID": "AD983F3D-48EF-498A-B00E-B84435B4B687",
"PDFByte": null,
"FilePath": "https://files.eric.ed.gov/fulltext/ED510854.pdf"
},
{
"RecordID": "ACF4909F-621E-4308-87B7-FB04AE097561",
"PDFByte": null,
"FilePath": "https://s3.amazonaws.com/taxbandits-dev-api/3683b660-44d1-4ca7-a217-50f3818c51a7.Pdf"
}
]
}
Response JSON
- 200
Success Response - This is a sample response for successful API requests.
{
"TotalRecords": "3",
"TotalSuccess": "3",
"TotalErrors": "0",
"SuccessRecords": [
{
"RecordId": "cbce0db1-0f4b-4d53-b629-5eae340f5c66",
"Status": "Order Created",
"StatusTs": "2026-02-17 06:05:01 -05:00",
"Info": "Postal Order has been created."
},
{
"RecordId": "ad983f3d-48ef-498a-b00e-b84435b4b687",
"Status": "Order Created",
"StatusTs": "2026-02-17 06:05:01 -05:00",
"Info": "Postal Order has been created."
},
{
"RecordId": "acf4909f-621e-4308-87b7-fb04ae097561",
"Status": "Order Created",
"StatusTs": "2026-02-17 06:05:01 -05:00",
"Info": "Postal Order has been created."
}
],
"ErrorRecords": null,
"Errors": null
}