Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

GetPDF

TaxBandits provides PDF copies of the tax Return using this API Endpoint. The PDFs can be used for any additional review and approval from your business’ side and it can be distributed to the Employees before the SSA accepts them.

GET FormW2C/GetPDF

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]Optional Unique identifier of a records.
TINMaskTypestringOptional Choose the masking type of your Employee's SSN on the W-2C PDF. MASKED - The Employee's SSN will be masked in the PDF. Only last 4 digits of the SSN can be read. UNMASKED - The Employee's SSN will not be masked in the PDF. To protect the PII information of the Employee, the PDF with Unmasked SSN is password protected. Use the Employee's SSN (password) to open the protected file. BOTH - Two PDF's will be delivered for each Employee. One with Masked SSN and the other with Unmasked SSN. The PDF with Unmasked SSN 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
FormW2CRecordsobject[]Collection of Form W-2C 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 id
    NamestringName of the validation error
    MessagestringDescription of the validation error

Request JSON

FormW2C/GetPDF?SubmissionId=000e9b21-c0fd-421c-867e-93ef54d37b33&RecordIds=f03875e4-e6b5-4cf4-828e-8ca026f0e5e0&TINMaskType=UNMASKED

Response JSON

{ "StatusCode": 200, "StatusName": "Ok", "StatusMessage": "Successful API call", "SubmissionId": "000e9b21-c0fd-421c-867e-93ef54d37b33", "FormW2CRecords": [   {     "RecordId": "f03875e4-e6b5-4cf4-828e-8ca026f0e5e0",     "Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."   } ], "Errors": null}