Skip to main content
Version: 1.7.0


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

Run in Postman

Request Params

SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]Optional Unique identifier of a records.
TINMaskTypestringOptional Choose the masking type of your Recipient's TIN on the W2-G PDF. MASKED - The Recipient's TIN will be masked in the PDF. Only the last 4 digits of the TIN can beread.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


Request Params

"FormW2G/GetPdf?SubmissionId=894b9d16-da83-424b-b0f7-41bfd37eb3a7&RecordIds=5c263d8c-fa58-4af4-af14-d109db5f49e7& TINMaskType=UNMASKED"

Response Body

StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
FormW2GRecordsobject[]Collection of Form W2-G records for which the PDF will be successfull 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

Response JSON

"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "894b9d16-da83-424b-b0f7-41bfd37eb3a7",
"FormW2GRecords": [
"RecordId": "5c263d8c-fa58-4af4-af14-d109db5f49e7",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
"Errors": null