/
CH
checkhq
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
post
/companies/{company}/components/previous_provider_access
Company Previous Payroll Provider Access
post
/companies/{company}/components/progress_tracker
Company Progress Tracker Component
post
/companies/{company}/components/verification_documents
Company Verification Documents
post
/companies/{company}/components/early_enrollment
Company Early Enrollment
post
/companies/{company}/components/signatory_agreements
Company Signatory Agreements
post
/companies/{company}/components/connect_bank_account
Company Connect Bank Account
post
/companies/{company}/components/team_setup
Company Team Setup
post
/companies/{company}/components/team_setup/employees
Employee Roster
post
/companies/{company}/components/team_setup/contractors
Contractor Roster
post
/companies/{company}/components/team_setup/workplaces
Workplace Roster
post
/companies/{company}/components/team_setup/personal_details
Personal Details
post
/companies/{company}/components/pay_history
Company Pay History
post
/companies/{company}/components/full_service_setup_submission
Company Full Service Setup Submission Component
post
/companies/{company}/components/business_details
Company Business Details Component
post
/employees/{employee}/components/tax_setup
Employee Tax Setup Component
post
/companies/{company}/onboard
Company Onboard
post
/companies/{company}/components/terms_of_service
Company Terms of Service
post
/companies/{company}/components/details
Company Details
post
/companies/{company}/components/payment_setup
Company Payment Setup
post
/companies/{company}/components/tax_setup
Company Tax Setup
post
/companies/{company}/components/employee_setup
Company-Defined Employee Setup
post
/companies/{company}/components/filing_authorization
Company Filing Authorization
post
/companies/{company}/components/accounting_integration
Company Accounting Integration
post
/companies/{company}/components/authorization_documents
Company Authorization Documents
post
/companies/{company}/components/tax_documents
Company Tax Documents
post
/companies/{company}/components/company_reports
Company Reports
post
/companies/{company}/components/run_payroll
Run Payroll
post
/companies/{company}/components/checklist
Filing Preparation Checklist Component
post
/companies/{company}/components/filing_preview
Filing Preview Component
post
/employees/{employee}/onboard
Employee Onboard
post
/employees/{employee}/components/ssn_setup
Employee SSN Setup
post
/employees/{employee}/components/payment_setup
Employee Payment Setup
post
/employees/{employee}/components/withholdings_setup
Employee Withholdings Setup
post
/employees/{employee}/components/profile
Employee Profile
post
/employees/{employee}/components/benefits
Employee Benefits
post
/employees/{employee}/components/post_tax_deductions
Employee Post-Tax Deductions
post
/employees/{employee}/components/tax_documents
Employee Tax Documents
post
/employees/{employee}/components/paystubs
Employee Paystubs
post
/contractors/{contractor}/onboard
Contractor Onboard
post
/contractors/{contractor}/components/tax_documents
Contractor Tax Documents
post
/contractors/{contractor}/components/paystubs
Contractor Paystubs
get
/companies
List companies
post
/companies
Create a company
get
/companies/{company}
Get a company
patch
/companies/{company}
Update a company
get
/companies/{company}/reports/payroll_journal
Get payroll journal
get
/companies/{company}/reports/tax_liabilities
Get tax liability report
get
/companies/{company}/paydays
Get company paydays
get
/companies/{company}/reports/contractor_payments
Get contractor payments report
get
/companies/{company}/reports/w2_preview
Get W-2 Preview Report
get
/companies/{company}/reports/w4_exemption_status
Get W-4 Exempt Status Report
get
/companies/{company}/federal_ein_verifications
List Federal EIN Verifications
get
/companies/{company}/federal_ein_verifications/{federal_ein_verification}
Get a Federal EIN Verification
get
/companies/{company}/tax_deposits
List tax deposits
get
/companies/{company}/signatories
Get signatories
post
/companies/{company}/signatories
Create a signatory
get
/companies/{company}/enrollment_profile
Get the enrollment profile
put
/companies/{company}/enrollment_profile
Create the enrollment profile
patch
/companies/{company}/enrollment_profile
Update the enrollment profile
get
/companies/{company}/benefit_aggregations
Benefit Aggregations
post
/companies/{company}/start_implementation
Start implementation
post
/companies/{company}/cancel_implementation
Cancel implementation
post
/companies/{company_id}/request_embedded_setup
Request Embedded Setup
post
/addresses/validate
Validate address
get
/workplaces
List workplaces
post
/workplaces
Create a workplace
get
/workplaces/{workplace}
Get a workplace
patch
/workplaces/{workplace}
Update a workplace
get
/employees
List employees
post
/employees
Create an employee
get
/employees/{employee}
Get an employee
patch
/employees/{employee}
Update an employee
get
/employees/{employee}/paystubs
List employee paystubs
get
/employees/{employee}/paystubs/{payroll}
Get a paystub
get
/employees/{employee}/forms
List employee forms
get
/employees/{employee}/forms/{form}
Get an employee form
post
/employees/{employee}/forms/{form}/submit
Submit an employee form
get
/employees/{employee}/company_defined_attributes
Get company-defined attributes
patch
/employees/{employee}/company_defined_attributes
Update company-defined attributes
get
/employees/{employee}/reciprocity_elections
Get reciprocity elections
patch
/employees/{employee}/reciprocity_elections
Update reciprocity elections
get
/employees/{employee}/reveal
Reveal employee SSN
post
/employees/{employee}/authorize_partner
Authorize an integration partner for an employee
get
/contractors
List contractors
post
/contractors
Create a contractor
get
/contractors/{contractor}
Get a contractor
patch
/contractors/{contractor}
Update a contractor
get
/contractors/{contractor}/payments
List contractor payments
get
/contractors/{contractor}/payments/{payroll}
Get a contractor pay statement
get
/contractors/{contractor}/forms
List contractor forms
post
/contractors/{contractor}/forms/{form}/submit
Submit a contractor form
get
/contractors/{contractor}/reveal
Reveal contractor SSN
get
/bank_accounts
List bank accounts
post
/bank_accounts
Create a bank account
get
/bank_accounts/{bank_account}
Get a bank account
delete
/bank_accounts/{bank_account}
Delete a bank account
patch
/bank_accounts/{bank_account}
Update a bank account
get
/bank_accounts/{bank_account}/reveal
Reveal account number
get
/net_pay_splits
List net pay splits
post
/net_pay_splits
Create a net pay split
get
/net_pay_splits/{net_pay_split}
Get a net pay split
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Get payroll journal
get
/companies/{company}/reports/payroll_journal
Nov 3, 2026
5a54f5eb888b
Revision changes
info
added the new optional
query
request parameter
include_contractor_id