RequestPDFURLs

RequestPDFURLs

Use this endpoint to retrieve the PDF copies of new hire reports created for the business. The PDF URLs will be returned in the response only if they have already been generated by TaxBandits. You can request the PDF URLs by providing either the SubmissionId or the RecordIds associated with the returns.

Note:

You can use this endpoint to retrieve both the draft reports (before filing) and finalized reports (after filing).

POST NewHire/Employee/RequestPdfUrls 

Run in Postman

Request Body

Field	Type	Description
BusinessId	string	Unique Identifier of the business.
PayerRef	string	Unique identifier of the payer. Set by the client in the endpoint Business/RequestByUrl.
TIN	string	Tax Identification Number of business.
SubmissionId	Guid	Mention the NewHire returns Submission ID that you want to Get the records.
RecordIds	Guid[]	Mention the NewHire returns Record ID that you want to Get the records. Multiple RecordIds under the same Submission can be received by sending the RecordIds comma separated.

Response Body

Field	Type	Description
BusinessId	Guid	Unique Identifier of the business
PayerRef	string	Unique identifier of the payer.
NewHireRecords	object	Returns detailed information of the NewHire form records.
SuccessRecords	object[]	It will show the detailed information about the success status of New Hire Form Records.
SubmissionId	Guid	Unique identifier of a submission.
RecordId	Guid	Unique identifier of a record
EmployeeId	Guid	Unique Identifier of the business
EmpRef	string	Unique identifier of the payer.
ReportingState	string	Reporting state.
Status	string	Returns the status of the records.
PdfUrl	string	URL of the PDF

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
}