This API request will return the Draft PDF of the forms that are not transmitted yet for review purpose. The draft PDF will have copy A of the form with For Review Only watermark text.
Note: You can only retrieve PDF of a single record/form using this method.
How does it works?
Call the [POST] FormW2/RequestDraftPdfUrl endpoint. You will need to supply the following parameters:
Access Token in the header as Bearer Token (Generated using TaxBandits OAuth authentication API)
Request Parameters: Specify the RecordId for the form you need the Draft PDF form. If you do not have the RecordId, then you request the PDF using the following parameters
- Business Reference - Use the business reference PayerRef or BusinessId or EIN.
- Employee Reference - Use the recipient reference EmployeeId or SSN.
- Tax Year - Tax year of the form you are requesting the PDF.
|RecordId||Guid||Optional Specify the RecordId of the return|
|TINMaskType||string||Optional TIN Mask type on the TIN printed on the PDF|
Allowed values: "MASKED", "UNMASKED"
|TaxYear||string||Optional Tax Year of the return. Specify only if you do not have the RecordId |
Allowed values: "2022","2023"
|Business||object||Optional Collects the Business identifier TIN or TBS Business Id or PayerRef. This object information is required only if you do not have the RecordId|
|BusinessId||Guid||Optional TaxBandits Unique Business Identifier. This ID is generated by TaxBandits after you create a business in your account using the Business endpoint.|
|PayerRef||string||Optional Unique payer identifier assigned by the client.|
Size Range: 1 to 50
|EIN||string||Optional Employer Identification Number. Use this as an alternative for BusinessId or PayerRef.|
Size Range: 9 to 10
|Employee||object||Optional Collects the employee's unique identifier. This object information is required only if you do not have the RecordId|
|EmployeeId||Guid||Optional Unique Employee Identifier generated by TaxBandits|
|SSN||string||Optional Social Security Number. Use this as an alternative for EmployeeIds.|
Size Range: 9 to 11
- Request 1
- Request 2
With just the RecordId
With No RecordId
|RecordId||Guid||Unique identifier of the record|
|EmployeeId||Guid||Unique Employee Identifier generated by TaxBandits|
|DraftPdfUrl||string||URL of the Draft PDF|
|Errors||object||Shows detailed error information|
|Id||string||Returns the validation error code|
|Name||string||Name of the validation error|
|Message||string||Description of the validation error|
- Response 1
- Response 2
The PDFs contain PII (Personally Identifiable Information) data of the recipients. To make sure that the PII data involved is completely secured, TaxBandits has added additional security to the form PDFs.
The PDF links you get in the Response are encrypted, and you will have to decrypt them before downloading.
Refer to this link for the steps to decrypt PDF with Sample codes.