GetPDF

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

GET Form1098T/GetPDF 

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	Optional Unique identifier of a records.
TINMaskType	string	Optional Choose the masking type of your Recipient's TIN on the 1098-T 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 TINwill be password protected. Allowed values: "MASKED", "UNMASKED", "BOTH"

Request Params

"Form1098T/GetPDF?SubmissionId=703c2aaa-6c41-4245-9f0b-11127be6e4dc&RecordIds=32ad3c64-0ee7-4067-ab7d-9af72b08dd90"

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
SubmissionId	Guid	Unique identifier of a submission
Form1098TRecords	object[]	Collection of Form 1098-T records for which the PDF will be successfully delivered
RecordId	Guid	Unique identifier of a record
Message	string	Provides additional information regarding the PDF delivery.
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 JSON

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "703c2aaa-6c41-4245-9f0b-11127be6e4dc",
    "Form1098TRecords": [
        {
            "RecordId": "32ad3c64-0ee7-4067-ab7d-9af72b08dd90",
            "Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
        }
    ],
    "Errors": null
}