Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

GetPDF

Retrieves Form 1099 R PDFs. The link for PDFs download will be sent via Webhook after successful API call.

GET Form1099R/GetPDF

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]Optional Unique identifier of a records.
TINMaskTypestringOptional Choose the masking type of your Recipient's TIN on the 1099-R PDF. MASKED - The Recipient's TIN will be masked in the PDF. Only the last 4 digits of the TIN can be read.UNMASKED - The Recipient's TIN will not be masked in the PDF. To protect the PII information of the Recipient, the PDF with Unmasked TIN is password protected. Use the Recipient's TIN (password) to open the protected file.BOTH - Two PDFs will be delivered for each Recipient. One with Masked TIN and the other with Unmasked TIN. The PDF with Unmasked TIN will be password protected.
Allowed values: "MASKED", "UNMASKED", "BOTH"

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
Form1099RRecordsobject[]Collection of Form 1099-R records for which the PDF will be successfully delivered
    RecordIdGuidUnique identifier of a record
    MessagestringProvides additional information regarding the PDF delivery.
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error code
    NamestringName of the validation error
    MessagestringDescription of the validation error
    TypestringType of validation error

Request JSON

Form1099R/GetPdf?SubmissionId=524af29a-a859-46a0-9223-110e02ec4660&RecordIds=55f703fc-4456-4ca6-ab5a-004cf714a95f&TINMaskType=UNMASKED

Response JSON

{   "StatusCode": 200,   "StatusName": "Ok",   "StatusMessage": "Successful API call",   "SubmissionId": "524af29a-a859-46a0-9223-110e02ec4660",   "Form1099RRecords": [       {           "RecordId": "55f703fc-4456-4ca6-ab5a-004cf714a95f",           "Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."       }   ],   "Errors": null}