Check Components

Check Components is a library of white-labeled, drop-in React UI elements that handle the highest-friction surfaces of embedded payroll — company onboarding, terms of service, bank linking, employee tax setup, withholdings (W-4), filing authorization, verification documents, and Run Payroll — including the Check Onboard flow. Components are embedded via short-lived component links generated through the API and emit DOM events for lifecycle states.

Check Components is one of 4 APIs that Check publishes on the APIs.io network.

Tagged areas include React, Embedded UI, Onboarding, Components, and Run Payroll. The published artifact set on APIs.io includes API documentation, a quickstart, an API reference, and sample payloads.

API entry from apis.yml

apis.yml Raw ↑
aid: check-hq:components
name: Check Components
description: Check Components is a library of white-labeled, drop-in React UI elements that handle the
  highest-friction surfaces of embedded payroll — company onboarding, terms of service, bank linking,
  employee tax setup, withholdings (W-4), filing authorization, verification documents, and Run Payroll
  — including the Check Onboard flow. Components are embedded via short-lived component links generated
  through the API and emit DOM events for lifecycle states.
humanURL: https://docs.checkhq.com/docs/check-components
tags:
- React
- Embedded UI
- Onboarding
- Components
- Run Payroll
properties:
- type: Documentation
  url: https://docs.checkhq.com/docs/check-components
- type: ComponentLibrary
  url: https://docs.checkhq.com/docs/check-component-library
- type: Quickstart
  url: https://docs.checkhq.com/docs/adding-check-onboard-to-your-application
- type: APIReference
  url: https://docs.checkhq.com/reference/components-overview
- type: Example
  url: https://docs.checkhq.com/docs/live-component-example
features:
- name: Company Onboard
  description: End-to-end employer onboarding including business details, signatory, and TOS.
- name: Run Payroll Component
  description: White-labeled payroll runner with worker pay, earnings, and preview in one component.
- name: Employee Withholdings Setup
  description: W-4 and state-equivalent withholding form completion for employees.
- name: Employee Tax Setup
  description: Employer-side tax profile capture for individual employees.
- name: Company Tax Setup
  description: Federal and state tax registration capture for the employer.
- name: Company Payment Setup
  description: Plaid bank linking and debit authorization for funding payroll.
- name: Company Filing Authorization
  description: Review, sign, and submit jurisdiction-specific tax authorization forms.
- name: Filing Preview Component
  description: Preview tax returns and filings before submission.
- name: Company Verification Documents
  description: Collect verification documents requested by Check operators.
- name: Full Service Setup Submission
  description: Submit a company to Check operators for full-service embedded setup.
- name: Previous Payroll Provider Access
  description: Capture prior-provider credentials for payroll migration.
- name: Component Events
  description: Components emit lifecycle events such as completion and already-complete states.