Jump to Content

Guides Reference Changelog API Upgrades

Guides Reference

Guides Reference Changelog API Upgrades

Check API

Introduction

Topics

Authentication
Errors
- Error codes
- Rate limiting
Idempotent Requests
Versioning

Companies

The company object
Create a companypost
Get a companyget
Update a companypatch
List companiesget
Get payroll journalget
Get payroll summaryget
Get tax liability reportget
Get company paydaysget
Get company tax electionsget
Get contractor payments reportget
Get W-2 Preview Reportget
Get W-4 Exempt Status Reportget
The Federal EIN Verification object
List Federal EIN Verificationsget
Get a Federal EIN Verificationget
List tax depositsget
The Signatory object
Get signatoriesget
Create a signatorypost
The Enrollment Profile object
Get the enrollment profileget
Create the enrollment profileput
Update the enrollment profilepatch
Get a company's applied-for tax parameters reportget
Implementation

Addresses

Validate addresspost

Workplaces

The workplace object
Create a workplacepost
Get a workplaceget
Update a workplacepatch
List workplacesget

Employees

The employee object
Create an employeepost
Get an employeeget
Update an employeepatch
List employeesget
List employee paystubsget
Get a paystubget
List employee formsget
Get an employee formget
Submit an employee formpost
Get company-defined attributesget
Update company-defined attributespatch
Get reciprocity electionsget
Update reciprocity electionspatch

Contractors

The contractor object
Create a contractorpost
Get a contractorget
Update a contractorpatch
List contractorsget
List contractor paymentsget
Get a contractor paymentget

Earning Rates

The earning rate object
Create an earning ratepost
Get an earning rateget
List earning ratesget
Update an earning ratepatch

Payrolls

The payroll object
- The totals object
- The off-cycle options object
Create a payrollpost
Preview a payrollget
Reopen a pending payrollpost
Approve a payrollpost
Get a payrollget
Update a payrollpatch
List payrollsget
Delete a payrolldelete
Get paper checksget
Get Cash Requirement Reportget

Payroll Items

The payroll item object
Types of earnings
Create a payroll itempost
Get a payroll itemget
Update a payroll itempatch
List payroll itemsget
Delete a payroll itemdelete
Get a paper checkget
Warnings

Bank Accounts

The bank account object
Create a bank accountpost
Update a bank accountpatch
Get a bank accountget
List bank accountsget
Delete a bank accountdelete

Benefits

The benefit object
Types of benefits
Create a benefitpost
Get a benefitget
List benefitsget
Update a benefitpatch
Delete a benefitdelete

Company Benefits

The company benefit object
Create a company benefitpost
Get a company benefitget
List company benefitsget
Update a company benefitpatch
Delete a company benefitdelete

Contractor Payments

The contractor payment object
Create a contractor paymentpost
Get a contractor paymentget
Update a contractor paymentpatch
List contractor paymentsget
Delete a contractor paymentdelete
Get a paper checkget

Documents

The document object
List company tax documentsget
Get a company tax documentget
Download a company tax documentget
List company authorization documentsget
Get a company authorization documentget
Download a company authorization documentget
List employee tax documentsget
Get an employee tax documentget
Download an employee tax documentget
List contractor tax documentsget
Get a contractor tax documentget
Download a contractor tax documentget

Company Provided Documents

The company provided document object
Create a company provided documentpost
Get a company provided documentget
List company provided documentsget
Upload a file for a company provided document.put

Earning Codes

The earning code object
Create an earning codepost
Get an earning codeget
List earning codesget
Update an earning codepatch

Forms

The form object
Get a formget
List formsget
Render a formpost

Components

Overview of Components
Run Payrollpost
Employee Paystubspost
Employee Tax Documentspost
Employee SSN Setuppost
Employee Payment Setuppost
Employee Withholdings Setuppost
Employee Profilepost
Employee Post-Tax Deductionspost
Employee Benefitspost
Employee Onboardpost
Company Detailspost
Company-defined Employee Setuppost
Company Payment Setuppost
Company Filing Authorizationpost
Company Authorization Documentspost
Company Tax Documentspost
Company Tax Setuppost
Company Reportspost
Company Accounting Integrationpost
Company Terms of Servicepost
Company Onboardpost
Company Previous Payroll Provider Accesspost
Contractor Onboardpost
Contractor Tax Documentspost
Live Example
Early Enrollmentpost

Pay Schedules

The pay schedule object
Create a pay schedulepost
Get a pay scheduleget
List pay schedulesget
Update a pay schedulepatch
Get paydaysget

Post-Tax Deductions

The post-tax deduction object
Create a post-tax deductionpost
Get a post-tax deductionget
Update a post-tax deductionpatch
List post-tax deductionsget
Delete a post-tax deductiondelete

WebhookS

The webhook config object
Create a webhook configpost
Get a webhook configget
Update a webhook configpatch
Delete a webhook configdelete
List webhook configsget
Ping a webhook configpost
Retry webhook event in sandboxpost

Net pay splits

The net pay split object
Create a net pay splitpost
Get a net pay splitget
List net pay splitsget

Payments

The payments and payment attempts objects
List paymentsget
Get a paymentget
Get a payment attemptget
Retry a paymentpost
Refund a paymentpost

Tax Parameters

The tax parameter object
Types of tax parameters
Tax parameter option
Tax parameter dependency
Tax parameter setting
Tax parameter jurisdiction
Tax parameter definition
Company Tax Parameters
Employee Tax Parameters

Tax Filings

The tax filing object
The tax filing event object
Tax filing status
List tax filingsget
Get a tax filingget
Get a tax filing eventget

Requirements

The requirement object
Requirement categories
Requirement statuses
Requirement errors
Requirement guidance
List requirementsget
Get a requirementget

Check API

Introduction

Topics

Authentication
Errors
- Error codes
- Rate limiting
Idempotent Requests
Versioning

Companies

The company object
Create a companypost
Get a companyget
Update a companypatch
List companiesget
Get payroll journalget
Get payroll summaryget
Get tax liability reportget
Get company paydaysget
Get company tax electionsget
Get contractor payments reportget
Get W-2 Preview Reportget
Get W-4 Exempt Status Reportget
The Federal EIN Verification object
List Federal EIN Verificationsget
Get a Federal EIN Verificationget
List tax depositsget
The Signatory object
Get signatoriesget
Create a signatorypost
The Enrollment Profile object
Get the enrollment profileget
Create the enrollment profileput
Update the enrollment profilepatch
Get a company's applied-for tax parameters reportget
Implementation

Addresses

Validate addresspost

Workplaces

The workplace object
Create a workplacepost
Get a workplaceget
Update a workplacepatch
List workplacesget

Employees

The employee object
Create an employeepost
Get an employeeget
Update an employeepatch
List employeesget
List employee paystubsget
Get a paystubget
List employee formsget
Get an employee formget
Submit an employee formpost
Get company-defined attributesget
Update company-defined attributespatch
Get reciprocity electionsget
Update reciprocity electionspatch

Contractors

The contractor object
Create a contractorpost
Get a contractorget
Update a contractorpatch
List contractorsget
List contractor paymentsget
Get a contractor paymentget

Earning Rates

The earning rate object
Create an earning ratepost
Get an earning rateget
List earning ratesget
Update an earning ratepatch

Payrolls

The payroll object
- The totals object
- The off-cycle options object
Create a payrollpost
Preview a payrollget
Reopen a pending payrollpost
Approve a payrollpost
Get a payrollget
Update a payrollpatch
List payrollsget
Delete a payrolldelete
Get paper checksget
Get Cash Requirement Reportget

Payroll Items

The payroll item object
Types of earnings
Create a payroll itempost
Get a payroll itemget
Update a payroll itempatch
List payroll itemsget
Delete a payroll itemdelete
Get a paper checkget
Warnings

Bank Accounts

The bank account object
Create a bank accountpost
Update a bank accountpatch
Get a bank accountget
List bank accountsget
Delete a bank accountdelete

Benefits

The benefit object
Types of benefits
Create a benefitpost
Get a benefitget
List benefitsget
Update a benefitpatch
Delete a benefitdelete

Company Benefits

The company benefit object
Create a company benefitpost
Get a company benefitget
List company benefitsget
Update a company benefitpatch
Delete a company benefitdelete

Contractor Payments

The contractor payment object
Create a contractor paymentpost
Get a contractor paymentget
Update a contractor paymentpatch
List contractor paymentsget
Delete a contractor paymentdelete
Get a paper checkget

Documents

The document object
List company tax documentsget
Get a company tax documentget
Download a company tax documentget
List company authorization documentsget
Get a company authorization documentget
Download a company authorization documentget
List employee tax documentsget
Get an employee tax documentget
Download an employee tax documentget
List contractor tax documentsget
Get a contractor tax documentget
Download a contractor tax documentget

Company Provided Documents

The company provided document object
Create a company provided documentpost
Get a company provided documentget
List company provided documentsget
Upload a file for a company provided document.put

Earning Codes

The earning code object
Create an earning codepost
Get an earning codeget
List earning codesget
Update an earning codepatch

Forms

The form object
Get a formget
List formsget
Render a formpost

Components

Overview of Components
Run Payrollpost
Employee Paystubspost
Employee Tax Documentspost
Employee SSN Setuppost
Employee Payment Setuppost
Employee Withholdings Setuppost
Employee Profilepost
Employee Post-Tax Deductionspost
Employee Benefitspost
Employee Onboardpost
Company Detailspost
Company-defined Employee Setuppost
Company Payment Setuppost
Company Filing Authorizationpost
Company Authorization Documentspost
Company Tax Documentspost
Company Tax Setuppost
Company Reportspost
Company Accounting Integrationpost
Company Terms of Servicepost
Company Onboardpost
Company Previous Payroll Provider Accesspost
Contractor Onboardpost
Contractor Tax Documentspost
Live Example
Early Enrollmentpost

Pay Schedules

The pay schedule object
Create a pay schedulepost
Get a pay scheduleget
List pay schedulesget
Update a pay schedulepatch
Get paydaysget

Post-Tax Deductions

The post-tax deduction object
Create a post-tax deductionpost
Get a post-tax deductionget
Update a post-tax deductionpatch
List post-tax deductionsget
Delete a post-tax deductiondelete

WebhookS

The webhook config object
Create a webhook configpost
Get a webhook configget
Update a webhook configpatch
Delete a webhook configdelete
List webhook configsget
Ping a webhook configpost
Retry webhook event in sandboxpost

Net pay splits

The net pay split object
Create a net pay splitpost
Get a net pay splitget
List net pay splitsget

Payments

The payments and payment attempts objects
List paymentsget
Get a paymentget
Get a payment attemptget
Retry a paymentpost
Refund a paymentpost

Tax Parameters

The tax parameter object
Types of tax parameters
Tax parameter option
Tax parameter dependency
Tax parameter setting
Tax parameter jurisdiction
Tax parameter definition
Company Tax Parameters
Employee Tax Parameters

Tax Filings

The tax filing object
The tax filing event object
Tax filing status
List tax filingsget
Get a tax filingget
Get a tax filing eventget

Requirements

The requirement object
Requirement categories
Requirement statuses
Requirement errors
Requirement guidance
List requirementsget
Get a requirementget

Get a company

get https://sandbox.checkhq.com/companies/{company}

Returns the specified company.

Language

Authorization

Header

Click Try It! to start a request and see the response here!