Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zeal Employee Check API

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

Zeal Employee Check API is one of 10 APIs that Zeal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Employee Check. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.zeal.com.

6 operations 3 paths 3 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.zeal.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Zeal Employee Check API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Provide your Zeal API key as a Bearer token: Authorization: Bearer . Use a test key for Test Mode and a live key for production. Requests are additionally scop…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Employee Check 6
POST
/employeeCheck
Create an employee check
createEmployeeCheck body → 200
GET
/employeeCheck
Get employee checks by employee
getEmployeeChecksByEmployee 2 params → 200
PUT
/employeeCheck
Update an employee check
updateEmployeeCheck body → 200
DELETE
/employeeCheck
Delete an employee check
deleteEmployeeCheck 2 params → 200
POST
/employeeCheck/bulk
Create bulk employee checks
createBulkEmployeeChecks body → 200
GET
/paystub
Download a paystub PDF
downloadPaystubPdf 2 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are EmployeeCheck (7 properties), CreateEmployeeCheckRequest (5 properties), Shift (4 properties). Each schema is shown below with its type and property counts.

Shift
object
4 properties
CreateEmployeeCheckRequest
object
5 properties 3 required
EmployeeCheck
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeal-hq-employee-check-api-openapi.yml Raw ↑

Other APIs Zeal publishes across the network.

Zeal Companies API
Zeal Contractor Payments API
Zeal Contractors API
Zeal Employees API
Zeal Funding API
Zeal Onboarding API
Zeal Pay Schedules API
Zeal Reports API
Zeal Tax API