CHcheckhq

Download a tax package

Changed on

Returns download metadata for a succeeded tax package. By default, the response is JSON containing a short-lived download URL for the generated ZIP archive.

Use an Accept: application/pdf request header to download a single tax statement directly as a PDF. PDF downloads are available only when the tax package contains exactly one employee or contractor tax statement and no filings. A package can include contractor tax statements only when they are enabled for your account.

get/tax_packages/{id}/download

Request

Path parameters

idstring required

ID of the tax package to download

Headers

Acceptstring

Either application/json or application/pdf

Response

200

download_urlstring
extensionstring
content_typestring

Example response

{
  "download_url": "https://check-taxpackages.s3.amazonaws.com/tax_pkg_abc123.zip?...",
  "extension": "zip",
  "content_type": "application/zip"
}

Changes