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

Zego Customers API

Customer status, validation, registration and enrolment.

Zego Customers API is one of 5 APIs that Zego publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a changelog.

This API exposes 4 operations across 4 paths. It is described by OpenAPI 3.0.3, at version 2.0.

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

4 operations 4 paths 0 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.zego.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Zego Customers API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (partnerToken). By default, every request must be authenticated.

  • partnerToken — Partner authorization token issued by the Zego Partnerships Manager, sent in the Authorization header.

Paths & Operations 4

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

Customers 4

Customer status, validation, registration and enrolment.

GET
/v1/user/status/
Retrieve customer insurance status
getCustomerStatus → 200401404
GET
/v1/validate/customer-number/{customerNumber}
Validate a customer number exists
validateCustomerNumber 1 param → 200401404
POST
/v2/customer/enrol/public-liability/
Create and enrol a customer on public liability
enrolCustomerPublicLiability body → 201400401
POST
/v2/customer/register/
Create a new customer in the system
registerCustomer body → 201400401

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zego-customers-api-openapi.yml Raw ↑

Other APIs Zego publishes across the network.

Zego Customer Integration API
Zego Occupations API
Zego Policies API
Zego Shifts API