ZB ID API Documentation

ZB ID is the unified identity platform for ZB Financial Holdings. It provides a single API for user authentication, session management, role-based access control, and OAuth2 client credentials across every ZB product and service.

Getting started

To get started, register a user account through the API, obtain your access and refresh tokens, and begin making authenticated requests. If you are building a service-to-service integration, register an OAuth2 client and use the client credentials flow instead.

Guides

Quickstart

Register a user, log in, and make your first API call in minutes.

Read more

Authentication

Learn about user auth flows, OAuth2 client credentials, and token management.

Read more

Errors

Read about the different types of errors returned by the API.

Read more

Rate Limiting

Understand rate limit tiers and how to handle 429 responses.

Read more

Resources

Users

Manage user profiles, retrieve user information, and update account status.

Sessions

View active sessions, revoke individual sessions, or log out from all devices.

Roles & Permissions

Role-based access control with fine-grained permission scopes for every ZB platform.

Token Introspection

Validate and inspect access tokens for both user and service-to-service calls.

KYC Verification

Validate national IDs, run credit checks, and screen against AML watchlists.

Was this page helpful?