openapi: 3.2.0
info:
  title: check-api Documents API
  version: '2025-01-01'
servers:
- url: https://sandbox.checkhq.com
security:
- sec0: []
tags:
- name: Documents
paths:
  /documents/company_authorization_documents:
    get:
      summary: List company authorization documents
      description: Returns a list of company authorization documents. Each document includes `created_at`, an ISO 8601 UTC timestamp of when the document was recorded. When multiple documents share the same `filed_on` date, compare `created_at` to tell which was recorded later.
      operationId: list-company-authorization-documents
      parameters:
      - name: company
        in: query
        description: Return authorization documents for this company ID
        schema:
          type: string
      - name: year
        in: query
        description: Return documents for this year (must be greater than or equal to `2019`)
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: Number of authorization documents returned per page. The maximum value is 25.
        schema:
          type: integer
          format: int32
      - name: id
        in: query
        description: Filter the list to the specified IDs. For more details, check out the [Bulk Get Requests guide](https://docs.checkhq.com/docs/bulk-resource-get-requests).
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Documents
  /documents/company_tax_documents:
    get:
      summary: List company tax documents
      description: Returns a list of company tax documents. Each document includes `created_at`, an ISO 8601 UTC timestamp of when the document was recorded. When multiple documents share the same `filed_on` date, compare `created_at` to tell which was recorded later.
      operationId: list-company-tax-documents
      parameters:
      - name: company
        in: query
        description: Return tax documents for this company ID
        schema:
          type: string
      - name: year
        in: query
        description: Return tax documents for this year (must be greater than or equal to `2019`)
        schema:
          type: integer
          format: int32
      - name: quarter
        in: query
        description: Return tax documents for this quarter (accepted values are `q1`, `q2`, `q3`, or `q4`)
        schema:
          type: string
      - name: limit
        in: query
        description: Number of tax documents returned per page. The maximum value is 500.
        schema:
          type: integer
          format: int32
          default: 25
      - name: id
        in: query
        description: Filter the list to the specified IDs. For more details, check out the [Bulk Get Requests guide](https://docs.checkhq.com/docs/bulk-resource-get-requests).
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"next\": \"https://api.checkhq.com/documents/company_tax_documents?cursor=cD0lNUIlMjIyMDI0LTA3LTI2KzE2JTNBMTAlM0EwMy44OTY5ODclMkIwMCUzQTAwJTIyJTJDKyUyMjQwNTk4MSUyMiU1RA%3D%3D\",\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"doc_XL5gEd90wjwh2b3U6ICU\",\n            \"company\": \"com_EkKTRETE3zl8CffWF2iW\",\n            \"category\": \"company_tax_document\",\n            \"label\": \"Form UCT-101\",\n            \"description\": \"Form UCT-101 is the quarterly Unemployment contribution return for Wisconsin.\",\n            \"jurisdiction\": \"WI\",\n            \"year\": 2024,\n            \"quarter\": \"q2\",\n            \"filed_on\": \"2024-07-26\",\n            \"created_at\": \"2024-07-26T16:10:03.896987Z\"\n        }\n    ]\n}"
              schema:
                type: object
                properties:
                  next:
                    type: string
                    example: https://api.checkhq.com/documents/company_tax_documents?cursor=cD0lNUIlMjIyMDI0LTA3LTI2KzE2JTNBMTAlM0EwMy44OTY5ODclMkIwMCUzQTAwJTIyJTJDKyUyMjQwNTk4MSUyMiU1RA%3D%3D
                  previous: {}
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: doc_XL5gEd90wjwh2b3U6ICU
                        company:
                          type: string
                          example: com_EkKTRETE3zl8CffWF2iW
                        category:
                          type: string
                          example: company_tax_document
                        label:
                          type: string
                          example: Form UCT-101
                        description:
                          type: string
                          example: Form UCT-101 is the quarterly Unemployment contribution return for Wisconsin.
                        jurisdiction:
                          type: string
                          example: WI
                        year:
                          type: integer
                          example: 2024
                          default: 0
                        quarter:
                          type: string
                          example: q2
                        filed_on:
                          type: string
                          example: '2024-07-26'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Documents
  /documents/contractor_tax_documents:
    get:
      summary: List contractor tax documents
      description: Returns contractor tax documents. Each document includes `created_at`, an ISO 8601 UTC timestamp of when the document was recorded. When multiple documents share the same `filed_on` date, compare `created_at` to tell which was recorded later.
      operationId: list-contractor-tax-documents
      parameters:
      - name: contractor
        in: query
        description: Return documents for this contractor ID.
        schema:
          type: string
      - name: company
        in: query
        description: Return documents for this company ID. Results will include tax documents for all contractors who perform work for this company.
        schema:
          type: string
      - name: year
        in: query
        description: Return documents for this year (must be greater than or equal to `2019`)
        schema:
          type: integer
          format: int32
      - name: document_type
        in: query
        description: Return documents with this document type. Repeat the parameter to match any of multiple values (for example, `?document_type=fed_1099_nec&document_type=fed_w9`). Filtering on `fed_1099_nec` also matches legacy rows stored as `1099_nec`.
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: Number of tax documents returned per page. The maximum value is 25.
        schema:
          type: integer
          format: int32
      - name: id
        in: query
        description: Filter the list to the specified IDs. For more details, check out the [Bulk Get Requests guide](https://docs.checkhq.com/docs/bulk-resource-get-requests).
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Documents
  /documents/employee_tax_documents:
    get:
      summary: List employee tax documents
      description: Returns a list of employee tax documents. Each document includes `created_at`, an ISO 8601 UTC timestamp of when the document was recorded. When multiple documents share the same `filed_on` date, compare `created_at` to tell which was recorded later.
      operationId: list-employee-tax-documents
      parameters:
      - name: employee
        in: query
        description: Return tax documents for this employee ID
        schema:
          type: string
      - name: company
        in: query
        description: Return tax documents for this company ID
        schema:
          type: string
      - name: year
        in: query
        description: List documents for this year (must be greater than or equal to `2019`)
        schema:
          type: integer
          format: int32
      - name: document_type
        in: query
        description: Return documents with this document type. Repeat the parameter to match any of multiple values (for example, `?document_type=fed_w4&document_type=fed_w2`).
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: Number of tax documents returned per page. The maximum value is 500.
        schema:
          type: integer
          format: int32
          default: 25
      - name: id
        in: query
        description: Filter the list to the specified IDs. For more details, check out the [Bulk Get Requests guide](https://docs.checkhq.com/docs/bulk-resource-get-requests).
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"next\": \"https://api.checkhq.com/documents/employee_tax_documents?cursor=cD0lNUIlMjIyMDI0LTA1LTA5KzIzJTNBNTIlM0ExOC42NzY3NzUlMkIwMCUzQTAwJTIyJTJDKyUyMjQwMzA5OCUyMiU1RA%3D%3D\",\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"doc_hQhfyxTf2aMXDfQ82Dly\",\n            \"employee\": \"emp_blSYc67D0Q4qk6lx15qR\",\n            \"category\": \"employee_tax_document\",\n            \"document_type\": \"ca_de4\",\n            \"label\": \"California DE-4\",\n            \"jurisdiction\": \"CA\",\n            \"year\": 2024,\n            \"filed_on\": \"2024-07-18\",\n            \"created_at\": \"2024-07-18T23:52:18.676775Z\"\n        },\n        ...\n    ]\n}"
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Documents
  /documents/setup_documents:
    get:
      summary: List setup documents
      description: List all setup documents. Each document includes `created_at`, an ISO 8601 UTC timestamp of when Check generated this document.
      operationId: list-setup-documents
      parameters:
      - name: company
        in: query
        description: Company ID
        schema:
          type: string
      - name: id
        in: query
        description: Filter the list to the specified IDs. For more details, check out the [Bulk Get Requests guide](https://docs.checkhq.com/docs/bulk-resource-get-requests).
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Documents
  /documents/setup_documents/{document}:
    get:
      summary: Get a Setup Document
      description: Returns a setup document, including `created_at` (ISO 8601 UTC timestamp of when Check generated this document).
      operationId: get-a-setup-document
      parameters:
      - name: document
        in: path
        description: Document ID
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Documents
  /documents/setup_documents/{document}/download:
    get:
      summary: Download a setup document
      description: Downloads the binary document
      operationId: download-a-setup-document
      parameters:
      - name: document
        in: path
        description: Document ID
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Documents
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