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 Companies API

The Companies API from Zeal — 3 operation(s) for companies.

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

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

This API exposes 5 operations across 3 paths, and defines 6 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.

5 operations 3 paths 6 schemas 2 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 Companies 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 5

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

Companies 5
POST
/companies
Create a company
createCompany body → 200
GET
/companies
Get company information
getCompanyInformation 1 param → 200
PUT
/companies
Update company information
updateCompanyInformation body → 200
GET
/companies/onboard
Get a company onboarding link
getCompanyOnboardingLink 1 param → 200
POST
/bankAccount
Create a company bank account
createCompanyBankAccount body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are BankAccountRequest (5 properties), BankAccount (4 properties), UpdateCompanyRequest (4 properties), Company (4 properties). Each schema is shown below with its type and property counts.

Company
object
4 properties
UpdateCompanyRequest
object
4 properties
BankAccountRequest
object
5 properties
CreateCompanyRequest
object
3 properties 2 required
BankAccount
object
4 properties
OnboardLink
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeal-hq-companies-api-openapi.yml Raw ↑

Other APIs Zeal publishes across the network.

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