Key Concepts
Authentication
Connect to the API using the authentication token provided during signup. Every API call must include a valid API key in the Authorization request header. See Authentication for details.
Policyholders
A policyholder is the entity (individual or corporate) that holds an insurance policy. You must create a policyholder before issuing any policy. The returned id is used in all subsequent API calls.
Quotation Inquiry
A quotation enables you to obtain quick premium estimates on products from partner insurers. This lets you check premiums before committing to a policy. Quotations can be created for motor, travel, life, and general insurance.
Policy Generation
Policy generation is the process of converting a quotation into an active insurance policy. The workflow is:
- Create a policyholder
- Browse available products
- Generate a quotation
- Pay the premium
- Issue the policy
Some endpoints support instant issue — combining quotation, payment, and policy issuance in one step.
Payments
Payment processing enables premium payments for policies. Supported payment methods:
- Mobile Money — Airtel Money, MTN Mobile Money, Zamtel Kwacha
- Card — Visa and Mastercard
- Mobile Banking — Local banking platforms
Pagination
List endpoints return paginated results. Use PageNumber and PageSize query parameters to navigate pages. Responses include totalItems, pageSize, pageNumber, and totalPages.
Documents
After issuing a policy, you can download:
- Policy Schedule — Detailed policy terms
- Insurance Certificate — Proof of insurance
- Payment Receipt — Proof of premium payment