Zeal

Zeal Employee Check API

The Employee Check API from Zeal — 3 operation(s) for employee check.

GitHub OpenAPI

Operations 6

POST /employeeCheck Create an employee check #
GET /employeeCheck Get employee checks by employee #
PUT /employeeCheck Update an employee check #
DELETE /employeeCheck Delete an employee check #
POST /employeeCheck/bulk Create bulk employee checks #
GET /paystub Download a paystub PDF #

Documentation

📖
Documentation
https://docs.zeal.com/docs/what-is-zeal
📖
APIReference
https://docs.zeal.com/reference/create-company
📖
Documentation
https://docs.zeal.com/docs/employee-onboarding-guide
📖
APIReference
https://docs.zeal.com/reference/create-employee
📖
Documentation
https://docs.zeal.com/docs/contractor-onboarding-guide
📖
APIReference
https://docs.zeal.com/reference/create-contractor
📖
Documentation
https://docs.zeal.com/docs/regular-payroll
📖
APIReference
https://docs.zeal.com/reference/create-employee-check
📖
APIReference
https://docs.zeal.com/reference/create-contractor-payment
📖
Documentation
https://docs.zeal.com/reference/pay-frequency-reporting-periods-and-check-dates
📖
APIReference
https://docs.zeal.com/reference/get-all-reporting-periods
📖
APIReference
https://docs.zeal.com/reference/generate-employee-onboarding-link
📖
Documentation
https://docs.zeal.com/reference/introduction
📖
APIReference
https://docs.zeal.com/reference/get-employee-tax-parameter-definitions
📖
APIReference
https://docs.zeal.com/reference/create-payroll-journal-report
📖
APIReference
https://docs.zeal.com/reference/get-provider-balance
📖
Documentation
https://docs.zeal.com/reference/webhook-events
📖
APIReference
https://docs.zeal.com/reference/webhook-events

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zeal-hq/refs/heads/main/openapi/zeal-hq-employee-check-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/zeal-hq/refs/heads/main/collections/zeal-hq.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/zeal-hq/refs/heads/main/collections/zeal-hq.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zeal-hq-employee-check-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zeal-hq-employee-check-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zeal Companies Employee Check API
  description: 'Zeal is an embedded payroll-as-a-service platform. This representative OpenAPI describes the core surfaces of the Zeal API used to build payroll products: onboarding companies, employees, and contractors; running pay runs (employee checks) and contractor payments; managing pay schedules, tax parameters, reports, funding, and webhooks. All requests are authenticated with a Bearer API key and scoped by a companyID. Use a test API key against Test Mode (no money moves) before switching to a live key.'
  termsOfService: https://www.zeal.com/terms
  contact:
    name: Zeal Support
    url: https://docs.zeal.com
    email: support@zeal.com
  version: '1.0'
servers:
- url: https://api.zeal.com
  description: Zeal API (test or live selected by API key)
security:
- bearerAuth: []
tags:
- name: Employee Check
paths:
  /employeeCheck:
    post:
      operationId: createEmployeeCheck
      tags:
      - Employee Check
      summary: Create an employee check
      description: Create a paycheck (employee check) for a reporting period. Zeal calculates gross-to-net, employee and employer taxes, and deductions.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEmployeeCheckRequest'
      responses:
        '200':
          description: The created employee check(s).
          content:
            application/json:
              schema:
                type: object
                properties:
                  checks:
                    type: array
                    items:
                      $ref: '#/components/schemas/EmployeeCheck'
    get:
      operationId: getEmployeeChecksByEmployee
      tags:
      - Employee Check
      summary: Get employee checks by employee
      parameters:
      - $ref: '#/components/parameters/companyID'
      - name: employeeID
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A list of employee checks.
          content:
            application/json:
              schema:
                type: object
                properties:
                  checks:
                    type: array
                    items:
                      $ref: '#/components/schemas/EmployeeCheck'
    put:
      operationId: updateEmployeeCheck
      tags:
      - Employee Check
      summary: Update an employee check
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeCheck'
      responses:
        '200':
          description: The updated employee check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeCheck'
    delete:
      operationId: deleteEmployeeCheck
      tags:
      - Employee Check
      summary: Delete an employee check
      parameters:
      - $ref: '#/components/parameters/companyID'
      - name: employeeCheckID
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deletion result.
          content:
            application/json:
              schema:
                type: object
  /employeeCheck/bulk:
    post:
      operationId: createBulkEmployeeChecks
      tags:
      - Employee Check
      summary: Create bulk employee checks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                companyID:
                  type: string
                checks:
                  type: array
                  items:
                    $ref: '#/components/schemas/CreateEmployeeCheckRequest'
      responses:
        '200':
          description: The created employee checks.
          content:
            application/json:
              schema:
                type: object
  /paystub:
    get:
      operationId: downloadPaystubPdf
      tags:
      - Employee Check
      summary: Download a paystub PDF
      parameters:
      - $ref: '#/components/parameters/companyID'
      - name: employeeCheckID
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The paystub PDF.
          content:
            application/pdf:
              schema:
                type: string
                format: binary
components:
  parameters:
    companyID:
      name: companyID
      in: query
      required: true
      description: The Zeal companyID identifying the employer account.
      schema:
        type: string
  schemas:
    Shift:
      type: object
      properties:
        time:
          type: string
          format: date-time
        hourly_wage:
          type: number
        hours:
          type: number
        wage_type:
          type: string
    CreateEmployeeCheckRequest:
      type: object
      required:
      - companyID
      - employeeID
      - reportingPeriodID
      properties:
        companyID:
          type: string
        employeeID:
          type: string
        reportingPeriodID:
          type: string
        check_date:
          type: string
          format: date
        shifts:
          type: array
          items:
            $ref: '#/components/schemas/Shift'
    EmployeeCheck:
      type: object
      properties:
        employeeCheckID:
          type: string
        employeeID:
          type: string
        reportingPeriodID:
          type: string
        check_date:
          type: string
          format: date
        gross_pay:
          type: number
        net_pay:
          type: number
        status:
          type: string
          enum:
          - pending
          - pre-processed
          - processed
          - failed
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Provide your Zeal API key as a Bearer token: `Authorization: Bearer <YOUR_API_KEY>`. Use a test key for Test Mode and a live key for production. Requests are additionally scoped by a companyID passed in the body or query.'