RequestPDFURLs

RequestPDFURLs

POST Form1099DACorrection/RequestPdfUrls 

Run in Postman

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, then leave the SubmissionId blank or null.
RecordIds	object[]	Specify the list of RecordIds under this Array
RecordId	Guid	Unique identifier of the return.
Customization	object	Includes 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"

Response Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission.
Form1099DACorrectionRecords	object	Contains PDF URLs of the forms requested in the API request.
SuccessRecords	object[]	Shows the successful records for the given submission request.
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.
Copy1	object	Copy 1: For State Tax Department
Unmasked	string	Link to download the Unmasked copy
UnmaskedPath	string	The storage path of the unmasked TIN
Masked	string	Link to download the Masked copy
MaskedPath	string	The storage path of the masked TIN
Copy2	object	Copy 2: To be filed with recipient's state income tax return, when required.
Unmasked	string	Link to download the Unmasked copy
UnmaskedPath	string	The storage path of the unmasked TIN
Masked	string	Link to download the Masked copy
MaskedPath	string	The storage path of the masked TIN
CopyB	object	Copy B: For Recipient
Unmasked	string	Link to download the Unmasked copy
UnmaskedPath	string	The storage path of the unmasked TIN
Masked	string	Link to download the Masked copy
MaskedPath	string	The storage path of the masked TIN
CopyC	object	Copy C: For Payer
Unmasked	string	Link to download the Unmasked copy
UnmaskedPath	string	The storage path of the unmasked TIN
Masked	string	Link to download the Masked copy
MaskedPath	string	The storage path of the masked TIN
ErrorRecords	object[]	Contains the error records
RecordId	Guid	Unique identification of the record.
Status	string	Status of the error record. - PDF_Not_Generated - PDF is yet to be generated. You will have to waitand 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.

Request Params

{
 "SubmissionId": "4ac243d2-5686-45f7-acbe-048635803bd6",
 "RecordIds": [
   {
     "RecordId": "e55a6438-08a7-4a29-a2ea-feaf9743980f"
   }
 ],
 "Customization": {
   "TINMaskType": "Both"
 }
}

Response Json

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

{
    "SubmissionId": "4ac243d2-5686-45f7-acbe-048635803bd6",
    "Form1099DACorrectionRecords": {
        "SuccessRecords": [
            {
                "RecordId": "e55a6438-08a7-4a29-a2ea-feaf9743980f",
                "Status": "Success",
                "Files": {
                    "CopyB": {
                        "Unmasked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/19d76efb-937b-45ed-a6d4-94fd787b3752/d0c34efb-9efe-4af3-91b9-06ea6f28ca01/1099/6239226/u/copyb_1up_6239226.pdf",
                        "UnmaskedPath": "pdfs/19d76efb-937b-45ed-a6d4-94fd787b3752/d0c34efb-9efe-4af3-91b9-06ea6f28ca01/1099/6239226/u/copyb_1up_6239226.pdf",
                        "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/19d76efb-937b-45ed-a6d4-94fd787b3752/d0c34efb-9efe-4af3-91b9-06ea6f28ca01/1099/6239226/m/copyb_1up_6239226.pdf",
                        "MaskedPath": "pdfs/19d76efb-937b-45ed-a6d4-94fd787b3752/d0c34efb-9efe-4af3-91b9-06ea6f28ca01/1099/6239226/m/copyb_1up_6239226.pdf"
                    },
                    "CopyC": {
                        "Unmasked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/19d76efb-937b-45ed-a6d4-94fd787b3752/d0c34efb-9efe-4af3-91b9-06ea6f28ca01/1099/6239226/u/copyc_1up_6239226.pdf",
                        "UnmaskedPath": "pdfs/19d76efb-937b-45ed-a6d4-94fd787b3752/d0c34efb-9efe-4af3-91b9-06ea6f28ca01/1099/6239226/u/copyc_1up_6239226.pdf",
                        "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/19d76efb-937b-45ed-a6d4-94fd787b3752/d0c34efb-9efe-4af3-91b9-06ea6f28ca01/1099/6239226/m/copyc_1up_6239226.pdf",
                        "MaskedPath": "pdfs/19d76efb-937b-45ed-a6d4-94fd787b3752/d0c34efb-9efe-4af3-91b9-06ea6f28ca01/1099/6239226/m/copyc_1up_6239226.pdf"
                    }
                }
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}