Skip to main content
Version: 1.7.3

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

FieldTypeDescription
Recordsobject[]Object to get the record details
RecordIdRecordIdUnique identifiers of the records given by TaxBandits
PDFByteByteArrayByte array of the PDF document
FilePathStringFile path of the PDF document

Response Body

FieldTypeDescription
TotalRecordsStringReturns the count of total records
TotalSuccessStringReturns the count of total success records
TotalErrorsStringReturns the count of total error records
SuccessRecordsObject[]Object contains the success records
RecordIdGuidA unique Identifier of the records generated by TaxBandits
StatusStringReturns the status of the postal order.
StatusTsStringReturns the date and time of the postal order created.
InfoStringReturns the information about the Postal mailing service.
ErrorRecordsObject[]Object contains the error records
RecordIdGuidA unique Identifier of the records generated by TaxBandits
Errorsobject[]Shows detailed error information
IdstringReturns the validation error ID
NamestringName of the validation error
MessagestringDescription of the validation error
Errorsobject[]Shows detailed error information
IdstringReturns the validation error ID
NamestringName of the validation error
MessagestringDescription 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

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
}