Check API

Guides
Reference
Changelog
Eng Blog

The Check API Developer Hub

Welcome to the Check API developer hub. You'll find comprehensive guides and documentation to help you start working with Check API as quickly as possible, as well as support if you get stuck. Let's jump right in!

v2021-01-15
v2021-02-16stable

HomeGuidesRecipesReferenceReferenceEng BlogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

Guides

Getting Started
Quickstart
Check Onboard
Workplaces
Life of a payroll
Earnings
Off-cycle Payroll
Paystubs
Custom Employee Onboarding
Onboarding Forms API
Linking bank accounts with Plaid

Guides

Getting Started
Quickstart
Check Onboard
Workplaces
Life of a payroll
Earnings
Off-cycle Payroll
Paystubs
Custom Employee Onboarding
Onboarding Forms API
Linking bank accounts with Plaid

Check API

Introduction

Topics

Authentication
Errors
- Error codes
Idempotent Requests
Versioning
Webhooks

Bank Accounts

The bank account object
post
Create a bank account
patch
Update a bank account
get
Get a bank account
get
List bank accounts

Companies

The company object
post
Create a company
get
Get a company
patch
Update a company
get
List companies
post
Generate Onboard link
get
Get payroll journal
get
Get payroll summary
get
Get company paydays

Contractors

The contractor object
post
Create a contractor
get
Get a contractor
patch
Update a contractor
get
List contractors

Contractor Payments

The contractor payment object
get
Get a contractor payment
patch
Update a contractor payment

Documents

The document object
get
List company tax documents
get
Download a company tax document
get
List company authorization documents
get
Download a company authorization document
get
List employee tax documents
get
Download an employee tax document
get
List contractor tax documents
get
Download a contractor tax document

Employees

The employee object
post
Create an employee
get
Get an employee
patch
Update an employee
get
List employees
get
List employee paystubs
get
List employee forms
get
Get an employee form
post
Submit an employee form
post
Generate Onboard link

Benefits

The benefit object
Types of benefits
post
Create a benefit
get
Get a benefit
patch
Update a benefit
delete
Delete a benefit

Payrolls

The payroll object
- The totals object
- The off-cycle options object
post
Create a payroll
get
Preview a payroll
post
Reopen a pending payroll
post
Approve a payroll
get
Get a payroll
patch
Update a payroll
get
List payrolls
delete
Delete a payroll

Payroll Items

The payroll item object
Types of earnings
get
Get a payroll item
patch
Update a payroll item
Warnings

Post-Tax Deductions

The post-tax deduction object
post
Create a post-tax deduction
get
Get a post-tax deduction
patch
Update a post-tax deduction
get
List post-tax deductions
delete
Delete a post-tax deduction

Workplaces

The workplace object
post
Create a workplace
get
Get a workplace
patch
Update a workplace
get
List workplaces

Webhook Configs

The webhook config object
post
Create a webhook config
get
Get a webhook config
patch
Update a webhook config
delete
Delete a webhook config
get
List webhook configs
post
Ping a webhook config

Forms

The form object
get
Get a form
get
List forms
post
Render a form

Powered by

API Changelog

2021-02-16

phone is now a required field on company

2021-01-15

Initial version