For AI agents: visit https://docs.zeal.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Zeal DocsZeal Docs
GuidesAPI Reference
Log InZeal Docs
API Reference
Log In
GuidesAPI Reference

Introduction

  • Introduction
  • Authentication and Keys
  • Error Codes
  • Rate Limiting
  • Idempotency
  • Times and Dates
  • Pay Frequency, Reporting Periods and Check Dates
  • Early Access Endpoints
  • Metadata
  • Pagination

Webhooks

  • What are Zeal Webhooks?
  • Webhook Event Overview
  • Create Employee Event
  • Company Onboarding Event
  • Company Event
  • Customer Account Onboarding Event
  • Customer Account Event
  • Employee Onboarding Event
  • Employee Event
  • Contractor Event
  • Employee Check Event
  • Contractor Payment Event
  • Shift Event
  • Employer Check Created Event
  • Employer Check Processed Event
  • Employer Check Processed Webhook Lite
  • Job Queue Event
  • Employee I9 Update Event (Early Access)
  • Employee E-Verify Update Event (Early Access)
  • Employee Requirements Create Event
  • Employee Requirements Update Event
  • Paycard Onboarding Status Event (Early Access)
  • Instant Pay Wallet Transaction Event
  • Transaction Update Event
  • Paperwork Submission Event
  • Bank Account Event

Zeal Components

  • Generate Company Taxes Page linkpost
  • Generate Company Login Linkpost
  • Generate Employee or Contractor Dashboard Linkpost
  • Generate Reports Linkpost
  • Get Paystub/Employee Check Linkget
  • Get Contractor Payment Linkget

Companies

  • The Company Object
  • The Requirement Object
  • Create Companypost
  • Get Company Onboarding Linkget
  • Update Company Informationpatch
  • Get Company Informationget

Company Onboarding

  • Create Company Bank Accountpost
  • Trigger Micro-Depositspost
  • Verify Microdeposit Valuespost
  • Get Company Authorization Documentsget
  • Sign Company Authorization Documentspost
  • Set Company Onboarded Status to Truepost

Reserve Accounts

  • Get Reserve Balanceget

Customer Accounts [EARLY ACCESS]

  • Customer Account Object
  • Create Customer Accountpost
  • Update Customer Accountpatch
  • Generate Customer Account Onboarding Linkpost
  • Set Customer Account Onboarded To truepost
  • Create Funding Sourcepost
  • Trigger Microdepositspost
  • Verify Microdepositspost
  • Get Customer Accountget
  • Get All Customer Accountsget

Taxable Locations

  • Taxable Location Object
  • Resolve Taxable Locationpost
  • Get Taxable Location by IDget

Work Locations

  • Work Location Object
  • Create Work Locationpost
  • Get Work Locationsget
  • Update Work Locationpatch

Employees

  • The Employee Object
  • Create Employeepost
  • Update Employee Informationpatch
  • Get Employee Informationget
  • Get Employeesget
  • Upload Employee Government IDpost
  • Employee Requirements Object
  • Get Employee Requirementsget

Employee Deduction Templates

  • Create Employee Deduction Templatepost
  • List Employee Deduction Templatesget
  • Update Employee Deduction Templatepatch
  • Get Employee Deduction Templateget
  • Delete Employee Deduction Templatedel

Employee Onboarding

  • Generate Employee Onboarding Linkpost
  • Send Employee Onboarding Linkpost
  • Generate Employee Tax Parameter Definitionspost
  • Set Employee Tax Parameterspost
  • Get Employee Tax Parameter Summarypost
  • Set Onboarded Status to Truepost
  • Create Profile Information Collection Linkpost
  • Create Account Setup Linkpost
  • Create I9 Link (Early Access)post
  • Create Custom Paperwork Link (Early Access)post
  • Create W4 Linkpost
  • Create Paycard Enrollment Link (Early Access)post
  • Create Instant Pay Employee Enrollment Linkpost
  • Create Bank Account Collection Linkpost
  • Create Employee ID Upload Linkpost
  • Get I9 Status (Early Access)get

Bank Accounts

  • Bank Account Object
  • Create Bank Accountpost
  • Update Bank Accountpatch
  • Get Bank Account by IDget

Custom Attributes

  • Custom Attribute Object
  • Get Attributesget
  • Set Attribute Valuepatch

Paperwork API

  • Paperwork Templates
    • Paperwork Template Object
    • Get Paperwork Templatespost
    • Get Paperwork Template by IDget
  • Paperwork Submissions
    • Paperwork Submission Object
    • Get paperwork submissionspost
    • Get a specific paperwork submissionget
    • Create a paperwork submissionput

Employee Checks

  • Reporting Periods
    • Reporting Period Object
    • Get Reporting Period by Date Rangeget
    • Get All Reporting Periodsget
  • Employee Checks
    • Employee Check Object
    • Create Employee Checkpost
    • Update Employee Checkpatch
    • Delete Employee Checkdel
    • Get Employee Check by IDget
    • Get Employee Checks by Employeeget
    • Create Bulk Employee Checkspost
    • Download Paystub PDFget
  • Deductions
    • Deduction Template Definition Object
    • Deduction Template Object
    • Deduction Object
    • Types of Deductions
    • Get Deduction Template Definitionsget
    • Create Deduction Templatepost
    • Get Deduction Templateget
    • Create Deductionpost
    • Get Deductionget
    • Update Deductionpatch
    • Delete Deductiondel
  • Shifts
    • Shift Object
    • Add Shifts to Existing Checkpost
    • Get Shift Informationget
    • Update Pending Shiftspatch
    • Delete Pending Shiftsdel
  • Payroll Run
    • Get Upcoming Regular Payrollget

Contractors

  • Contractor Object
  • Create Contractorpost
  • Update Contractor Informationpatch
  • Get Contractor Informationget
  • Get Contractorsget
  • Upload Contractor Government IDpost

Contractor Onboarding

  • Generate Contractor Onboarding Linkpost
  • Set Onboarded Status to Truepost
  • Create Contractor ID Upload Linkpost
  • Create Paycard Enrollment Link (Early Access)post
  • Create Instant Pay Contractor Enrollment Linkpost

Contractor Payment Deductions

  • Create Contractor Deduction Templatepost
  • Update Contractor Deduction Templatepatch
  • Get Contractor Deduction Templatesget
  • Delete Contractor Deduction Templatedel

Payment Items

  • Payment Item Object
  • Create Payment Itempost
  • Update Payment Itempatch

Contractor Payments

  • Contractor Payment Object
  • Create Contractor Paymentpost
  • Trigger Disbursementpost
  • Update Contractor Paymentpatch
  • Get Contractor Paymentsget
  • Delete Contractor Paymentdel

Paycards [Early Access]

  • Paycard Object
  • Get Paycardsget

Instant Pay [EARLY ACCESS]

  • Card Object
  • Wallet Transaction Object
  • Get Cardget
  • Get Wallet Balanceget
  • Transfer Fundspost
  • Get Wallet Transactionsget

Employer Checks

  • Employer Check Object
  • Employer CheckID Object
  • Get Employer Check by IDget

Preview

  • Preview Payroll by Check IDspost
  • Preview Payroll by Check Datepost
  • Preview Check Datapost
  • Get Previewget
  • Get Next Available Check/Pay Dateget

Embedded HR

  • Minimum Wage
    • Get Minimum Wage Rulesget
  • Accrual Policy
    • Accrual Policy Object
    • Create Accrual Policypost
    • Update Accrual Policypatch
    • Get Accrual Policyget
    • Get Sick Time Compliance Rulesget
    • Add/Remove Employees to Accrual Policypost
    • Update Accrual Balancepatch
    • Get Accrual Balanceget
    • Create Accrual Policy Usagepost
    • Accrual Balance Historypost
  • FLSA Overtime
    • Preview Overtime Checkspost

Reports

  • Create Payroll Journal Reportpost
  • Create Custom Payroll Journal Reportpost
  • Create Worker Summary Reportpost
  • Create Cash Requirements Reportpost
  • Create Payment Summary Reportpost
  • Create Labor Allocation Reportpost
  • Create Paystub Reportpost
  • Create Year to Date Reportpost
  • Create Quarter to Date Reportpost
  • Create KYC Summary Reportpost
  • Create Deduction Summary Reportpost
  • Get Job Statusget
  • Get Report Downloadget

Documents

  • The Document Object
  • Get Documentsget

Employee I9 Update Event (Early Access)

POSTs request when an Employee I9 form has been updated.

Updated about 1 year ago


Job Queue Event
Employee E-Verify Update Event (Early Access)
Did this page help you?

Updated about 1 year ago


Job Queue Event
Employee E-Verify Update Event (Early Access)
Did this page help you?
    • Request Body
    • Returns
    • Raw Content Example