Skip to main content

API Reference

Welcome to BizzAssure's API documentation. Our APIs allow you to integrate employee and policy management capabilities directly into your HR or benefits platform.

Base URL​

Please contact the BizzAssure team to get the base URL for your environment.

API Versioning​

BizzAssure APIs use path versioning to ensure backward compatibility while allowing for new features and improvements.

/v{major}/path/to/resource

Example: /v1/auth/token

Authentication​

All BizzAssure APIs require authentication using a Bearer token. To authenticate:

  1. Obtain API Credentials: Contact the BizzAssure team to receive your client_id and client_secret.
  2. Generate a Token: Use the Token API to exchange your credentials for a temporary access token.
  3. Use the Token: Include the token in the Authorization header of every request.
Authorization: Bearer YOUR_ACCESS_TOKEN

Tokens are valid for 1 hour and must be regenerated when expired. See the Authentication Guide for full details.

Available APIs​

Token​

Generate access tokens using your client_id and client_secret.

Employees​

Create and retrieve employees within your organisation.

Policies​

Manage endorsements (add/remove employees from policies), retrieve endorsement status, and fetch employee policy coverage details including health card PDFs.

Need Help?​

Contact our developer support team for assistance with your integration.