Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

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 Form1099DIV/RequestPdfURLs

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, you can 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"

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
Form1099DivRecordsobjectContains 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
                MaskedstringLink to download the Masked copy
            Copy2objectCopy 2: To be filed with recipients state income tax return, when required.
                UnmaskedstringLink to download the Unmasked copy
                MaskedstringLink to download the Masked copy
            CopyBobjectCopy B: For Recipient
                UnmaskedstringLink to download the Unmasked copy
                MaskedstringLink to download the Masked copy
            CopyCobjectCopy C: For Payer
                UnmaskedstringLink to download the Unmasked copy
                MaskedstringLink to download the Masked copy
    ErrorRecordsobject[]Contains the error records
        RecordIdGuidUnique identifier of the return.
        StatusstringStatus 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
        MessagestringDescription of each statuses
Errorsobject[]Lists the errors in the API call
    IdstringReturns the error Id.
    NamestringName of the validation error
    MessagestringDescription of the validation error

Request JSON 1

{  "SubmissionId": "81b77217-fb5a-4315-b76e-bbb805676a38",  "RecordIds": [    {      "RecordId": "ea13cc94-d25f-4c2f-aef2-a97b3eb59cf1"    }  ],  "Customization": {    "TINMaskType": "Masked"  }}

Response JSON 1

{   "SubmissionId": "e32eb5b3-2e41-4716-8ab8-9fb8f637eeb4",   "Form1099DivRecords": {       "SuccessRecords": [           {               "RecordId": "ce6a8a23-efe2-4824-bb1c-4a085e81e9ba",               "Status": "Success",               "Files": {                   "Copy1": {                       "Unmasked": null,                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/40a69386-34d4-4f9b-a999-e8325c5e3d2b/1099/9719a567-74b8-4796-b08e-0e389dd05aa6/m/copy1_1up_2404486860.pdf"                   },                   "Copy2": {                       "Unmasked": null,                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/40a69386-34d4-4f9b-a999-e8325c5e3d2b/1099/9719a567-74b8-4796-b08e-0e389dd05aa6/m/copy2_1up_9709990552.pdf"                   },                   "CopyB": {                       "Unmasked": null,                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/40a69386-34d4-4f9b-a999-e8325c5e3d2b/1099/9719a567-74b8-4796-b08e-0e389dd05aa6/m/copyb_1up_552335217.pdf"                   },                   "CopyC": {                       "Unmasked": null,                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/40a69386-34d4-4f9b-a999-e8325c5e3d2b/1099/9719a567-74b8-4796-b08e-0e389dd05aa6/m/copyc_1up_9957067731.pdf"                   }               }           }       ],       "ErrorRecords": null   },   "Errors": null}

Request JSON 2

{ "SubmissionId": "a863c015-91f1-4128-84fc-bb38922b80f9", "RecordIds": [   {     "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267"   },   {     "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e"   } ], "Customization": {   "TINMaskType": "Masked" }}

Response JSON 2

{   "SubmissionId": null,   "Form1099DivRecords": {       "SuccessRecords": null,       "ErrorRecords": [           {               "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267",               "Status": "PDF_Not_Generated",               "Message": "Your PDF request is prioritized in the queue.Please try again after sometime"           },           {               "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e",               "Status": "Not Transmitted",               "Message": "Given RecordId is not transmitted"           }       ]   },   "Errors": null}

Request JSON 3

{   "RecordIds": [   {     "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267"   },   {     "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e"   } ]
}

Response JSON 3

{   "SubmissionId": null,   "Form1099DivRecords": {       "SuccessRecords": null,       "ErrorRecords": [           {               "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267",               "Status": "PDF_Not_Generated",               "Message": "Your PDF request is prioritized in the queue.Please try again after sometime"           },           {               "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e",               "Status": "Not Transmitted",               "Message": "Given RecordId is not transmitted"           }       ]   },   "Errors": null}