RequestPdfURLs

This method can be used to retrieve PDFs for single or multiple recipients. The PDF URL will be returned in the response only if it is already generated by us. You can use the SubmissionId or RecordIds to request the pdf URLs.

Note: The PDF URL will be returned in response only after the return is transmitted in the API. This method will not work for Inprogress returns.

POST Form1098/RequestPdfURLs 

Request Body

Field	Type	Description
SubmissionId	Guid	Optional Unique identifier of an API submission. Use this node to request the PDFs under a particular submission. If you are going to request the PDFs using the RecordIds, you can leave the SubmissionId blank or null.
RecordIds	object[]	Contains the list of RecordIds for which you are requesting the pdf URLs
RecordId	Guid	Unique identifier of the return.
Customization	object	Contains PDF customizations
TINMaskType	string	Optional Mention whether you want the TIN to be masked in the PDF. If masked, only the last digits of the SSN will be visible and the rest of the digits will be crossed (xxx-xx-1234). Allowed values: "MASKED", "UNMASKED", "BOTH"

Request JSON

{
  "SubmissionId": "932d2691-5e8f-45db-815a-4a97886773b3",
  "RecordId": "14dc0f70-16c7-48b7-88b0-e1a59315061c",
  "Customization": {
    "TINMaskType": "Both"
  }
}

Response Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission.
Form1098Records	object	Contains success and error records of the requested RecordIds.
SuccessRecords	object[]	Contains the successful records with pdf urls if the forms are generated.
RecordId	Guid	Unique identifier of the return.
Status	string	Status of the PDF in TaxBandits. Success - The PDF is generated and you can download it.
Files	object	Contains multiple copies of a particular return.
CopyB	object	Copy B: For Recipient
Unmasked	string	Link to download the Unmasked copy
Masked	string	Link to download the Masked copy
CopyC	object	Copy C: For Payer
Unmasked	string	Link to download the Unmasked copy
Masked	string	Link to download the Masked copy
ErrorRecords	object[]	Contains the error records
RecordId	Guid	Unique identifier of the return.
Status	string	Status of the error record. PDF_Not_Generated - PDF is yet to be generated. You will have to wait and send a new API request to get the PDF. Not Transmitted - The return is not transmitted yet. Invalid RecordId - Given record id is invalid
Message	string	Description of each statuses
Errors	object[]	Lists the errors in the API call
Id	string	Returns the error Id.
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.

{
  "SubmissionId": "9a70a2b1-57f6-46e1-9045-ad8f11719a75",
  "Form1098Records": {
    "SuccessRecords": [
      {
        "RecordId": "b16bf9b8-41a3-4229-80f9-29f99e624663",
        "Status": "Success",
        "Files": {
          "CopyB": {
            "Unmasked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/aec81bcc-e098-4104-932c-d3241a2fd031/5678264b-97d4-43e7-8f9c-daa33841e019/1099/19562802/u/copyb_1up_19562802.pdf",
            "UnmaskedPath": "pdfs/aec81bcc-e098-4104-932c-d3241a2fd031/5678264b-97d4-43e7-8f9c-daa33841e019/1099/19562802/u/copyb_1up_19562802.pdf",
            "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/aec81bcc-e098-4104-932c-d3241a2fd031/5678264b-97d4-43e7-8f9c-daa33841e019/1099/19562802/m/copyb_1up_19562802.pdf",
            "MaskedPath": "pdfs/aec81bcc-e098-4104-932c-d3241a2fd031/5678264b-97d4-43e7-8f9c-daa33841e019/1099/19562802/m/copyb_1up_19562802.pdf"
          },
          "CopyC": {
            "Unmasked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/aec81bcc-e098-4104-932c-d3241a2fd031/5678264b-97d4-43e7-8f9c-daa33841e019/1099/19562802/u/copyc_1up_19562802.pdf",
            "UnmaskedPath": "pdfs/aec81bcc-e098-4104-932c-d3241a2fd031/5678264b-97d4-43e7-8f9c-daa33841e019/1099/19562802/u/copyc_1up_19562802.pdf",
            "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/aec81bcc-e098-4104-932c-d3241a2fd031/5678264b-97d4-43e7-8f9c-daa33841e019/1099/19562802/m/copyc_1up_19562802.pdf",
            "MaskedPath": "pdfs/aec81bcc-e098-4104-932c-d3241a2fd031/5678264b-97d4-43e7-8f9c-daa33841e019/1099/19562802/m/copyc_1up_19562802.pdf"
          }
        }
      }
    ],
    "ErrorRecords": null
  },
  "Errors": null
}

PDF Security

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.