Zeal

Zeal is an embedded, payroll-as-a-service platform. Its API lets software companies build their own payroll products - onboarding companies, employees, and 1099 contractors, running pay runs, disbursing pay, and handling tax calculation, filing, and compliance across all US jurisdictions - without becoming a payroll company themselves.

11 APIs 0 Features

PayrollEmbedded FinanceFintechTax ComplianceContractorsHuman Resources

APIs

Zeal Companies API

Create and manage employer companies on the platform - company profile, onboarding links and status, authorization documents, and company bank accounts with micro-deposit verifi...

Zeal Employees API

Create, retrieve, and update W-2 employees, upload government IDs, check onboarding requirements, and manage employee tax parameters and withholding.

Zeal Contractors API

Create, retrieve, and update 1099 contractors, upload government IDs, generate contractor onboarding links, and set onboarded status.

Zeal Employee Check (Payroll Run) API

Create single and bulk employee checks (paychecks), attach and edit shifts, preview payroll, download paystub PDFs, and run pay runs that calculate gross-to-net and taxes.

Zeal Contractor Payments API

Create, retrieve, update, and delete contractor payments and trigger their disbursement to worker bank accounts.

Zeal Pay Schedules API

Retrieve reporting periods, upcoming regular payroll, and the next available check and pay dates that drive the company's pay frequency and schedule.

Zeal Worker Onboarding API

Generate hosted onboarding links for employees and contractors - account setup, bank account collection, ID upload, W-4, I-9, and custom paperwork - so workers can complete comp...

Zeal Tax and Compliance API

Set and retrieve employee tax parameters and definitions, resolve taxable work locations, and look up minimum wage rules for automated, jurisdiction-aware payroll tax handling.

Zeal Reports API

Generate asynchronous payroll reports - payroll journal, cash requirements, labor allocation, payment/worker summaries, quarter- and year-to-date - then poll job status and down...

Zeal Funding and Journal API

Inspect the reserve/provider balance funding payroll and build a payroll journal via the custom payroll journal report for accounting reconciliation.

Zeal Webhooks and Events API

Subscribe to platform events - company, employee, contractor, bank account, employee-check and employer-check processed events - delivered as webhooks so consumers can react to ...

Collections

Zeal API

OPEN

Pricing Plans

Zeal Hq Plans Pricing

4 plans

PLANS

Rate Limits

Zeal Hq Rate Limits

3 limits

RATE LIMITS

FinOps

Zeal Hq Finops

FINOPS

Resources

Sources

opencollection: 1.0.0
info:
  name: Zeal API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Companies
    type: folder
  items:
  - info:
      name: Create a company
      type: http
    http:
      method: POST
      url: https://api.zeal.com/companies
      body:
        type: json
        data: '{}'
    docs: Create a new employer company on the platform.
  - info:
      name: Get company information
      type: http
    http:
      method: GET
      url: https://api.zeal.com/companies?companyID=:companyID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
    docs: Retrieve the company record.
  - info:
      name: Update company information
      type: http
    http:
      method: PUT
      url: https://api.zeal.com/companies
      body:
        type: json
        data: '{}'
    docs: Update company profile fields such as payroll_schedule and payroll_firstCheckDate.
  - info:
      name: Create company bank account
      type: http
    http:
      method: POST
      url: https://api.zeal.com/bankAccount
      body:
        type: json
        data: '{}'
    docs: Create a company bank account for funding payroll.
- info:
    name: Employees
    type: folder
  items:
  - info:
      name: Create an employee
      type: http
    http:
      method: POST
      url: https://api.zeal.com/employees
      body:
        type: json
        data: '{}'
    docs: Create a W-2 employee.
  - info:
      name: Get employees
      type: http
    http:
      method: GET
      url: https://api.zeal.com/employees?companyID=:companyID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
    docs: List employees for a company.
  - info:
      name: Update employee information
      type: http
    http:
      method: PUT
      url: https://api.zeal.com/employees
      body:
        type: json
        data: '{}'
    docs: Update an employee record.
  - info:
      name: Set employee tax parameters
      type: http
    http:
      method: POST
      url: https://api.zeal.com/taxes/employee/setup
      body:
        type: json
        data: '{}'
    docs: Set an employee's tax parameters and withholding.
- info:
    name: Contractors
    type: folder
  items:
  - info:
      name: Create a contractor
      type: http
    http:
      method: POST
      url: https://api.zeal.com/contractors
      body:
        type: json
        data: '{}'
    docs: Create a 1099 contractor.
  - info:
      name: Get contractors
      type: http
    http:
      method: GET
      url: https://api.zeal.com/contractors?companyID=:companyID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
    docs: List contractors for a company.
  - info:
      name: Update contractor information
      type: http
    http:
      method: PUT
      url: https://api.zeal.com/contractors
      body:
        type: json
        data: '{}'
    docs: Update a contractor record.
- info:
    name: Employee Check
    type: folder
  items:
  - info:
      name: Create an employee check
      type: http
    http:
      method: POST
      url: https://api.zeal.com/employeeCheck
      body:
        type: json
        data: '{}'
    docs: Create a paycheck; Zeal calculates gross-to-net and taxes.
  - info:
      name: Create bulk employee checks
      type: http
    http:
      method: POST
      url: https://api.zeal.com/employeeCheck/bulk
      body:
        type: json
        data: '{}'
    docs: Create many employee checks in a single request.
  - info:
      name: Get employee checks by employee
      type: http
    http:
      method: GET
      url: https://api.zeal.com/employeeCheck?companyID=:companyID&employeeID=:employeeID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
      - name: employeeID
        value: ''
        type: query
        description: The employee ID.
    docs: List an employee's checks.
  - info:
      name: Download paystub PDF
      type: http
    http:
      method: GET
      url: https://api.zeal.com/paystub?companyID=:companyID&employeeCheckID=:employeeCheckID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
      - name: employeeCheckID
        value: ''
        type: query
        description: The employee check ID.
    docs: Download the paystub PDF for an employee check.
- info:
    name: Contractor Payments
    type: folder
  items:
  - info:
      name: Create a contractor payment
      type: http
    http:
      method: POST
      url: https://api.zeal.com/contractorPayments
      body:
        type: json
        data: '{}'
    docs: Create a payment to a contractor.
  - info:
      name: Get contractor payments
      type: http
    http:
      method: GET
      url: https://api.zeal.com/contractorPayments?companyID=:companyID&contractorID=:contractorID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
      - name: contractorID
        value: ''
        type: query
        description: The contractor ID.
    docs: List contractor payments.
  - info:
      name: Trigger disbursement
      type: http
    http:
      method: POST
      url: https://api.zeal.com/contractorPayments/disburse
      body:
        type: json
        data: '{}'
    docs: Trigger disbursement of contractor payments to worker bank accounts.
- info:
    name: Pay Schedules
    type: folder
  items:
  - info:
      name: Get all reporting periods
      type: http
    http:
      method: GET
      url: https://api.zeal.com/reportingPeriods?companyID=:companyID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
    docs: List reporting periods for the company's pay schedule.
  - info:
      name: Get upcoming regular payroll
      type: http
    http:
      method: GET
      url: https://api.zeal.com/reportingPeriods/upcoming?companyID=:companyID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
    docs: Get the next upcoming regular payroll period.
  - info:
      name: Get next available check date
      type: http
    http:
      method: GET
      url: https://api.zeal.com/checkDate?companyID=:companyID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
    docs: Get the next available check / pay date.
- info:
    name: Onboarding
    type: folder
  items:
  - info:
      name: Get company onboarding link
      type: http
    http:
      method: GET
      url: https://api.zeal.com/companies/onboard?companyID=:companyID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
    docs: Generate a hosted onboarding link for the company.
  - info:
      name: Generate employee onboarding link
      type: http
    http:
      method: GET
      url: https://api.zeal.com/employees/onboarding?companyID=:companyID&employeeID=:employeeID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
      - name: employeeID
        value: ''
        type: query
        description: The employee ID.
    docs: Generate a hosted onboarding link for an employee.
  - info:
      name: Generate contractor onboarding link
      type: http
    http:
      method: GET
      url: https://api.zeal.com/contractors/onboard?companyID=:companyID&contractorID=:contractorID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
      - name: contractorID
        value: ''
        type: query
        description: The contractor ID.
    docs: Generate a hosted onboarding link for a contractor.
- info:
    name: Tax
    type: folder
  items:
  - info:
      name: Get employee tax parameter definitions
      type: http
    http:
      method: GET
      url: https://api.zeal.com/taxes/employee/definitions?companyID=:companyID&employeeID=:employeeID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
      - name: employeeID
        value: ''
        type: query
        description: The employee ID.
    docs: Get the tax parameter definitions required for an employee.
  - info:
      name: Resolve taxable location
      type: http
    http:
      method: POST
      url: https://api.zeal.com/taxes/location
      body:
        type: json
        data: '{}'
    docs: Resolve a work address to a taxable location.
  - info:
      name: Get minimum wage rules
      type: http
    http:
      method: GET
      url: https://api.zeal.com/minimumWage?jurisdiction=:jurisdiction
      params:
      - name: jurisdiction
        value: ''
        type: query
        description: The jurisdiction to look up.
    docs: Look up applicable minimum wage rules.
- info:
    name: Reports
    type: folder
  items:
  - info:
      name: Create payroll journal report
      type: http
    http:
      method: POST
      url: https://api.zeal.com/reports/payrollJournal
      body:
        type: json
        data: '{}'
    docs: Create an asynchronous payroll journal report.
  - info:
      name: Create cash requirements report
      type: http
    http:
      method: POST
      url: https://api.zeal.com/reports/cashRequirements
      body:
        type: json
        data: '{}'
    docs: Create an asynchronous cash requirements report.
  - info:
      name: Get report job status
      type: http
    http:
      method: GET
      url: https://api.zeal.com/reports/status?jobID=:jobID
      params:
      - name: jobID
        value: ''
        type: query
        description: The report job ID.
    docs: Poll the status of a report job.
  - info:
      name: Retrieve report download
      type: http
    http:
      method: GET
      url: https://api.zeal.com/reports/download?jobID=:jobID
      params:
      - name: jobID
        value: ''
        type: query
        description: The report job ID.
    docs: Download a finished report.
- info:
    name: Funding
    type: folder
  items:
  - info:
      name: Get reserve balance
      type: http
    http:
      method: GET
      url: https://api.zeal.com/reserve/balance?companyID=:companyID
      params:
      - name: companyID
        value: ''
        type: query
        description: The Zeal companyID.
    docs: Get the reserve / provider balance funding payroll.
bundled: true