Skip to main content
Version: 1.7.3

RequestPdfUrls

POST Form5498ESA/RequestPdfUrls 
Run in Postman

Request Body

FieldTypeDescription
SubmissionIdGuidOptional 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, then leave the SubmissionId blank or null.
RecordIdsobject[]Contains the list of RecordIds for which you are requesting the pdf URLs.
    RecordIdGuidUnique identifier of the return.
CustomizationobjectContains PDF customizations
    TINMaskTypestringOptional 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": "07acdd4a-26bd-4b5c-8163-e4e1641f9747",
"RecordIds": [
{
"RecordId": "a648f689-3a92-4546-b12c-972882b1c71a"
}
],
"Customization": {
"TINMaskType": "Both"
}
}

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
Form5498ESARecordsobjectContains success and error records of the requested RecordIds.
    SuccessRecordsobject[]Contains the successful records with pdf urls if the forms are generated.
        RecordIdGuidUnique identifier of the return.
        StatusstringStatus of the PDF in TaxBandits.
Success - The PDF is generated and you can download it.
        FilesobjectContains multiple copies of a particular return.
            Copy1objectCopy 1: For State Tax Department
                UnmaskedstringLink to download the Unmasked copy
                UnmaskedPathstringThe storage path of the unmasked TIN
                MaskedstringLink to download the Masked copy
                MaskedPathstringThe storage path of the masked TIN
            Copy2objectCopy 2: To be filed with recipient’s state income tax return, when required.
                UnmaskedstringLink to download the Unmasked copy
                UnmaskedPathstringThe storage path of the unmasked TIN
                MaskedstringLink to download the Masked copy
                MaskedPathstringThe storage path of the masked TIN
            CopyBobjectCopy B: For Recipient
                UnmaskedstringLink to download the Unmasked copy
                UnmaskedPathstringThe storage path of the unmasked TIN
                MaskedstringLink to download the Masked copy
                MaskedPathstringThe storage path of the masked TIN
            CopyCobjectCopy C: For Payer
                UnmaskedstringLink to download the Unmasked copy
                UnmaskedPathstringThe storage path of the unmasked TIN
                MaskedstringLink to download the Masked copy
                MaskedPathstringThe storage path of the masked TIN
            CopyDobjectCopy D: For Payer
                UnmaskedstringLink to download the Unmasked copy
                UnmaskedPathstringThe storage path of the unmasked TIN
                MaskedstringLink to download the Masked copy
                MaskedPathstringThe storage path of the masked TIN
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 5498 ESA Records.
        SequenceIdstringAn 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.
        RecordIdGuidUnique identifier of a record.
        Errorsobject[]Shows detailed error information.
            IdstringReturns the validation error id.
            NamestringName of the validation error.
            MessagestringDescription of the validation error.
Errorsobject[]Shows detailed error information.
    IdstringReturns the validation error id.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.

Response JSON

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

{
    "SubmissionId": "d90558f5-d7c5-4734-a467-96134fca4626",
    "Form5498ESARecords": {
      "SuccessRecords": [
            {
                "RecordId": "8daaa39f-7955-4bc1-a4c3-3bd54020851b",
                "Status": "Success",
                "Files": {
                    "Copy1": {
                        "Unmasked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/u/copy1_1up_36323837.pdf",
                        "UnmaskedPath": "pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/u/copy1_1up_36323837.pdf",
                        "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/m/copy1_1up_36323837.pdf",
                        "MaskedPath": "pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/m/copy1_1up_36323837.pdf"
                    },
                    "Copy2": {
                        "Unmasked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/u/copy2_1up_36323837.pdf",
                        "UnmaskedPath": "pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/u/copy2_1up_36323837.pdf",
                        "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/m/copy2_1up_36323837.pdf",
                        "MaskedPath": "pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/m/copy2_1up_36323837.pdf"
                    },
                    "CopyB": {
                        "Unmasked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/u/copyb_1up_36323837.pdf",
                        "UnmaskedPath": "pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/u/copyb_1up_36323837.pdf",
                        "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/m/copyb_1up_36323837.pdf",
                        "MaskedPath": "pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/m/copyb_1up_36323837.pdf"
                    },
                    "CopyC": {
                        "Unmasked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/u/copyc_1up_36323837.pdf",
                        "UnmaskedPath": "pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/u/copyc_1up_36323837.pdf",
                        "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/m/copyc_1up_36323837.pdf",
                        "MaskedPath": "pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/m/copyc_1up_36323837.pdf"
                    },
                    "CopyD": {
                        "Unmasked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/u/copyd_1up_36323837.pdf",
                        "UnmaskedPath": "pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/u/copyd_1up_36323837.pdf",
                        "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/m/copyd_1up_36323837.pdf",
                        "MaskedPath": "pdfs/f502ee15-25c8-41d0-83a6-f68794a8c9b4/099dc9ab-9f57-42f9-b4ee-968392577ff7/w2/36323837/m/copyd_1up_36323837.pdf"
                    }
                }
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}