RequestPDFURLs

RequestPDFURLs

Use this endpoint to retrieve the PDF copies of withholding forms (draft or finalized) created for the business.

You can request the PDF URLs by providing either the SubmissionId or the RecordIds associated with the returns.

POST StateFilings/RequestPdfUrls 

Request Body

Field	Type	Description
BusinessId	Guid	Unique Identifier of a business
PayerRef	string	An unique identifier for the payer
TIN	string	TIN (EIN) of the payer
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid	An unique identifier generated by TaxBandits when a withholding or UI return is created. Mention the return's Record ID that you want to Get.

Response Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a Business.
PayerRef	string	Unique identifier of the payer.
StateFilingRecords	Object	Pulls withholding or UI records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of withholding or UI Records
RecordId	Guid	Unique identifier of a record
State	string	Returns the State code of the withholding or UI retruns
FormType	string	Returns the Form type
Status	string	Returns the record status.
PDFUrl	string	Link to download the PDF
ErrorRecords	object []	Contains the error records
RecordId	Guid	Unique identifier of a record
State	string	Returns the State code of the withholding or UI returns
FormType	string	Returns the Form type
Status	string	Returns the record status.
Errors	object[]	Shows error information of withholding or UI returns
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error

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.

Request JSON

{
    "BusinessId": "3757324a-3794-4fcb-b389-7a9aaf826333",
    "PayerRef": null,
    "TIN": null,
    "SubmissionId": "01993c39-4dc5-70d1-a428-a3facb476ee1",
    "RecordIds": [
        {
            "RecordId": "ea13cc94-d25f-4c2f-aef2-a97b3eb59cf1"
        }
    ]
}

Response JSON

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

{
    "StatusCode": "200",
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "01993c39-4dc5-70d1-a428-a3facb476ee1",
    "BusinessId": "3757324a-3794-4fcb-b389-7a9aaf826333",
    "PayerRef": null,
    "StateFilingRecords": {
        "SuccessRecords": [
            {
                "RecordId": "01993c39-4e52-71b1-b833-84450f6f55dd",
                "State": "SC",
                "FormType": "SC1605",
                "Status": "SUCCESS",
                "PDFUrl": "pdfs/82d4753e-8698-4842-ae3f-59d80569e935/3757324a-3794-4fcb-b389-7a9aaf826333/SC/Final/2025/WH1605_13067.pdf"
            }
        ],
        "ErrorRecords": []
    },
    "Errors": null
}