openapi: 3.2.0
info:
  title: check-api Tax Packages API
  version: '2025-01-01'
servers:
- url: https://sandbox.checkhq.com
security:
- sec0: []
tags:
- name: Tax Packages
paths:
  /tax_packages:
    post:
      summary: Request a tax package
      description: ''
      operationId: request-a-tax-package
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company:
                  type: string
                  description: ID of the company
                contents:
                  type: string
                  description: JSON object of `employee_tax_statements` and `filings` IDs to generate
                  format: json
      responses:
        '201':
          description: '201'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"id\": \"tax_pkg_abc123\",\n  \"company\": \"com_789\",\n  \"status\": \"generating\",\n  \"contents\": {\n    \"employee_tax_statements\": [\"ets_123\", \"ets_456\"],\n    \"filings\": [\"com_fil_999\"]\n  },\n  \"result\": null,\n  \"succeeded_at\": null,\n  \"error\": null,\n  \"created_at\": \"2024-01-15T12:00:00Z\"\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: tax_pkg_abc123
                  company:
                    type: string
                    example: com_789
                  status:
                    type: string
                    example: generating
                  contents:
                    type: object
                    properties:
                      employee_tax_statements:
                        type: array
                        items:
                          type: string
                          example: ets_123
                      filings:
                        type: array
                        items:
                          type: string
                          example: com_fil_999
                  result: {}
                  succeeded_at: {}
                  error: {}
                  created_at:
                    type: string
                    example: '2024-01-15T12:00:00Z'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Tax Packages
  /tax_packages/{id}:
    get:
      summary: Get a tax package
      description: ''
      operationId: get-a-tax-package
      parameters:
      - name: id
        in: path
        description: ID of the tax package to get
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"id\": \"tax_pkg_abc123\",\n  \"company\": \"com_789\",\n  \"status\": \"succeeded\", \n  \"contents\": {\n    \"employee_tax_statements\": [\"ets_123\", \"ets_456\"],\n    \"filings\": [\"com_fil_999\"]\n  },\n  \"result\": {\n    \"url\": \"https://api.check.com/tax_packages/tax_pkg_abc123/download/\"\n  },\n  \"succeeded_at\": \"2024-01-15T12:05:00Z\",\n  \"error\": null,\n  \"created_at\": \"2024-01-15T12:00:00Z\"\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: tax_pkg_abc123
                  company:
                    type: string
                    example: com_789
                  status:
                    type: string
                    example: succeeded
                  contents:
                    type: object
                    properties:
                      employee_tax_statements:
                        type: array
                        items:
                          type: string
                          example: ets_123
                      filings:
                        type: array
                        items:
                          type: string
                          example: com_fil_999
                  result:
                    type: object
                    properties:
                      url:
                        type: string
                        example: https://api.check.com/tax_packages/tax_pkg_abc123/download/
                  succeeded_at:
                    type: string
                    example: '2024-01-15T12:05:00Z'
                  error: {}
                  created_at:
                    type: string
                    example: '2024-01-15T12:00:00Z'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Tax Packages
  /tax_packages/{id}/download:
    get:
      summary: Download a tax package
      description: '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 employee tax statement directly as a PDF. PDF downloads are available only when the tax package contains exactly one employee tax statement and no filings.'
      operationId: download-a-tax-package
      parameters:
      - name: id
        in: path
        description: ID of the tax package to download
        schema:
          type: string
        required: true
      - name: Accept
        in: header
        description: Either `application/json` or `application/pdf`
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"download_url\": \"https://check-taxpackages.s3.amazonaws.com/tax_pkg_abc123.zip?...\",\n  \"extension\": \"zip\",\n  \"content_type\": \"application/zip\"\n}"
              schema:
                type: object
                properties:
                  download_url:
                    type: string
                    example: https://check-taxpackages.s3.amazonaws.com/tax_pkg_abc123.zip?...
                  extension:
                    type: string
                    example: zip
                  content_type:
                    type: string
                    example: application/zip
            application/pdf:
              schema:
                type: string
                format: binary
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Tax Packages
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer
      x-default: YOUR_API_KEY
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.checkhq.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.checkhq.com/reference/add-filing-blockers.md
  - https://docs.checkhq.com/reference/approve-a-correction.md
  - https://docs.checkhq.com/reference/approve-an-external-payroll.md
  - https://docs.checkhq.com/reference/approve-payroll.md
  - https://docs.checkhq.com/reference/bulk-get-employee-tax-parameter-settings.md
  - https://docs.checkhq.com/reference/bulk-get-employee-tax-params.md
  - https://docs.checkhq.com/reference/bulk-update-employee-tax-parameters.md
  - https://docs.checkhq.com/reference/cancel-a-payment.md
  - https://docs.checkhq.com/reference/company-business-details.md
  - https://docs.checkhq.com/reference/company-checklist-component.md
  - https://docs.checkhq.com/reference/company-connect-bank-account.md
  - https://docs.checkhq.com/reference/company-employee-setup.md
  - https://docs.checkhq.com/reference/company-filing-authorization.md
  - https://docs.checkhq.com/reference/company-pay-history.md
  - https://docs.checkhq.com/reference/company-payment-setup.md
  - https://docs.checkhq.com/reference/company-progress-tracker.md
  - https://docs.checkhq.com/reference/company-signatory-agreements.md
  - https://docs.checkhq.com/reference/company-tax-setup.md
  - https://docs.checkhq.com/reference/company-team-setup.md
  - https://docs.checkhq.com/reference/company-terms-of-service.md
  - https://docs.checkhq.com/reference/company-verification-documents.md
  - https://docs.checkhq.com/reference/contractor-roster.md
  - https://docs.checkhq.com/reference/create-a-bank-account.md
  - https://docs.checkhq.com/reference/create-a-company-provided-document.md
  - https://docs.checkhq.com/reference/create-a-contractor-payment.md
  - https://docs.checkhq.com/reference/create-a-correction.md
  - https://docs.checkhq.com/reference/create-a-pay-schedule.md
  - https://docs.checkhq.com/reference/create-a-payroll-item.md
  - https://docs.checkhq.com/reference/create-a-post-tax-deduction.md
  - https://docs.checkhq.com/reference/create-a-report-run.md
  - https://docs.checkhq.com/reference/create-a-workplace.md
  - https://docs.checkhq.com/reference/create-an-earning-code.md
  - https://docs.checkhq.com/reference/create-an-earning-rate.md
  - https://docs.checkhq.com/reference/create-an-external-payroll.md
  - https://docs.checkhq.com/reference/create-company-tax-elections.md
  - https://docs.checkhq.com/reference/create-net-pay-split.md
  - https://docs.checkhq.com/reference/create-payroll.md
  - https://docs.checkhq.com/reference/create-the-enrollment-profile.md
  - https://docs.checkhq.com/reference/credit-limits.md
  - https://docs.checkhq.com/reference/delete-a-bank-account.md
  - https://docs.checkhq.com/reference/delete-a-company-benefit.md
  - https://docs.checkhq.com/reference/delete-a-contractor-payment.md
  - https://docs.checkhq.com/reference/delete-a-correction.md
  - https://docs.checkhq.com/reference/delete-a-pay-schedule.md
  - https://docs.checkhq.com/reference/delete-a-payroll-copy-1.md
  - https://docs.checkhq.com/reference/delete-a-payroll-item-1.md
  - https://docs.checkhq.com/reference/delete-a-payroll-item.md
  - https://docs.checkhq.com/reference/delete-a-payroll.md
  - https://docs.checkhq.com/reference/delete-a-post-tax-deduction.md
  - https://docs.checkhq.com/reference/delete-a-webhook-config.md
  - https://docs.checkhq.com/reference/delete-an-employee-benefit.md
  - https://docs.checkhq.com/reference/download-a-report-run.md
  - https://docs.checkhq.com/reference/download-a-setup-document.md
  - https://docs.checkhq.com/reference/download-a-tax-package.md
  - https://docs.checkhq.com/reference/employee-roster.md
  - https://docs.checkhq.com/reference/employee-tax-setup.md
  - https://docs.checkhq.com/reference/employee-tax-statements-1.md
  - https://docs.checkhq.com/reference/employee-withholdings-setup.md
  - https://docs.checkhq.com/reference/filing-preview-component.md
  - https://docs.checkhq.com/reference/full-service-setup-submission.md
  - https://docs.checkhq.com/reference/generate-contractor-onboard-link.md
  - https://docs.checkhq.com/reference/generate-onboard-link.md
  - https://docs.checkhq.com/reference/get-a-communication.md
  - https://docs.checkhq.com/reference/get-a-company-filing.md
  - https://docs.checkhq.com/reference/get-a-contractor-pay-statement.md
  - https://docs.checkhq.com/reference/get-a-contractor-payment.md
  - https://docs.checkhq.com/reference/get-a-correction-receipt-download.md
  - https://docs.checkhq.com/reference/get-a-correction-receipt.md
  - https://docs.checkhq.com/reference/get-a-correction.md
  - https://docs.checkhq.com/reference/get-a-form.md
  - https://docs.checkhq.com/reference/get-a-fulfillment-receipt-2.md
  - https://docs.checkhq.com/reference/get-a-fulfillment.md
  - https://docs.checkhq.com/reference/get-a-log.md
  - https://docs.checkhq.com/reference/get-a-notification.md
  - https://docs.checkhq.com/reference/get-a-paper-check-2.md
  - https://docs.checkhq.com/reference/get-a-paper-check.md
  - https://docs.checkhq.com/reference/get-a-pay-schedule.md
  - https://docs.checkhq.com/reference/get-a-report-run.md
  - https://docs.checkhq.com/reference/get-a-setup-document.md
  - https://docs.checkhq.com/reference/get-a-setup.md
  - https://docs.checkhq.com/reference/get-a-tax-package.md
  - https://docs.checkhq.com/reference/get-a-tax.md
  - https://docs.checkhq.com/reference/get-a-webhook-delivery.md
  - https://docs.checkhq.com/reference/get-an-agency.md
  - https://docs.checkhq.com/reference/get-an-earning-code.md
  - https://docs.checkhq.com/reference/get-an-earning-rate.md
  - https://docs.checkhq.com/reference/get-an-employees-paystubs.md
  - https://docs.checkhq.com/reference/get-an-external-payroll.md
  - https://docs.checkhq.com/reference/get-an-integration-partner-copy.md
  - https://docs.checkhq.com/reference/get-child-support-payments-report.md
  - https://docs.checkhq.com/reference/get-company-paydays.md
  - https://docs.checkhq.com/reference/get-paper-checks-report.md
  - https://docs.checkhq.com/reference/get-paper-checks.md
  - https://docs.checkhq.com/reference/get-paydays.md
  - https://docs.checkhq.com/reference/get-payroll-journal.md
  - https://docs.checkhq.com/reference/get-payroll.md
  - https://docs.checkhq.com/reference/integration-partners-copy.md
  - https://docs.checkhq.com/reference/integration-partners.md
  - https://docs.checkhq.com/reference/list-a-webhook-config.md
  - https://docs.checkhq.com/reference/list-active-funding-strikes.md
  - https://docs.checkhq.com/reference/list-agencies.md
  - https://docs.checkhq.com/reference/list-bank-accounts.md
  - https://docs.checkhq.com/reference/list-benefits.md
  - https://docs.checkhq.com/reference/list-communications.md
  - https://docs.checkhq.com/reference/list-companies.md
  - https://docs.checkhq.com/reference/list-company-authorization-documents.md
  - https://docs.checkhq.com/reference/list-company-benefits.md
  - https://docs.checkhq.com/reference/list-company-filings.md
  - https://docs.checkhq.com/reference/list-company-tax-documents.md
  - https://docs.checkhq.com/reference/list-company-tax-elections.md
  - https://docs.checkhq.com/reference/list-company-tax-parameter-settings.md
  - https://docs.checkhq.com/reference/list-company-tax-parameters.md
  - https://docs.checkhq.com/reference/list-contractor-forms.md
  - https://docs.checkhq.com/reference/list-contractor-payments.md
  - https://docs.checkhq.com/reference/list-contractor-tax-documents.md
  - https://docs.checkhq.com/reference/list-contractors.md
  - https://docs.checkhq.com/reference/list-corrections.md
  - https://docs.checkhq.com/reference/list-earning-codes.md
  - https://docs.checkhq.com/reference/list-earning-rates.md
  - https://docs.checkhq.com/reference/list-employee-tax-documents.md
  - https://docs.checkhq.com/reference/list-employee-tax-elections.md
  - https://docs.checkhq.com/reference/list-employee-tax-parameter-settings.md
  - https://docs.checkhq.com/reference/list-employee-tax-statements.md
  - https://docs.checkhq.com/reference/list-employees-tax-parameters.md
  - https://docs.checkhq.com/reference/list-employees.md
  - https://docs.checkhq.com/reference/list-external-payrolls.md
  - https://docs.checkhq.com/reference/list-forms.md
  - https://docs.checkhq.com/reference/list-fulfillments.md
  - https://docs.checkhq.com/reference/list-integration-accesses-1.md
  - https://docs.checkhq.com/reference/list-integration-permissions-copy.md
  - https://docs.checkhq.com/reference/list-integration-permissions.md
  - https://docs.checkhq.com/reference/list-logs.md
  - https://docs.checkhq.com/reference/list-net-pay-splits.md
  - https://docs.checkhq.com/reference/list-notifications.md
  - https://docs.checkhq.com/reference/list-pay-schedules.md
  - https://docs.checkhq.com/reference/list-payments.md
  - https://docs.checkhq.com/reference/list-payroll-items.md
  - https://docs.checkhq.com/reference/list-payrolls.md
  - https://docs.checkhq.com/reference/list-post-tax-deductions.md
  - https://docs.checkhq.com/reference/list-report-runs.md
  - https://docs.checkhq.com/reference/list-setup-documents.md
  - https://docs.checkhq.com/reference/list-setups.md
  - https://docs.checkhq.com/reference/list-tax-deposits.md
  - https://docs.checkhq.com/reference/list-taxes.md
  - https://docs.checkhq.com/reference/list-usage-records.md
  - https://docs.checkhq.com/reference/list-usage-summaries.md
  - https://docs.checkhq.com/reference/list-webhook-deliveries.md
  - https://docs.checkhq.com/reference/list-workplaces.md
  - https://docs.checkhq.com/reference/preview-a-correction.md
  - https://docs.checkhq.com/reference/preview-an-external-payroll.md
  - https://docs.checkhq.com/reference/preview-payroll.md
  - https://docs.checkhq.com/reference/previous-payroll-provider-access.md
  - https://docs.checkhq.com/reference/refund-a-payment.md
  - https://docs.checkhq.com/reference/remove-filing-blockers.md
  - https://docs.checkhq.com/reference/reopen-a-correction.md
  - https://docs.checkhq.com/reference/reopen-a-pending-payroll.md
  - https://docs.checkhq.com/reference/reopen-payroll.md
  - https://docs.checkhq.com/reference/request-a-tax-package.md
  - https://docs.checkhq.com/reference/request-embedded-setup.md
  - https://docs.checkhq.com/reference/retry-a-payment.md
  - https://docs.checkhq.com/reference/retry-a-webhook-delivery-in-sandbox.md
  - https://docs.checkhq.com/reference/reveal-account-number.md
  - https://docs.checkhq.com/reference/reveal-contractor-ssn.md
  - https://docs.checkhq.com/reference/reveal-employee-ssn.md
  - https://docs.checkhq.com/reference/run-payroll.md
  - https://docs.checkhq.com/reference/sandbox-complete-disbursements.md
  - https://docs.checkhq.com/reference/sandbox-complete-funding.md
  - https://docs.checkhq.com/reference/sandbox-correction-complete-funding.md
  - https://docs.checkhq.com/reference/sandbox-correction-fail-funding.md
  - https://docs.checkhq.com/reference/sandbox-correction-start-processing.md
  - https://docs.checkhq.com/reference/sandbox-fail-funding.md
  - https://docs.checkhq.com/reference/sandbox-start-processing.md
  - https://docs.checkhq.com/reference/submit-a-contractor-form.md
  - https://docs.checkhq.com/reference/update-a-bank-account.md
  - https://docs.checkhq.com/reference/update-a-company.md
  - https://docs.checkhq.com/reference/update-a-correction.md
  - https://docs.checkhq.com/reference/update-a-webhook-config.md
  - https://docs.checkhq.com/reference/update-a-workplace.md
  - https://docs.checkhq.com/reference/update-an-earning-rate.md
  - https://docs.checkhq.com/reference/update-an-external-payroll.md
  - https://docs.checkhq.com/reference/update-company-tax-elections.md
  - https://docs.checkhq.com/reference/update-employee-tax-elections.md
  - https://docs.checkhq.com/reference/update-payroll.md
  - https://docs.checkhq.com/reference/update-the-enrollment-profile.md
  - https://docs.checkhq.com/reference/validate-address.md
  - https://docs.checkhq.com/reference/validate-an-external-payroll.md
  - https://docs.checkhq.com/reference/void-a-payroll.md
  - https://docs.checkhq.com/reference/workplace-roster.md
  merge:
    pages: 188
    deduped: 195
    conflicts_kept_first: 0