GetPDF

GetPDF

This endpoint can be used to generate the PDF copies of the completed Form W-2. You can request the PDFs using any of the following:

• SubmissionId only – To generate PDFs for all records under the submission.
• SubmissionId with RecordIds – To generate PDFs for specific recipient records.

How it works

1. Once the request is processed successfully, a webhook will be triggered containing the download link(s).
2. A separate ZIP file will be generated for each record. Each ZIP file will include copies of the recipient’s form.
3. The files are not encrypted and can be downloaded directly. For security, the download link will expire in 24 hours after Webhook delivery.
4. You can also choose the TIN masking option, allowing the recipient’s TIN to be either masked or unmasked based on your preference.

GET FormW2/GetPDF 

Run in Postman

Request Params

Field	Type	Description
SubmissionId	Guid	Mention the W2 returns Submission ID that you want to GetPdf.
RecordIds	Guid	Optional Mention the W2 returns Record ID that you want to GetPdf. Multiple RecordIds GetPdf under the same Submission can be received by sending the RecordIds comma separated.
TINMaskType	string	Optional Choose the masking type of your Recipient's TIN on the 1099-DIV 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, thePDF with Unmasked TIN is password protected. Use the Recipient's TIN (password) to open the protected file.BOTH - TwoPDFs will be delivered for each Recipient.One with Masked TIN and the other with Unmasked TIN. The PDF with Unmasked TINwill be password protected. Allowed values "MASKED", "UNMASKED", "BOTH"

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
FormW2Records	object[]	Collection of Form W-2 records for which the PDF will be successfully delivered
RecordId	Guid	Unique identifier of a record
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. Size Range: 50
Message	string	Provides additional information regarding the PDF delivery.
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 Params

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

Response JSON

Success Response - This is a sample response for successful API requests.

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