Inshuwa Partner API
Insurance platform API for partners to manage clients, create quotations, process payments, and manage policies.
Authentication
All requests require a Bearer token (API key) in the Authorization header:
Authorization: Bearer <your-api-key>
Integration Flow
- Create a client — register individual or corporate policy holders
- Register vehicles (motor only) — associate vehicles with the client
- Browse products — find available insurance products for your partner account
- Create a quotation — get a draft policy with computed premiums
- Process payment — call
POST /payments/{quoteId}/paywith payment details - Track status — poll
GET /payments/transactions/{reference}/statusor wait for webhook - Download documents — certificates, schedules, receipts
Payment Methods
| Method | How to use |
|---|---|
| Mobile Money | Set payment.mobileMoneyAccountNumber to a Zambian phone (e.g. 0971234567) |
| Card | Set payment.cardDetails with billing address — response includes redirectUrl |
| PayLater | Omit payment object (partner must be pre-configured) |
| External | Partner settles outside the platform |
Webhooks
Configure a paymentCallbackUrl on your partner profile to receive POST notifications when payments complete.
IDs
All IDs in the API are hashed strings (e.g. kBX17BJ2). Use them as-is in route parameters and request bodies.
Contact
Servers
https://partner-dev-api.inshuwa.com/api/v1Development server
Get all individuals
GET
/policyholders/individuals
Returns a paginated list of individual clients registered under your partner account.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
Query
Type
string
FirstName
Type
string
LastName
Type
string
IdNumber
Type
string
PhoneNumber
Type
string
Email
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Paginated list of individuals
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ ]
{
}
Create Individual
POST
/policyholders/individuals
Register a new individual client (policyholder). Required fields: firstName, lastName, phoneNumber, email, idNumber, idType. The returned id is used when creating quotations.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "email": "string", "phoneNumber": "26021312312", "physicalAddress": "string", "firstName": "string", "lastName": "string", "idNumber": "string", "gender": "string", "idType": "string"
{
}
Responses
Individual policyholder created
application/json
JSON "id": "string", "email": "string", "phoneNumber": "string", "physicalAddress": "string", "firstName": "string", "lastName": "string", "idNumber": "string", "idType": "string", "gender": "string", "type": "string", "status": "string", "createdAt": "string", "updatedAt": "string"
{
}
Get individual by ID
GET
/policyholders/{id}/individuals
Returns a single individual client by hashed ID.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Responses
Individual policyholder
application/json
JSON "id": "string", "email": "string", "phoneNumber": "string", "physicalAddress": "string", "firstName": "string", "lastName": "string", "idNumber": "string", "idType": "string", "gender": "string", "type": "string", "status": "string", "createdAt": "string", "updatedAt": "string"
{
}
Update individual policy holder
PUT
/policyholders/{id}/individuals
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Request Body
application/json
JSON "firstName": "string", "lastName": "string", "idNumber": "string", "email": "string", "phoneNumber": "string", "physicalAddress": "string", "gender": "string", "bankDetail": { "name": "string", "branch": "string", "accountNumber": "string", "swiftCode": "string", "accountName": "string" }, "taxPayerId": "string", "dateOfBirth": "string"
{
}
Responses
Success
application/json
JSON "id": "string", "createdAt": "string", "updatedAt": "string", "email": "string", "phoneNumber": "string", "physicalAddress": "string", "type": "string", "status": "string", "taxPayerId": "string", "dateOfBirth": "string", "farms": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "clientId": "string", "client": { "id": { }, "createdAt": { }, "updatedAt": { }, "email": { }, "phoneNumber": { }, "physicalAddress": { }, "type": { }, "status": { }, "taxPayerId": { }, "dateOfBirth": { }, "farms": { } }, "administrativeAreaId": "string", "camp": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "level": { }, "parentId": { }, "parent": { }, "children": { }, "province": { }, "provinceId": { } } } ], "firstName": "string", "lastName": "string", "idNumber": "string", "idType": "string", "gender": "string", "bankDetail": { "name": "string", "branch": "string", "accountNumber": "string", "swiftCode": "string", "accountName": "string" }, "user": { "createdAt": "string", "updateAt": "string", "branch": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "insurerId": 0, "intermediaryId": 0, "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } } }, "status": "string", "twoFactorEnabled": true, "email": "string", "phoneNumber": "string", "lastSeen": "string" }, "intermediaryId": 0, "partnerId": 0
{
}
Get all corporates
GET
/policyholders/corporates
Returns a paginated list of corporate clients registered under your partner account.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
Query
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Paginated list of corporates
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ ]
{
}
Create Corporate
POST
/policyholders/corporates
Register a new corporate client (policyholder). Required fields: name, email, phoneNumber, taxPayerId (TPIN). The returned id is used when creating quotations.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "name": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "registrationNumber": "string", "sector": "string", "phoneNumber": "string", "email": "string", "postalAddress": "string", "physicalAddress": "string", "taxPayerId": "string"
{
}
Responses
Corporate policyholder created
application/json
JSON "id": "string", "email": "string", "phoneNumber": "string", "physicalAddress": "string", "name": "string", "taxPayerId": "string", "postalAddress": "string", "registrationNumber": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "type": "string", "status": "string", "createdAt": "string"
{
}
Get corporate by ID
GET
/policyholders/{id}/corporates
Returns a single corporate client by hashed ID.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Responses
Corporate policyholder
application/json
JSON "id": "string", "email": "string", "phoneNumber": "string", "physicalAddress": "string", "name": "string", "taxPayerId": "string", "postalAddress": "string", "registrationNumber": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "type": "string", "status": "string", "createdAt": "string"
{
}
Update corporate policy holder
PUT
/policyholders/{id}/corporates
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Request Body
application/json
JSON "name": "string", "taxPayerId": "string", "email": "string", "phoneNumber": "string", "address": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "physicalAddress": "string", "postalAddress": "string", "sector": "string", "registrationNumber": "string", "bankDetail": { "name": "string", "branch": "string", "accountNumber": "string", "swiftCode": "string", "accountName": "string" }
{
}
Responses
Success
application/json
JSON "id": "string", "createdAt": "string", "updatedAt": "string", "email": "string", "phoneNumber": "string", "physicalAddress": "string", "type": "string", "status": "string", "dateOfBirth": "string", "farms": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "clientId": "string", "client": { "id": { }, "createdAt": { }, "updatedAt": { }, "email": { }, "phoneNumber": { }, "physicalAddress": { }, "type": { }, "status": { }, "taxPayerId": { }, "dateOfBirth": { }, "farms": { } }, "administrativeAreaId": "string", "camp": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "level": { }, "parentId": { }, "parent": { }, "children": { }, "province": { }, "provinceId": { } } } ], "name": "string", "taxPayerId": "string", "contactPerson": "string", "sector": "string", "postalAddress": "string", "contactPersonPhoneNumber": "string", "registrationNumber": "string", "bankDetail": { "name": "string", "branch": "string", "accountNumber": "string", "swiftCode": "string", "accountName": "string" }
{
}
Get client vehicles
GET
/policyholders/{id}/vehicles
Returns all vehicles registered under a client.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Query Parameters
Status
Type
string
Valid values
"HasPolicy""NoPolicy"PageNumber
Type
integer
PageSize
Type
integer
Responses
List of vehicles
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ ]
{
}
Create vehicle
POST
/policyholders/{id}/vehicles
Register a new vehicle for a client. Required fields: make, model, yearOfManufacture, registrationNumber, chassisNumber, engineNumber, motorRiskCategoryId.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Client ID
Type
Requiredstring
Request Body
application/json
JSON { "make": "Toyota", "model": "Hilux", "yearOfManufacture": 2020, "capacity": 1950, "tonnage": 0, "seatingCapacity": 5, "photosUrls": [ "string" ], "registrationNumber": "BCC1234", "chassisNumber": "string", "engineNumber": "string", "color": "string", "sumInsured": 0, "motorRiskCategoryId": "string", "riskCategoryName": "Private Car" }
[
]
Responses
Vehicle created
application/json
JSON "id": "string", "make": "string", "model": "string", "yearOfManufacture": 0, "registrationNumber": "string", "chassisNumber": "string", "engineNumber": "string", "capacity": 0, "tonnage": 0, "seatingCapacity": 0, "sumInsured": 0, "color": "string", "photosUrls": [ "string" ]
{
}
Search for vehicle by registration number
GET
/policyholders/vehicles/search
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
RegNumber
Type
string
ClientId
Type
integer
Responses
Success
application/json
JSON "make": "string", "model": "string", "yearOfManufacture": 0, "registrationNumber": "string", "chassisNumber": "string", "engineNumber": "string", "tonnage": 0, "seatingCapacity": 0, "color": "string", "sumInsured": 0, "capacity": 0, "motorBodyTypeId": 0, "id": 0, "motorBodyType": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "iconUrl": "string", "type": "string", "imageUrl": "string" }, "riskCategoryId": 0, "riskCategory": { "id": 0, "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "iconUrl": "string", "insurerId": 0, "insurer": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "taxPayerId": "string", "logoUrl": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "email": "string", "popularity": 0, "insurerType": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "claims": { }, "logins": { }, "tokens": { }, "createdAt": { }, "updateAt": { }, "branch": { }, "branchId": { }, "status": { }, "lastSeen": { }, "twoFactorMethod": { } }, "bankId": 0, "bank": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "swiftCode": { }, "branches": { } }, "status": "string", "shortName": "string" } }, "currentLicenseExpiryDate": "string", "roadWorthinessExpiryDate": "string", "firstRegDate": "string", "registrationStatus": "string"
{
}
Get RTSA anniversary dates for a vehicle
Get insurance status for a vehicle
GET
/policyholders/vehicles/insurance-status
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
regNumber
Type
string
Responses
Success
application/json
JSON "insuranceType": "string", "status": "string", "dateFrom": "string", "dateTo": "string", "insuranceCompany": "string", "insurancePolicyNo": "string", "quarter": 0, "chassisNumber": "string"
{
}
Get all products
GET
/products
Returns a paginated list of all insurance products available to your partner account, across all lines of business (motor, travel, general, life). Use the returned product id when creating quotations.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
Query
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Paginated list of products
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ ]
{
}
Get all motor products
GET
/products/motor
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": 0, "createdAt": "string", "updatedAt": "string", "productType": "string", "policyClauses": [ { } ], "documents": [ { } ], "insurer": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "shortName": { }, "logoUrl": { }, "address": { }, "email": { }, "externalInsurerId": { } }, "durationType": "string" } ]
{
}
Get all travel products
GET
/products/travel
Authorizations
BearerAuth
Type
HTTP (bearer)
Responses
Success
application/json
JSON "id": 0, "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "insurer": "string", "insurerLogoUrl": "string", "commissionRate": 0, "packages": [ { "id": 0, "createdAt": "string", "updatedAt": "string", "name": "string", "duration": 0, "durationType": "string", "coverType": "string", "premium": 0, "premiumType": "string", "description": "string", "maxDependants": 0, "minDependants": 0, "dependents": [ { } ], "benefits": [ { } ] } ]
{
}
Get all life products
Get life product by ID
Get motor product by id
GET
/products/motor/{productId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
productId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": 0, "createdAt": "string", "updatedAt": "string", "productType": "string", "policyClauses": [ "string" ], "documents": [ { "id": 0, "createdAt": "string", "updatedAt": "string", "riskCategoryId": 0, "productId": "string", "url": "string", "name": "string" } ], "insurer": { "id": 0, "createdAt": "string", "updatedAt": "string", "name": "string", "shortName": "string", "logoUrl": "string", "address": { "country": "string", "province": "string", "district": "string", "street": "string", "plotNo": "string" }, "email": "string", "externalInsurerId": "string" }, "durationType": "string"
{
}
Get travel product by id
GET
/products/travel/{productId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
productId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": 0, "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "insurer": "string", "insurerLogoUrl": "string", "commissionRate": 0, "packages": [ { "id": 0, "createdAt": "string", "updatedAt": "string", "name": "string", "duration": 0, "durationType": "string", "coverType": "string", "premium": 0, "premiumType": "string", "description": "string", "maxDependants": 0, "minDependants": 0, "dependents": [ { } ], "benefits": [ { } ] } ]
{
}
Motor quotation inquiry
POST
/quotations/motor/inquiry
Generate a premium estimate for a motor policy without creating a draft quotation. No quotation is persisted. Useful for showing the customer a price before committing.
Required fields: productId, duration, currency, startDate, policyHolder, risks (with motorRiskCategoryId, registration info, and sumInsured for comprehensive cover).
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "productId": "bdV7p1XW", "currency": "ZMW", "duration": 0, "startDate": "2024-12-01", "policyHolder": { "type": "Individual", "name": "John Banda", "phone": "260971234567", "email": "string", "physicalAddress": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string" }, "risks": [ { "make": "Toyota", "model": "Hilux", "yearOfManufacture": 2022, "capacity": 1955, "tonnage": 0, "seatingCapacity": 5, "photosUrls": [ "string" ], "registrationNumber": "ABC1234", "chassisNumber": "string", "engineNumber": "string", "sumInsured": 100000, "currency": "ZMW", "color": "string", "motorRiskCategoryId": "RWMmOVm9", "motorBodyTypeId": "string" } ], "reference": "string"
{
}
Responses
Quotation inquiry result
application/json
JSON
{
}
Motor quotation comparison
POST
/quotations/motor/comparison
Compare premiums across multiple motor insurance products for the same vehicle and coverage period. Returns a list of products with their computed premiums.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "productType": "string", "currency": "ZMW", "duration": 0, "startDate": "2024-12-01", "policyHolder": { "type": "Individual", "name": "John Banda", "phone": "260971234567", "email": "string", "physicalAddress": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string" }, "risks": [ { "make": "Toyota", "model": "Hilux", "yearOfManufacture": 2022, "capacity": 1955, "tonnage": 0, "seatingCapacity": 5, "photosUrls": [ "string" ], "registrationNumber": "ABC1234", "chassisNumber": "string", "engineNumber": "string", "sumInsured": 100000, "currency": "ZMW", "color": "string", "motorRiskCategoryId": "RWMmOVm9", "motorBodyTypeId": "string" } ]
{
}
Responses
Comparison results
application/json
JSON { }
[
]
Get motor quotations
GET
/quotations/motor
Returns a paginated list of motor quotations.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
StartDate
Type
string
Format
"date-time"EndDate
Type
string
Format
"date-time"ClientId
Type
string
Query
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Paginated list of motor quotations
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ ]
{
}
Create motor quotation
POST
/quotations/motor
Create a formal motor insurance quotation for a registered client with existing registered vehicles. Returns a quoteId used to issue a policy via POST /payments/{quoteId}/pay.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "productId": "kBX1xV2Y", "duration": 0, "currency": "ZMW", "startDate": "string", "clientId": "mDJkrrMR", "risks": [ { "vehicleId": "GYJg9DXx", "sumInsured": 10000, "photosUrls": [ "string" ] } ]
{
}
Responses
Motor quotation created
application/json
JSON "id": "string", "premium": 0, "status": "string"
{
}
Get motor pricing for a risk category
POST
/pricing/motor
Returns available pricing options for the given product and risk category. startDate defaults to today. endDate is optional but required for Comprehensive/TPFT products.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "productId": "string", "riskCategoryId": "string", "startDate": "string", "endDate": "string", "sumInsured": 0
{
}
Responses
Success
application/json
JSON "productId": "string", "productName": "string", "productType": "string", "durationType": "string", "pricingOptions": [ { "duration": 0, "label": "string", "basicPremium": 0, "levyPremium": 0, "grossPremium": 0, "currency": "string", "startDate": "string", "endDate": "string" } ]
{
}
Motor Policies
Motor insurance policy management
Operations
POST/policies/motor/{quoteId}/issuePOST/policies/motor/instant/issuePOST/policies/motor/instant/issue/payPOST/policies/motor/{policyId}/renewPOST/policies/motor/{policyId}/renew/payPOST/policies/motor/{policyId}/extendPOST/policies/motor/{policyId}/extend/payGET/policies/motorGET/policies/motor/risk-categoriesGET/policies/motor/vehicle/{registrationNumber}GET/policies/motor/{id}/documents/scheduleGET/policies/motor/{id}/documents/certificateGET/policies/motor/{id}/documents/receiptGET/policies/motor/{id}POST/policies/motor/{id}/extension/premiumsPOST/policies/motor/{id}/renew/premiums
Issue motor policy
Instant issue motor policy (no payment)
POST
/policies/motor/instant/issue
Create and issue a motor policy in a single step without initiating payment. Use this for PayLater (partner pre-configured for deferred billing) or external settlement (payment collected outside the platform).
Provide the product, client (policyHolder), vehicles (risks), and a reference for reconciliation.
Use /policies/motor/instant/issue/pay instead if you want to initiate payment in the same call.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "productId": "qkVe0kJo", "duration": 0, "currency": "ZMW", "startDate": "string", "policyHolder": { "type": "Individual", "name": "John Banda", "phone": "260971234567", "email": "string", "physicalAddress": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string" }, "risks": [ { "make": "Toyota", "model": "Hilux", "yearOfManufacture": 2022, "capacity": 1955, "tonnage": 0, "seatingCapacity": 5, "photosUrls": [ "string" ], "registrationNumber": "ABC1234", "chassisNumber": "string", "engineNumber": "string", "sumInsured": 100000, "currency": "ZMW", "color": "string", "motorRiskCategoryId": "RWMmOVm9", "motorBodyTypeId": "string" } ], "reference": "string"
{
}
Responses
Motor policy issued instantly
application/json
JSON
{
}
Instant issue and pay motor policy
POST
/policies/motor/instant/issue/pay
Create, issue, and initiate payment for a motor policy in a single step.
Payment options:
- Mobile money: set
payment.mobileMoneyAccountNumber - Card: set
payment.cardDetails— response includesredirectUrlto complete 3DS
The reference field is your unique transaction reference for reconciliation.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "productId": "qkVe0kJo", "duration": 0, "currency": "ZMW", "startDate": "string", "policyHolder": { "type": "Individual", "name": "John Banda", "phone": "260971234567", "email": "string", "physicalAddress": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string" }, "risks": [ { "make": "Toyota", "model": "Hilux", "yearOfManufacture": 2022, "capacity": 1955, "tonnage": 0, "seatingCapacity": 5, "photosUrls": [ "string" ], "registrationNumber": "ABC1234", "chassisNumber": "string", "engineNumber": "string", "sumInsured": 100000, "currency": "ZMW", "color": "string", "motorRiskCategoryId": "RWMmOVm9", "motorBodyTypeId": "string" } ], "reference": "PARTNER-REF-001", "payment": { "method": "string", "mobileMoneyAccountNumber": "0971234567", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }, "gateway": "Airtel" }
{
}
Responses
Motor policy issued and paid
application/json
JSON
{
}
Renew motor policy
Renew and pay motor policy
POST
/policies/motor/{policyId}/renew/pay
Renew and pay for a motor insurance policy in a single step.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "duration": 0, "startDate": "string", "reference": "partner-ref-001", "payment": { "method": "string", "mobileMoneyAccountNumber": "0971234567", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }, "gateway": "Airtel" }
{
}
Responses
Motor policy renewed and paid
application/json
JSON
{
}
Extend motor policy
Extend and pay motor policy
POST
/policies/motor/{policyId}/extend/pay
Extend and pay for a motor insurance policy in a single step.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "reference": "partner-ref-001", "payment": { "method": "string", "mobileMoneyAccountNumber": "0971234567", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }, "gateway": "Airtel" }
{
}
Responses
Motor policy extended and paid
application/json
JSON
{
}
Get motor policies
GET
/policies/motor
Returns a paginated list of motor insurance policies.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
Statuses
Type
array
StartDate
Type
string
Format
"date-time"EndDate
Type
string
Format
"date-time"ClientId
Type
string
Query
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Paginated list of motor policies
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ ]
{
}
Get motor risk categories
Get policy by vehicle registration
Get policy schedule document
Get insurance certificate
Get payment receipt
Get motor policy by id
GET
/policies/motor/{id}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "createdAt": "string", "updatedAt": "string", "policyNumber": "string", "status": "string", "approvedDate": "string", "startDate": "string", "endDate": "string", "extensionsPremium": 0, "discountsPremium": 0, "premiumLevy": 0, "basicPremium": 0, "grossPremium": 0, "currency": "string", "duration": 0, "risks": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "sumInsured": 0, "premiumLevy": 0, "extensionsPremium": 0, "discountsPremium": 0, "limitsOfLiabilitiesPremium": 0, "basicPremium": 0, "grossPremium": 0, "vehicle": { "id": { }, "createdAt": { }, "updatedAt": { }, "make": { }, "model": { }, "yearOfManufacture": { }, "registrationNumber": { }, "chassisNumber": { }, "engineNumber": { }, "sumInsured": { }, "currency": { }, "capacity": { }, "tonnage": { }, "seatingCapacity": { }, "color": { }, "status": { } }, "photosUrls": [ { } ] } ], "intermediary": { "id": "string", "name": "string", "logoUrl": "string", "taxPayerId": "string", "email": "string", "address": { "country": "string", "province": "string", "district": "string", "street": "string", "plotNo": "string" }, "bankDetail": { "name": "string", "branch": "string", "accountNumber": "string", "swiftCode": "string", "accountName": "string" }, "type": "string", "paymentMethods": [ "string" ], "systemPermissions": [ { "insurerId": { }, "canEditPolicyDates": { }, "canEditPolicyVehicleDetails": { }, "canChangeThirdPartyLimits": { }, "canIssueComprehensiveNoPhotos": { }, "canOverridePremium": { }, "canDoManualRtsaUpload": { }, "canExemptCommissionWithdrawalTax": { }, "canWithdrawCommission": { }, "canWithdrawDigitalPaymentOnly": { } } ], "district": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "level": "string", "provinceId": 0 }, "insurerCodes": [ { "insurerId": { }, "code": { } } ] }, "client": { "id": "string", "createdAt": "string", "updatedAt": "string", "email": "string", "phoneNumber": "string", "physicalAddress": "string", "type": "string", "status": "string", "taxPayerId": "string", "dateOfBirth": "string", "farms": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "clientId": { }, "client": { }, "administrativeAreaId": { }, "camp": { } } ], "name": "string", "identificationNumber": "string" }, "insurer": { "id": "string", "createdAt": "string", "updatedAt": "string", "logoUrl": "string", "insurerType": "string", "name": "string", "shortName": "string", "address": { "country": "string", "province": "string", "district": "string", "street": "string", "plotNo": "string" }, "email": "string", "status": "string", "settings": { "id": "string", "createdAt": "string", "updatedAt": "string", "enableSelfCommissionSettlement": true, "enableDirectWalletTransfer": true, "waiveDirectBusinessFee": true, "commissionConfig": { "enableCommissionWithdrawal": { }, "windows": { }, "withholdCommissionSettlement": { } }, "insurerId": "string", "rtsaUsername": "string", "rtsaPassword": "string", "smsOriginatorId": "string", "airtelMoney": { "host": { }, "grantType": { }, "clientId": { }, "clientSecret": { }, "version": { } }, "mtnMoney": { "host": { }, "targetEnvironment": { }, "collectionsApiUserId": { }, "collectionsApiKey": { }, "collectionsSubscriptionKey": { }, "callbackUrl": { } }, "policyPeriod": { "maxPolicyPeriodDays": { }, "maxPolicyExtensionDays": { }, "maxPolicyPeriodAfterExtensionDays": { }, "renewalWindowDays": { }, "maxFutureStartDays": { } }, "quotationValidityDuration": 0, "quotationValidityDurationType": "string" } }, "product": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "code": "string", "source": "string", "partnerId": 0, "partner": { "id": "string", "name": "string", "email": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "paymentMethods": [ { } ] }, "insurer": { "id": "string", "createdAt": "string", "updatedAt": "string", "logoUrl": "string", "insurerType": "string", "name": "string", "shortName": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "email": "string", "status": "string", "settings": { "id": { }, "createdAt": { }, "updatedAt": { }, "enableSelfCommissionSettlement": { }, "enableDirectWalletTransfer": { }, "waiveDirectBusinessFee": { }, "commissionConfig": { }, "insurerId": { }, "rtsaUsername": { }, "rtsaPassword": { }, "smsOriginatorId": { }, "airtelMoney": { }, "mtnMoney": { }, "policyPeriod": { }, "quotationValidityDuration": { }, "quotationValidityDurationType": { } } }, "classOfBusiness": { "id": "string", "name": "string", "order": 0 }, "category": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "isActive": true, "classOfBusinessId": "string", "classOfBusinessName": "string" }, "productCategoryName": "string", "paymentMethods": [ "string" ], "codeRules": [ { "clientType": { }, "riskCategoryId": { }, "code": { } } ] }, "clauses": [ "string" ], "durationType": "string", "limitsOfLiabilitiesPremium": 0
{
}
Get motor policy extension premiums
POST
/policies/motor/{id}/extension/premiums
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Request Body
application/json
JSON "duration": 0, "quarters": 0, "startDate": "string", "endDate": "string"
{
}
Responses
Success
application/json
JSON "premiumLevy": 0, "basicPremium": 0, "grossPremium": 0, "startDate": "string", "endDate": "string"
{
}
Get motor policy renewal premiums
POST
/policies/motor/{id}/renew/premiums
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Request Body
application/json
JSON "duration": 0, "quarters": 0, "startDate": "string", "endDate": "string"
{
}
Responses
Success
application/json
JSON "premiumLevy": 0, "basicPremium": 0, "grossPremium": 0, "startDate": "string", "endDate": "string"
{
}
Get all travel quotations
GET
/quotations/travel
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
Statuses
Type
array
PremiumStatuses
Type
array
CancellationStatuses
Type
array
StartDate
Type
string
EndDate
Type
string
InsurerId
Type
integer
IntermediaryId
Type
integer
PartnerId
Type
integer
DebitNoteStatus
Type
string
ClassOfBusinessId
Type
integer
ClientId
Type
integer
Query
Type
string
BranchId
Type
integer
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string", "destination": "string", "policyHolder": { "clientType": { }, "name": { }, "dateOfBirth": { }, "phone": { }, "contactPerson": { }, "contactPersonPhoneNumber": { }, "email": { }, "physicalAddress": { }, "postalAddress": { }, "registrationNumber": { }, "idType": { }, "idNumber": { }, "tpinNumber": { }, "sector": { } }, "package": { "id": { }, "name": { }, "duration": { }, "durationType": { }, "coverType": { }, "premium": { }, "premiumType": { }, "description": { }, "externalReference": { }, "benefits": { }, "premiumRates": { } }, "beneficiaries": [ { } ] } ]
{
}
Generate quotation for travel policy
POST
/quotations/travel
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "packageId": "string", "clientId": "string", "destination": "string", "startDate": "string", "policyHolder": { "clientType": "string", "name": "string", "dateOfBirth": "string", "phone": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "email": "string", "physicalAddress": "string", "postalAddress": "string", "registrationNumber": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string", "sector": "string" }, "beneficiaries": [ { "firstName": "string", "lastName": "string", "relationship": "string", "idNumber": "string", "idType": "string", "phoneNumber": "string", "email": "string", "dateOfBirth": "string", "gender": "string", "dependantType": "string", "isNextOfKin": true } ]
{
}
Responses
Success
application/json
JSON "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string", "destination": "string", "policyHolder": { "clientType": "string", "name": "string", "dateOfBirth": "string", "phone": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "email": "string", "physicalAddress": "string", "postalAddress": "string", "registrationNumber": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string", "sector": "string" }, "package": { "id": "string", "name": "string", "duration": 0, "durationType": "string", "coverType": "string", "premium": 0, "premiumType": "string", "description": "string", "externalReference": "string", "benefits": [ { "sumAssured": { }, "name": { }, "description": { } } ], "premiumRates": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "min": { }, "max": { }, "value": { }, "addonType": { }, "name": { }, "categoryType": { } } ] }, "beneficiaries": [ { "firstName": "string", "lastName": "string", "email": "string", "phoneNumber": "string", "idNumber": "string" } ]
{
}
Get travel quotation by ID
Renew travel policy using payment gateway
POST
/policies/travel/{policyId}/renew/pay
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "startDate": "string", "endDate": "string", "destination": "string", "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }, "reference": "string"
{
}
Responses
Success
application/json
JSON "status": "string", "message": "string", "txnId": "string", "policy": { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string" }
{
}
Get all travel policies
GET
/policies/travel
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
Statuses
Type
array
PremiumStatuses
Type
array
CancellationStatuses
Type
array
StartDate
Type
string
EndDate
Type
string
InsurerId
Type
integer
IntermediaryId
Type
integer
PartnerId
Type
integer
DebitNoteStatus
Type
string
ClassOfBusinessId
Type
integer
ClientId
Type
integer
Query
Type
string
BranchId
Type
integer
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string", "destination": "string", "policyHolder": { "clientType": { }, "name": { }, "dateOfBirth": { }, "phone": { }, "contactPerson": { }, "contactPersonPhoneNumber": { }, "email": { }, "physicalAddress": { }, "postalAddress": { }, "registrationNumber": { }, "idType": { }, "idNumber": { }, "tpinNumber": { }, "sector": { } }, "package": { "id": { }, "name": { }, "duration": { }, "durationType": { }, "coverType": { }, "premium": { }, "premiumType": { }, "description": { }, "externalReference": { }, "benefits": { }, "premiumRates": { } }, "beneficiaries": [ { } ] } ]
{
}
Issue instant travel policy
POST
/policies/travel/instant-issue
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "packageId": "string", "clientId": "string", "destination": "string", "startDate": "string", "policyHolder": { "clientType": "string", "name": "string", "dateOfBirth": "string", "phone": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "email": "string", "physicalAddress": "string", "postalAddress": "string", "registrationNumber": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string", "sector": "string" }, "beneficiaries": [ { "firstName": "string", "lastName": "string", "relationship": "string", "idNumber": "string", "idType": "string", "phoneNumber": "string", "email": "string", "dateOfBirth": "string", "gender": "string", "dependantType": "string", "isNextOfKin": true } ], "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }, "reference": "string"
{
}
Responses
Success
application/json
JSON "status": "string", "message": "string", "txnId": "string", "policy": { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string" }
{
}
Get travel policy by Id
GET
/policies/travel/{policyId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string", "destination": "string", "policyHolder": { "clientType": "string", "name": "string", "dateOfBirth": "string", "phone": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "email": "string", "physicalAddress": "string", "postalAddress": "string", "registrationNumber": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string", "sector": "string" }, "package": { "id": "string", "name": "string", "duration": 0, "durationType": "string", "coverType": "string", "premium": 0, "premiumType": "string", "description": "string", "externalReference": "string", "benefits": [ { "sumAssured": { }, "name": { }, "description": { } } ], "premiumRates": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "min": { }, "max": { }, "value": { }, "addonType": { }, "name": { }, "categoryType": { } } ] }, "beneficiaries": [ { "firstName": "string", "lastName": "string", "email": "string", "phoneNumber": "string", "idNumber": "string" } ]
{
}
Generate travel policy certificate
Issue travel policy
POST
/policies/travel/{quoteId}/issue
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
quoteId*
Type
Requiredstring
Request Body
application/json
JSON "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }, "reference": "string"
{
}
Responses
Success
application/json
JSON "status": "string", "message": "string", "txnId": "string", "policy": { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string" }
{
}
Get life quotations
Create life quotation
POST
/quotations/life
Create a life insurance quotation. Returns a quoteId used to issue a policy.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "startDate": "string", "packageId": "string", "clientId": "string", "policyHolder": { "clientType": "Individual", "name": "John Banda", "dateOfBirth": "1990-01-15", "phone": "260971234567", "email": "string", "physicalAddress": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string" }, "nextOfKin": { "firstName": "string", "lastName": "string", "relationship": "Spouse", "idNumber": "string", "idType": "string", "phoneNumber": "string", "email": "string", "dateOfBirth": "string" }, "beneficiaries": [ { "firstName": "string", "lastName": "string", "relationship": "Spouse", "idNumber": "string", "idType": "string", "phoneNumber": "string", "email": "string", "dateOfBirth": "string" } ], "beneficiaryAddonAmmount": 0
{
}
Responses
Life quotation created
application/json
JSON
{
}
Get life quotation by ID
Renew life policy using payment gateway
POST
/policies/life/{quoteId}/renew/pay
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
quoteId*
Type
Requiredstring
Request Body
application/json
JSON "startDate": "string", "endDate": "string", "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }, "reference": "string"
{
}
Responses
Success
application/json
JSON "status": "string", "message": "string", "txnId": "string", "policy": { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string" }
{
}
Get all life policies
GET
/policies/life
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
Statuses
Type
array
PremiumStatuses
Type
array
CancellationStatuses
Type
array
StartDate
Type
string
EndDate
Type
string
InsurerId
Type
integer
IntermediaryId
Type
integer
PartnerId
Type
integer
DebitNoteStatus
Type
string
ClassOfBusinessId
Type
integer
ClientId
Type
integer
Query
Type
string
BranchId
Type
integer
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string", "package": { "id": { }, "name": { }, "duration": { }, "durationType": { }, "coverType": { }, "premium": { }, "premiumType": { }, "description": { }, "externalReference": { }, "benefits": { }, "premiumRates": { } }, "policyHolder": { "clientType": { }, "name": { }, "dateOfBirth": { }, "phone": { }, "contactPerson": { }, "contactPersonPhoneNumber": { }, "email": { }, "physicalAddress": { }, "postalAddress": { }, "registrationNumber": { }, "idType": { }, "idNumber": { }, "tpinNumber": { }, "sector": { } }, "nextOfKin": { "firstName": { }, "lastName": { }, "relationship": { }, "idNumber": { }, "phoneNumber": { }, "dateOfBirth": { } }, "paidThroughDate": "string" } ]
{
}
Issue instant life policy
POST
/policies/life/instant-issue
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "startDate": "string", "packageId": "string", "clientId": "string", "policyHolder": { "clientType": "string", "name": "string", "dateOfBirth": "string", "phone": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "email": "string", "physicalAddress": "string", "postalAddress": "string", "registrationNumber": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string", "sector": "string" }, "nextOfKin": { "firstName": "string", "lastName": "string", "relationship": "string", "idNumber": "string", "idType": "string", "phoneNumber": "string", "email": "string", "dateOfBirth": "string", "gender": "string", "dependantType": "string", "isNextOfKin": true }, "beneficiaries": [ { "firstName": "string", "lastName": "string", "relationship": "string", "idNumber": "string", "idType": "string", "phoneNumber": "string", "email": "string", "dateOfBirth": "string", "gender": "string", "dependantType": "string", "isNextOfKin": true } ], "beneficiaryAddonAmount": 0, "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }, "reference": "string"
{
}
Responses
Success
application/json
JSON "status": "string", "message": "string", "txnId": "string", "policy": { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string" }
{
}
Get life policy by id
GET
/policies/life/{policyId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string", "package": { "id": "string", "name": "string", "duration": 0, "durationType": "string", "coverType": "string", "premium": 0, "premiumType": "string", "description": "string", "externalReference": "string", "benefits": [ { "sumAssured": { }, "name": { }, "description": { } } ], "premiumRates": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "min": { }, "max": { }, "value": { }, "addonType": { }, "name": { }, "categoryType": { } } ] }, "policyHolder": { "clientType": "string", "name": "string", "dateOfBirth": "string", "phone": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "email": "string", "physicalAddress": "string", "postalAddress": "string", "registrationNumber": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string", "sector": "string" }, "nextOfKin": { "firstName": "string", "lastName": "string", "relationship": "string", "idNumber": "string", "phoneNumber": "string", "dateOfBirth": "string" }, "paidThroughDate": "string"
{
}
Generate life policy certificate
Issue life policy
POST
/policies/life/{quoteId}/issue
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
quoteId*
Type
Requiredstring
Request Body
application/json
JSON "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }, "reference": "string"
{
}
Responses
Success
application/json
JSON "status": "string", "message": "string", "txnId": "string", "policy": { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string" }
{
}
Extend general policy
POST
/policies/{policyId}/issue
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "endDate": "string"
{
}
Responses
Success
application/json
JSON "id": "string", "createdAt": "string", "updatedAt": "string", "policyNumber": "string", "status": "string", "premiumStatus": "string", "approvedDate": "string", "startDate": "string", "endDate": "string", "client": { "id": "string", "createdAt": "string", "updatedAt": "string", "email": "string", "phoneNumber": "string", "physicalAddress": "string", "type": "string", "status": "string", "taxPayerId": "string", "dateOfBirth": "string", "farms": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "clientId": { }, "client": { }, "administrativeAreaId": { }, "camp": { } } ], "name": "string", "identificationNumber": "string" }, "product": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "code": "string", "source": "string", "partnerId": 0, "partner": { "id": "string", "name": "string", "email": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "paymentMethods": [ { } ] }, "insurer": { "id": "string", "createdAt": "string", "updatedAt": "string", "logoUrl": "string", "insurerType": "string", "name": "string", "shortName": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "email": "string", "status": "string", "settings": { "id": { }, "createdAt": { }, "updatedAt": { }, "enableSelfCommissionSettlement": { }, "enableDirectWalletTransfer": { }, "waiveDirectBusinessFee": { }, "commissionConfig": { }, "insurerId": { }, "rtsaUsername": { }, "rtsaPassword": { }, "smsOriginatorId": { }, "airtelMoney": { }, "mtnMoney": { }, "policyPeriod": { }, "quotationValidityDuration": { }, "quotationValidityDurationType": { } } }, "classOfBusiness": { "id": "string", "name": "string", "order": 0 }, "category": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "isActive": true, "classOfBusinessId": "string", "classOfBusinessName": "string" }, "productCategoryName": "string", "paymentMethods": [ "string" ], "codeRules": [ { "clientType": { }, "riskCategoryId": { }, "code": { } } ] }, "premiumLevy": 0, "basicPremium": 0, "grossPremium": 0, "currency": "string", "insurer": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string" }, "risks": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "riskId": "string", "description": "string", "location": "string", "sumInsured": 0, "sumInsuredDescription": "string", "coveredItems": [ { } ], "premiumLevy": 0, "basicPremium": 0, "grossPremium": 0, "extensionsPremium": 0, "discountsPremium": 0, "premiumRate": 0, "extensions": [ { } ], "discounts": [ { } ] } ], "riskId": "string", "territorialLimits": [ "string" ], "clauses": [ "string" ], "policyHolder": { "clientType": "string", "name": "string", "dateOfBirth": "string", "phone": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "email": "string", "physicalAddress": "string", "postalAddress": "string", "registrationNumber": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string", "sector": "string" }
{
}
Renew general policy
POST
/policies/{policyId}/renew
Renew an existing general insurance policy.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "startDate": "string", "endDate": "string"
{
}
Responses
General policy renewed
application/json
JSON
{
}
Instant issue general policy
POST
/policies/instant/issue
Create and issue a general insurance policy in a single step.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "productId": "string", "currency": "ZMW", "startDate": "string", "policyHolder": { "type": "Individual", "name": "John Banda", "phone": "260971234567", "email": "string", "physicalAddress": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string" }, "risks": [ { "make": "Toyota", "model": "Hilux", "yearOfManufacture": 2022, "capacity": 1955, "tonnage": 0, "seatingCapacity": 5, "photosUrls": [ "string" ], "registrationNumber": "ABC1234", "chassisNumber": "string", "engineNumber": "string", "sumInsured": 100000, "currency": "ZMW", "color": "string", "motorRiskCategoryId": "RWMmOVm9", "motorBodyTypeId": "string" } ]
{
}
Responses
General policy issued instantly
application/json
JSON
{
}
Get all policies
GET
/policies
Returns a paginated list of all insurance policies.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
PageNumber
Type
integer
PageSize
Type
integer
Responses
Paginated list of policies
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ ]
{
}
Issue general policy
POST
/policies/{quoteId}/issue
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
quoteId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "createdAt": "string", "updatedAt": "string", "policyNumber": "string", "status": "string", "premiumStatus": "string", "approvedDate": "string", "startDate": "string", "endDate": "string", "client": { "id": "string", "createdAt": "string", "updatedAt": "string", "email": "string", "phoneNumber": "string", "physicalAddress": "string", "type": "string", "status": "string", "taxPayerId": "string", "dateOfBirth": "string", "farms": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "clientId": { }, "client": { }, "administrativeAreaId": { }, "camp": { } } ], "name": "string", "identificationNumber": "string" }, "product": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "code": "string", "source": "string", "partnerId": 0, "partner": { "id": "string", "name": "string", "email": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "paymentMethods": [ { } ] }, "insurer": { "id": "string", "createdAt": "string", "updatedAt": "string", "logoUrl": "string", "insurerType": "string", "name": "string", "shortName": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "email": "string", "status": "string", "settings": { "id": { }, "createdAt": { }, "updatedAt": { }, "enableSelfCommissionSettlement": { }, "enableDirectWalletTransfer": { }, "waiveDirectBusinessFee": { }, "commissionConfig": { }, "insurerId": { }, "rtsaUsername": { }, "rtsaPassword": { }, "smsOriginatorId": { }, "airtelMoney": { }, "mtnMoney": { }, "policyPeriod": { }, "quotationValidityDuration": { }, "quotationValidityDurationType": { } } }, "classOfBusiness": { "id": "string", "name": "string", "order": 0 }, "category": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "isActive": true, "classOfBusinessId": "string", "classOfBusinessName": "string" }, "productCategoryName": "string", "paymentMethods": [ "string" ], "codeRules": [ { "clientType": { }, "riskCategoryId": { }, "code": { } } ] }, "premiumLevy": 0, "basicPremium": 0, "grossPremium": 0, "currency": "string", "insurer": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string" }, "risks": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "riskId": "string", "description": "string", "location": "string", "sumInsured": 0, "sumInsuredDescription": "string", "coveredItems": [ { } ], "premiumLevy": 0, "basicPremium": 0, "grossPremium": 0, "extensionsPremium": 0, "discountsPremium": 0, "premiumRate": 0, "extensions": [ { } ], "discounts": [ { } ] } ], "riskId": "string", "territorialLimits": [ "string" ], "clauses": [ "string" ], "policyHolder": { "clientType": "string", "name": "string", "dateOfBirth": "string", "phone": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "email": "string", "physicalAddress": "string", "postalAddress": "string", "registrationNumber": "string", "idType": "string", "idNumber": "string", "tpinNumber": "string", "sector": "string" }
{
}
Process payment for a quotation (any product type)
POST
/payments/{quoteId}/pay
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
quoteId*
Type
Requiredstring
Request Body
application/json
JSON "reference": "string", "payment": { "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }, "gateway": "string" }
{
}
Responses
Success
application/json
JSON "status": "string", "message": "string", "txnId": "string", "policy": { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string" }
{
}
Get transaction status by reference
GET
/payments/transactions/{reference}/status
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
reference*
Type
Requiredstring
Responses
Success
application/json
JSON "policyId": "string", "reference": "string", "txnId": "string", "status": "string", "amount": 0, "currency": "string", "paymentMethod": "string", "policy": { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string" }
{
}
Get available payment gateways
Get callback delivery logs for a transaction
GET
/payments/transactions/{reference}/callbacks
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
reference*
Type
Requiredstring
Responses
Success
application/json
JSON { "id": "string", "url": "string", "status": "string", "attemptNumber": 0, "attemptedAt": "string", "responseStatusCode": 0, "errorMessage": "string", "createdAt": "string", "updatedAt": "string" }
[
]
Initiate Pula farmer premium payment
POST
/pula/farmer-payment
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "farmer_name": "string", "farmer_phone_number": "string", "reference_id": "string", "premium_amount": 0
{
}
Responses
Success
application/json
JSON "referenceId": "string", "status": "string", "lipilaTransactionId": "string", "message": "string"
{
}
Get transaction details by reference
GET
/payments/transactions/{reference}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
reference*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "policyId": "string", "reference": "string", "txnId": "string", "externalTxnId": "string", "partnerReference": "string", "status": "string", "type": "string", "amount": 0, "currency": "string", "paymentMethod": "string", "paymentGateway": "string", "narration": "string", "insuranceLevy": 0, "exchangeRate": 0, "billedAccount": "string", "callbackUrl": "string", "errorMessage": "string", "createdAt": "string", "updatedAt": "string", "policy": { "id": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "basicPremium": 0, "premiumLevy": 0, "grossPremium": 0, "currency": "string" }, "eventHistory": [ { "event": "string", "timestamp": "string", "detail": "string" } ]
{
}
Track my claims
GET
/credit-life/claims
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
Statuses
Type
array
GroupPolicyId
Type
integer
InsurerId
Type
integer
PartnerId
Type
integer
LossDateFrom
Type
string
LossDateTo
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "number": "string", "groupPolicyId": "string", "loanId": "string", "status": "string", "lossType": "string", "lossDate": "string", "payoutAmount": 0 } ]
{
}
Intimate a claim against a covered loan
POST
/credit-life/claims
Identify the loan by loanId or partnerLoanReference — not both.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "loanId": 0, "partnerLoanReference": "string", "lossDate": "string", "cause": "string", "lossType": "string", "principalRepaid": 0, "charges": 0, "funeralExpense": 0, "lateNotificationReason": "string"
{
}
Responses
An Intimated claim with the payable breakdown. Every money-moving step after this — check, approve, settle — stays with the insurer.
application/json
JSON "id": "string", "number": "string", "loanId": "string", "status": "string", "lossType": "string", "lossDate": "string", "outStandingAmount": 0, "charges": 0, "freeFuneralExpense": 0, "payableAmount": 0, "createdAt": "string"
{
}
Get a claim
GET
/credit-life/claims/{claimId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
claimId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "number": "string", "loanId": "string", "status": "string", "lossType": "string", "lossDate": "string", "outStandingAmount": 0, "charges": 0, "freeFuneralExpense": 0, "payableAmount": 0, "createdAt": "string"
{
}
Attach supporting documents to a claim
POST
/credit-life/claims/{claimId}/documents
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
claimId*
Type
Requiredstring
Request Body
application/json
JSON { "description": "string", "url": "string", "type": "string" }
[
]
Responses
Upload the files to your own storage first and post the URLs. The first upload moves the claim Intimated → Documented.
application/json
JSON "id": "string", "number": "string", "loanId": "string", "status": "string", "lossType": "string", "lossDate": "string", "outStandingAmount": 0, "charges": 0, "freeFuneralExpense": 0, "payableAmount": 0, "createdAt": "string"
{
}
Credit Life Loans
Operations
POST/credit-life/loans/early-settlementGET/credit-life/loans/{loanId}GET/credit-life/schedules/{scheduleId}POST/credit-life/schedules/{scheduleId}/payGET/credit-life/policies/{policyId}/loansPOST/credit-life/policies/{policyId}/loansPOST/credit-life/policies/{policyId}/loans/singleGET/credit-life/policies/{policyId}/schedulesPOST/credit-life/policies/{policyId}/loans/payGET/credit-life/loans/by-reference
Take loans off cover on early repayment
POST
/credit-life/loans/early-settlement
Identify each loan by loanId or partnerLoanReference — not both. No refund is given: the loan ended by repayment, not by a loss. A refund is only owed when cover ends through a claim — file an UnearnedPremium claim instead.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "loans": [ { "loanId": 0, "partnerLoanReference": "string", "repaymentDate": "string", "reason": "string" } ]
{
}
Responses
The loans come off risk immediately. Any refund is raised as a payment requisition for the insurer to approve and settle — this call moves no money.
application/json
JSON "id": "string", "number": "string", "endorsementType": "string", "endorsementStatus": "string", "endorsementAmount": 0, "lines": [ { "loanId": "string", "clientName": "string", "nrcNumber": "string", "amount": 0, "netPremium": 0, "refundAmount": 0 } ]
{
}
Get a covered loan
GET
/credit-life/loans/{loanId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
loanId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "clientName": "string", "nrcNumber": "string", "amount": 0, "coveredAmount": 0, "premiumRate": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "status": "string", "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0
{
}
Get a submission batch with its per-loan premiums
GET
/credit-life/schedules/{scheduleId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
scheduleId*
Type
Requiredstring
Responses
A batch and its loans. Read outstandingPremium to see what is still owed on cover that is already in force.
application/json
JSON "id": "string", "number": "string", "status": "string", "type": "string", "totalLoans": 0, "loanAmount": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string", "loans": [ { "id": "string", "clientName": "string", "nrcNumber": "string", "amount": 0, "coveredAmount": 0, "premiumRate": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "status": "string", "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0 } ], "skipped": [ { "nrcNumber": "string", "partnerLoanReference": "string", "existingLoanId": 0 } ]
{
}
Pay a batch's premium
POST
/credit-life/schedules/{scheduleId}/pay
Mobile money or card only. The gateway is resolved from your account — do not send one. Returns while the payment is pending; the receipt is applied on confirmation.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
scheduleId*
Type
Requiredstring
Request Body
application/json
JSON "reference": "string", "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }
{
}
Responses
Pending while the payer approves on their handset. Poll GET /payments/transactions/{reference}/status — the premium is receipted automatically once the gateway confirms, not here.
application/json
JSON "status": "string", "message": "string", "txnId": "string", "referenceId": "string", "redirectUrl": "string", "warnings": [ "string" ]
{
}
Search covered loans on a policy
GET
/credit-life/policies/{policyId}/loans
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Query Parameters
Query
Type
string
Statuses
Type
array
InsurerId
Type
integer
PartnerId
Type
integer
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "clientName": "string", "nrcNumber": "string", "amount": 0, "coveredAmount": 0, "grossPremium": 0, "status": "string" } ]
{
}
Place a batch of loans on cover
POST
/credit-life/policies/{policyId}/loans
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "loans": [ { "fullName": "string", "nrcNumber": "string", "dateOfBirth": "string", "amount": 0, "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0 } ]
{
}
Responses
The batch. Approved means the loans are on risk — note that outstandingPremium equals grossPremium, because approval does not collect money.
application/json
JSON "id": "string", "number": "string", "status": "string", "type": "string", "totalLoans": 0, "loanAmount": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string", "loans": [ { "id": "string", "clientName": "string", "nrcNumber": "string", "amount": 0, "coveredAmount": 0, "premiumRate": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "status": "string", "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0 } ], "skipped": [ { "nrcNumber": "string", "partnerLoanReference": "string", "existingLoanId": 0 } ]
{
}
Place a single loan on cover
POST
/credit-life/policies/{policyId}/loans/single
Mid-term addition. Behaves exactly like the batch endpoint with one row.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "fullName": "string", "nrcNumber": "string", "dateOfBirth": "string", "amount": 0, "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0
{
}
Responses
A one-row Addition batch, otherwise identical to the batch endpoint.
application/json
JSON "id": "string", "number": "string", "status": "string", "type": "string", "totalLoans": 0, "loanAmount": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string", "loans": [ { "id": "string", "clientName": "string", "nrcNumber": "string", "amount": 0, "coveredAmount": 0, "premiumRate": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "status": "string", "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0 } ], "skipped": [ { "nrcNumber": "string", "partnerLoanReference": "string", "existingLoanId": 0 } ]
{
}
Get the submission batches for a policy
GET
/credit-life/policies/{policyId}/schedules
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Query Parameters
Statuses
Type
array
InsurerId
Type
integer
PartnerId
Type
integer
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "number": "string", "status": "string", "type": "string", "netPremium": 0, "grossPremium": 0, "totalLoans": 0, "loanAmount": 0 } ]
{
}
Place a batch of loans on cover and pay for it in one call
POST
/credit-life/policies/{policyId}/loans/pay
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "loans": [ { "fullName": "string", "nrcNumber": "string", "dateOfBirth": "string", "amount": 0, "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0 } ], "payment": { "reference": "string", "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 } }
{
}
Responses
The batch and the collection started against it. Unlike the ordinary submit endpoint the batch comes back Pending and NOT on risk: on a prepaid policy the premium is what incepts cover. Poll GET /payments/transactions/{reference}/status — when the gateway confirms, the loans go on risk and the premium is receipted in one step, with no further call from you.
application/json
JSON "schedule": { "id": "string", "number": "string", "status": "string", "type": "string", "totalLoans": 0, "loanAmount": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string", "loans": [ { "id": { }, "clientName": { }, "nrcNumber": { }, "amount": { }, "coveredAmount": { }, "premiumRate": { }, "netPremium": { }, "levy": { }, "grossPremium": { }, "status": { }, "startDate": { }, "endDate": { }, "partnerLoanReference": { }, "interestRate": { } } ], "skipped": [ { "nrcNumber": { }, "partnerLoanReference": { }, "existingLoanId": { } } ] }, "payment": { "status": "string", "message": "string", "txnId": "string", "referenceId": "string", "redirectUrl": "string", "warnings": [ "string" ] }
{
}
Get a covered loan by the partner reference it was submitted with
GET
/credit-life/loans/by-reference
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
partnerLoanReference
Type
string
Responses
Success
application/json
JSON "id": "string", "clientName": "string", "nrcNumber": "string", "amount": 0, "coveredAmount": 0, "premiumRate": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "status": "string", "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0
{
}
Credit Life Quotations
Get the quotations
GET
/credit-life/quotations
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
Statuses
Type
array
CorporateClientId
Type
integer
IntermediaryId
Type
integer
InsurerId
Type
integer
PartnerId
Type
integer
StartDate
Type
string
EndDate
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Quotations negotiated for your partner account. An empty array means onboarding is not finished — see the Credit Life guide.
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "updatedAt": "string", "name": "string", "corporateClientId": "string", "corporateClient": "string", "insurerId": "string", "insurer": "string", "intermediaryId": 0, "intermediary": "string", "product": "string", "partnerId": 0, "productId": "string", "rateType": "string", "status": "string", "singleRate": 0, "freeCoverLimit": 0, "createdAt": "string" } ]
{
}
Get a quotation's full rate terms
GET
/credit-life/quotations/{quotationId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
quotationId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "name": "string", "status": "string", "rateType": "string", "premiumCalculationBasis": "string", "singleRate": 0, "fixedPremiumAmount": 0, "freeCoverLimit": 0, "insuranceLevy": 0, "duration": 0, "durationType": "string", "aggregateClaimLimit": 0, "minimumAge": 0, "maximumAge": 0, "maxTenure": 0, "rateBands": [ { "fromMonths": 0, "toMonths": 0, "rate": 0 } ], "createdAt": "string"
{
}
Credit Life Policies
Operations
POST/credit-life/onboardGET/credit-life/policiesPOST/credit-life/policiesGET/credit-life/policies/{policyId}POST/credit-life/policies/{policyId}/pricingGET/credit-life/policies/{policyId}/registerPOST/credit-life/policies/{policyId}/renewPOST/credit-life/policies/{policyId}/renew/loansGET/credit-life/policies/{policyId}/statusPOST/credit-life/policies/{policyId}/renew/loans/payPOST/credit-life/policies/{policyId}/renew/payPOST/credit-life/policies/{policyId}/renew/premiums
Buy credit life cover in one call
POST
/credit-life/onboard
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "name": "string", "productId": "string", "clientId": 0, "client": { "name": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "registrationNumber": "string", "sector": "string", "phoneNumber": "string", "email": "string", "postalAddress": "string", "physicalAddress": "string", "taxPayerId": "string" }, "startDate": "string", "endDate": "string", "currency": "string", "exchangeRate": 0, "loans": [ { "fullName": "string", "nrcNumber": "string", "dateOfBirth": "string", "amount": 0, "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0 } ], "payment": { "reference": "string", "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 } }
{
}
Responses
The client, the policy, and the batch if borrowers were sent. The batch is already on risk with its premium outstanding — cover does not wait for the money. payment is present only if you asked for it, and comes back Pending: mobile money settles by callback, so poll GET /payments/transactions/{reference}/status and the premium is receipted automatically once the gateway confirms. If a payment could not be started the cover still stands and the reason is in paymentError.
application/json
JSON "policy": { "id": "string", "name": "string", "policyNumber": "string", "status": "string", "currency": "string", "startDate": "string", "endDate": "string", "freeCoverLimit": 0 }, "schedule": { "id": "string", "number": "string", "status": "string", "type": "string", "totalLoans": 0, "loanAmount": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string", "loans": [ { "id": { }, "clientName": { }, "nrcNumber": { }, "amount": { }, "coveredAmount": { }, "premiumRate": { }, "netPremium": { }, "levy": { }, "grossPremium": { }, "status": { }, "startDate": { }, "endDate": { }, "partnerLoanReference": { }, "interestRate": { } } ], "skipped": [ { "nrcNumber": { }, "partnerLoanReference": { }, "existingLoanId": { } } ] }, "corporateClientId": "string", "payment": { "status": "string", "message": "string", "txnId": "string", "referenceId": "string", "redirectUrl": "string", "warnings": [ "string" ] }
{
}
Get policies
GET
/credit-life/policies
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
Statuses
Type
array
CorporateClientId
Type
integer
IntermediaryId
Type
integer
InsurerId
Type
integer
PartnerId
Type
integer
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "currency": "string", "corporateClientId": "string", "corporateClient": "string", "insurerId": "string", "insurer": "string", "intermediaryId": 0, "intermediary": "string", "partnerId": 0 } ]
{
}
Create a policy
POST
/credit-life/policies
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "name": "string", "quotationId": "string", "startDate": "string", "endDate": "string", "currency": "string"
{
}
Responses
The policy, opened Active with the quotation's rate table frozen onto it.
application/json
JSON "id": "string", "name": "string", "policyNumber": "string", "status": "string", "currency": "string", "startDate": "string", "endDate": "string", "freeCoverLimit": 0
{
}
Get policy
GET
/credit-life/policies/{policyId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "name": "string", "policyNumber": "string", "status": "string", "currency": "string", "startDate": "string", "endDate": "string", "freeCoverLimit": 0
{
}
Quote a loan without placing it on cover
POST
/credit-life/policies/{policyId}/pricing
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "amount": 0, "startDate": "string", "endDate": "string"
{
}
Responses
What the same loan would be charged. Nothing is written.
application/json
JSON "tenureMonths": 0, "coveredAmount": 0, "freeCoverExcess": 0, "rate": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "adminFee": 0, "commissionFee": 0, "currency": "string"
{
}
Download the policy premium register (bordereau) as CSV
Renew a policy
POST
/credit-life/policies/{policyId}/renew
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Responses
Opens the cover periods the policy owes and returns where that leaves it — no payment is initiated here. Each period goes on risk immediately unless the policy requires prepayment, in which case it stays pending until paid via schedules/{scheduleId}/pay or renew/pay. Clearing arrears reinstates lapsed cover from the date of payment onwards — a loss during the lapsed period stays uncovered.
application/json
JSON "status": "string", "currentPeriodIndex": 0, "currentPeriodStart": "string", "currentPeriodEnd": "string", "graceEndsAt": "string", "unpaidPeriods": [ 0 ], "premiumPerPeriod": 0, "totalCoveredAmount": 0, "aggregateClaimLimit": 0, "uncoveredAmount": 0
{
}
InitiateRenewal a policy, carrying its outstanding loans into the new cover period
POST
/credit-life/policies/{policyId}/renew/loans
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "loans": [ { "fullName": "string", "nrcNumber": "string", "dateOfBirth": "string", "amount": 0, "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0 } ]
{
}
Responses
Send the whole outstanding book: rows already on cover come back under skipped rather than being covered and charged twice, so the batch is priced only for what is genuinely new.
application/json
JSON "id": "string", "number": "string", "status": "string", "type": "string", "totalLoans": 0, "loanAmount": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string", "loans": [ { "id": "string", "clientName": "string", "nrcNumber": "string", "amount": 0, "coveredAmount": 0, "premiumRate": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "status": "string", "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0 } ], "skipped": [ { "nrcNumber": "string", "partnerLoanReference": "string", "existingLoanId": 0 } ]
{
}
Get policy status
GET
/credit-life/policies/{policyId}/status
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Responses
Whether the policy's cover is in force for the current period, and what is unpaid. InGrace means cover is still on risk but the period's premium is outstanding; it lapses at graceEndsAt.
application/json
JSON "status": "string", "currentPeriodIndex": 0, "currentPeriodStart": "string", "currentPeriodEnd": "string", "graceEndsAt": "string", "unpaidPeriods": [ 0 ], "premiumPerPeriod": 0, "totalCoveredAmount": 0, "aggregateClaimLimit": 0, "uncoveredAmount": 0
{
}
InitiateRenewal a policy with a loan batch and pay for the period in one call
POST
/credit-life/policies/{policyId}/renew/loans/pay
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "loans": [ { "fullName": "string", "nrcNumber": "string", "dateOfBirth": "string", "amount": 0, "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0 } ], "payment": { "reference": "string", "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 } }
{
}
Responses
The renewal batch and the collection started against it. On a prepaid policy the batch stays Pending and off risk until the gateway confirms, then incepts by itself — no second call from you.
application/json
JSON "schedule": { "id": "string", "number": "string", "status": "string", "type": "string", "totalLoans": 0, "loanAmount": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string", "loans": [ { "id": { }, "clientName": { }, "nrcNumber": { }, "amount": { }, "coveredAmount": { }, "premiumRate": { }, "netPremium": { }, "levy": { }, "grossPremium": { }, "status": { }, "startDate": { }, "endDate": { }, "partnerLoanReference": { }, "interestRate": { } } ], "skipped": [ { "nrcNumber": { }, "partnerLoanReference": { }, "existingLoanId": { } } ] }, "payment": { "status": "string", "message": "string", "txnId": "string", "referenceId": "string", "redirectUrl": "string", "warnings": [ "string" ] }
{
}
Initiate Policy Renewal Payment
POST
/credit-life/policies/{policyId}/renew/pay
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "reference": "string", "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 }
{
}
Responses
Opens the current cover period and pays for it in one call — same request/response shape as schedules/{scheduleId}/pay. Only settles one outstanding period at a time; a policy with arrears spanning more than one period rejects this call, and each period is paid individually via schedules/{scheduleId}/pay instead. Poll GET /payments/transactions/{reference}/status — the premium is receipted, and the period incepted, once the gateway confirms.
application/json
JSON "payment": { "status": "string", "message": "string", "txnId": "string", "referenceId": "string", "redirectUrl": "string", "warnings": [ "string" ] }, "coverState": { "status": "string", "currentPeriodIndex": 0, "currentPeriodStart": "string", "currentPeriodEnd": "string", "graceEndsAt": "string", "unpaidPeriods": [ 0 ], "premiumPerPeriod": 0, "totalCoveredAmount": 0, "aggregateClaimLimit": 0, "uncoveredAmount": 0 }
{
}
Get policy renewal premiums
POST
/credit-life/policies/{policyId}/renew/premiums
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Responses
The renewal quote: same shape as GET status, so you can preview what renewing would open and cost before calling renew. Nothing is written — call this as often as you like.
application/json
JSON "status": "string", "currentPeriodIndex": 0, "currentPeriodStart": "string", "currentPeriodEnd": "string", "graceEndsAt": "string", "unpaidPeriods": [ 0 ], "premiumPerPeriod": 0, "totalCoveredAmount": 0, "aggregateClaimLimit": 0, "uncoveredAmount": 0
{
}
Get the credit-life products
GET
/products/credit-life
Authorizations
BearerAuth
Type
HTTP (bearer)
Responses
Products you may sell, with the terms each policy would be written on. Empty means none are assigned to your account.
application/json
JSON { "id": 0, "name": "string", "description": "string", "code": "string", "insurerName": "string", "insurerLogoUrl": "string", "fixedPremiumAmount": 0, "freeCoverLimit": 0, "coverPeriodMonths": 0, "coverPeriodDuration": 0, "coverPeriodDurationType": "string", "premiumGraceDays": 0, "aggregateClaimLimit": 0, "claimNotificationDays": 0, "minimumAge": 0, "maximumAge": 0, "maxTenure": 0, "rateBands": [ { "fromMonths": { }, "toMonths": { }, "rate": { } } ], "scopesOfCover": [ { "id": { }, "name": { }, "description": { }, "percentageOfSumAssured": { }, "clauses": { }, "claimRequirements": { } } ], "documents": [ { "id": { }, "name": { }, "url": { } } ] }
[
]
Track my claims
GET
/group-life/claims
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
InsurerId
Type
integer
PartnerId
Type
integer
Statuses
Type
array
GroupPolicyId
Type
integer
LossDateFrom
Type
string
LossDateTo
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "number": "string", "groupPolicyId": "string", "memberId": "string", "payoutAmount": 0, "status": "string", "lossDate": "string" } ]
{
}
Intimate a death claim against a covered member
POST
/group-life/claims
The claim is created Intimated for the insurer to assess; the payout is the member's sum assured. Identify the member by memberId or nrcNumber — not both.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "memberId": 0, "nrcNumber": "string", "lossDate": "string", "cause": "string", "lateNotificationReason": "string"
{
}
Responses
Success
application/json
JSON "id": "string", "number": "string", "memberId": "string", "status": "string", "lossDate": "string", "payoutAmount": 0, "createdAt": "string"
{
}
Get a claim
GET
/group-life/claims/{claimId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
claimId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "number": "string", "memberId": "string", "status": "string", "lossDate": "string", "payoutAmount": 0, "createdAt": "string"
{
}
Attach supporting documents to a claim
POST
/group-life/claims/{claimId}/documents
Upload the file to storage first and post its URL here. The first upload moves an Intimated claim to Documented.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
claimId*
Type
Requiredstring
Request Body
application/json
JSON { "description": "string", "url": "string", "type": "string" }
[
]
Responses
Success
application/json
JSON "id": "string", "number": "string", "memberId": "string", "status": "string", "lossDate": "string", "payoutAmount": 0, "createdAt": "string"
{
}
Group Life Policies
Operations
POST/group-life/members/removeGET/group-life/members/{memberId}GET/group-life/quotationsGET/group-life/quotations/{quotationId}GET/group-life/schedules/{scheduleId}GET/group-life/policiesPOST/group-life/policiesGET/group-life/policies/{policyId}GET/group-life/policies/{policyId}/membersPOST/group-life/policies/{policyId}/membersPOST/group-life/policies/{policyId}/pricingGET/group-life/policies/{policyId}/registerGET/group-life/policies/{policyId}/schedulesGET/group-life/members/by-nrc
Take members off cover
POST
/group-life/members/remove
Identify members by memberIds or nrcNumbers — not both. Raises a deletion endorsement. No pro-rata premium refund is made on a group life exit — cover is annual and the premium is earned.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "memberIds": [ "string" ], "nrcNumbers": [ "string" ], "reason": "string"
{
}
Responses
Success
application/json
JSON "id": "string", "number": "string", "endorsementType": "string", "endorsementStatus": "string", "endorsementAmount": 0
{
}
Get a covered member
Get the quotations negotiated for me — the terms a policy can be opened on
GET
/group-life/quotations
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
InsurerId
Type
integer
PartnerId
Type
integer
Statuses
Type
array
CorporateClientId
Type
integer
IntermediaryId
Type
integer
FromDate
Type
string
ToDate
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "name": "string", "corporateClientId": "string", "corporateClient": "string", "insurerId": "string", "insurer": "string", "intermediaryId": 0, "intermediary": "string", "product": "string", "productId": "string", "sumAssuredBasis": "string", "status": "string", "freeCoverLimit": 0, "createdAt": "string" } ]
{
}
Get a quotation's full rate terms
GET
/group-life/quotations/{quotationId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
quotationId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "corporateClientId": "string", "insurerId": "string", "intermediaryId": 0, "corporateClient": "string", "insurer": "string", "intermediary": "string", "product": "string", "partnerId": 0, "partner": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "email": "string", "apiKey": "string", "logoUrl": "string", "address": { "country": "string", "province": "string", "district": "string", "street": "string", "plotNo": "string" }, "apiUser": { "id": "string", "userName": "string", "normalizedUserName": "string", "email": "string", "normalizedEmail": "string", "emailConfirmed": true, "passwordHash": "string", "securityStamp": "string", "concurrencyStamp": "string", "phoneNumber": "string", "phoneNumberConfirmed": true, "twoFactorEnabled": true, "lockoutEnd": "string", "lockoutEnabled": true, "accessFailedCount": 0, "createdAt": "string", "updateAt": "string", "branchId": 0, "status": "string", "twoFactorMethod": "string", "lastSeen": "string" }, "apiUserId": 0, "bankId": 0, "bank": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "swiftCode": "string", "branches": [ { } ] }, "paymentMethod": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "partnerId": { }, "partner": { }, "insurerId": { }, "insurer": { }, "brokerId": { }, "broker": { }, "paymentMethods": { } } ], "paymentMethods": [ "string" ], "smsOriginatorId": "string", "type": "string", "status": "string", "category": "string", "partnerSelfServiceApiKey": "string", "paymentCallbackUrl": "string", "paymentGateways": [ "string" ], "insurerApiConfigs": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "insurerId": { }, "insurer": { }, "intermediaryId": { }, "intermediary": { }, "partnerId": { }, "partner": { }, "apiKey": { }, "apiSecret": { }, "apiBaseUrl": { }, "settings": { } } ] }, "productId": "string", "selectedScopeOfCoverIds": [ 0 ], "freeCoverLimit": 0, "insuranceLevy": 0, "commissionRate": 0, "administrationRate": 0, "claimNotificationDays": 0, "status": "string", "createdById": "string", "createdBy": { "id": "string", "userName": "string", "normalizedUserName": "string", "email": "string", "normalizedEmail": "string", "emailConfirmed": true, "passwordHash": "string", "securityStamp": "string", "concurrencyStamp": "string", "phoneNumber": "string", "phoneNumberConfirmed": true, "twoFactorEnabled": true, "lockoutEnd": "string", "lockoutEnabled": true, "accessFailedCount": 0, "createdAt": "string", "updateAt": "string", "branchId": 0, "status": "string", "twoFactorMethod": "string", "lastSeen": "string" }, "sumAssuredBasis": "string", "salaryMultiple": 0, "flatSumAssured": 0, "customRate": 0, "load": 0, "ageBands": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "groupLifeQuotationId": "string", "fromAge": 0, "toAge": 0, "rate": 0 } ]
{
}
Get an enrolment batch
GET
/group-life/schedules/{scheduleId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
scheduleId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "number": "string", "status": "string", "type": "string", "totalMembers": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string"
{
}
Get my group life policies
GET
/group-life/policies
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
InsurerId
Type
integer
PartnerId
Type
integer
Statuses
Type
array
CorporateClientId
Type
integer
IntermediaryId
Type
integer
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "name": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "currency": "string", "corporateClientId": "string", "corporateClient": "string", "insurerId": "string", "insurer": "string", "intermediaryId": 0, "intermediary": "string" } ]
{
}
Open a group life policy on an approved quotation
POST
/group-life/policies
The policy freezes the quotation's age-rate table at creation, so later re-quoting cannot re-price cover already on risk. The policyholder is the quotation's corporate client and cannot be changed here.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "name": "string", "quotationId": "string", "startDate": "string", "endDate": "string", "currency": "string"
{
}
Responses
Success
application/json
JSON "id": "string", "name": "string", "policyNumber": "string", "status": "string", "currency": "string", "startDate": "string", "endDate": "string", "freeCoverLimit": 0, "insuranceLevy": 0
{
}
Get a group life policy
GET
/group-life/policies/{policyId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "name": "string", "policyNumber": "string", "status": "string", "currency": "string", "startDate": "string", "endDate": "string", "freeCoverLimit": 0, "insuranceLevy": 0
{
}
Search covered members on a policy
GET
/group-life/policies/{policyId}/members
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Query Parameters
InsurerId
Type
integer
PartnerId
Type
integer
Statuses
Type
array
Query
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "clientName": "string", "nrcNumber": "string", "annualSalary": 0, "sumAssured": 0, "ageNextBirthday": 0, "grossPremium": 0, "status": "string" } ]
{
}
Enrol a batch of members
POST
/group-life/policies/{policyId}/members
Straight-through: uploaded and approved in one call, which puts the members on risk. Approval does NOT collect money — the premium becomes due and is receipted separately as you remit, so cover starts while premium is still owed and outstandingPremium says how much. Approved, PartiallyReceipted or Receipted means covered; Pending means the batch was not approved and they are NOT covered. Set midTermAddition for a batch joining a policy already running — those members are pro-rated to the remaining period.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "members": [ { "fullName": "string", "nrcNumber": "string", "dateOfBirth": "string", "annualSalary": 0 } ], "currency": "string", "exchangeRate": 0, "midTermAddition": true
{
}
Responses
Success
application/json
JSON "id": "string", "number": "string", "status": "string", "type": "string", "totalMembers": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string"
{
}
Quote a census without enrolling anyone
POST
/group-life/policies/{policyId}/pricing
Prices each member against the policy's frozen age-rate table and persists nothing. A non-zero freeCoverExcess means cover above the free cover limit is NOT automatically on risk and needs underwriting.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "members": [ { "fullName": "string", "nrcNumber": "string", "dateOfBirth": "string", "annualSalary": 0 } ]
{
}
Responses
Success
application/json
JSON "members": [ { "fullName": "string", "nrcNumber": "string", "ageNextBirthday": 0, "sumAssured": 0, "freeCoverExcess": 0, "rate": 0, "netPremium": 0, "levy": 0, "grossPremium": 0 } ], "totalSumAssured": 0, "totalNetPremium": 0, "totalLevy": 0, "totalGrossPremium": 0, "currency": "string"
{
}
Download the policy member register (bordereau) as CSV
Get the enrolment batches for a policy
GET
/group-life/policies/{policyId}/schedules
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Query Parameters
InsurerId
Type
integer
PartnerId
Type
integer
Statuses
Type
array
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "number": "string", "status": "string", "type": "string", "netPremium": 0, "grossPremium": 0, "totalMembers": 0, "totalSumAssured": 0, "createdAt": "string" } ]
{
}
Get a covered member by NRC number
Track my claims
GET
/group-funeral/claims
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
InsurerId
Type
integer
PartnerId
Type
integer
Statuses
Type
array
GroupPolicyId
Type
integer
LossDateFrom
Type
string
LossDateTo
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "number": "string", "payoutAmount": 0, "status": "string", "groupPolicyId": "string", "memberId": "string", "memberType": "string", "beneficiaryId": 0, "lossDate": "string", "createdAt": "string" } ]
{
}
Intimate a funeral claim
POST
/group-funeral/claims
Identify the household by memberId or nrcNumber — not both. Name the covered life: memberType MainMember for the principal, otherwise the relationship plus the beneficiaryId. The payout is the benefit tier for that life, not the whole household's cover.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "memberId": "string", "nrcNumber": "string", "memberType": "string", "beneficiaryId": 0, "lossDate": "string", "cause": "string", "lateNotificationReason": "string"
{
}
Responses
Success
application/json
JSON "id": "string", "number": "string", "memberId": "string", "status": "string", "lossDate": "string", "payoutAmount": 0, "createdAt": "string"
{
}
Get a claim
GET
/group-funeral/claims/{claimId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
claimId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "number": "string", "memberId": "string", "status": "string", "lossDate": "string", "payoutAmount": 0, "createdAt": "string"
{
}
Attach supporting documents to a claim
POST
/group-funeral/claims/{claimId}/documents
Upload the file to storage first and post its URL here. The first upload moves an Intimated claim to Documented.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
claimId*
Type
Requiredstring
Request Body
application/json
JSON { "description": "string", "url": "string", "type": "string" }
[
]
Responses
Success
application/json
JSON "id": "string", "number": "string", "memberId": "string", "status": "string", "lossDate": "string", "payoutAmount": 0, "createdAt": "string"
{
}
Group Funeral Policies
Operations
POST/group-funeral/members/removeGET/group-funeral/members/{memberId}GET/group-funeral/quotationsGET/group-funeral/quotations/{quotationId}GET/group-funeral/schedules/{scheduleId}GET/group-funeral/policiesPOST/group-funeral/policiesGET/group-funeral/policies/{policyId}GET/group-funeral/policies/{policyId}/membersPOST/group-funeral/policies/{policyId}/membersGET/group-funeral/policies/{policyId}/registerGET/group-funeral/policies/{policyId}/schedulesGET/group-funeral/members/by-nrc
Take households off cover
POST
/group-funeral/members/remove
Identify households by memberIds or nrcNumbers — not both. Removes the principal and their beneficiaries and raises a deletion endorsement.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "memberIds": [ "string" ], "nrcNumbers": [ "string" ], "reason": "string"
{
}
Responses
Success
application/json
JSON "id": "string", "number": "string", "endorsementType": "string", "endorsementStatus": "string", "endorsementAmount": 0
{
}
Get a covered household, including its registered beneficiaries
GET
/group-funeral/members/{memberId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
memberId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "createdAt": "string", "updatedAt": "string", "clientId": "string", "client": { "id": "string", "createdAt": "string", "updatedAt": "string", "email": "string", "taxPayerId": "string", "bankDetail": { "name": "string", "branch": "string", "accountNumber": "string", "swiftCode": "string", "accountName": "string" }, "phoneNumber": "string", "physicalAddress": "string", "insurerId": 0, "partnerId": 0, "type": "string", "status": "string", "dateOfBirth": "string", "createdById": "string", "createdBy": { "id": "string", "userName": "string", "normalizedUserName": "string", "email": "string", "normalizedEmail": "string", "emailConfirmed": true, "passwordHash": "string", "securityStamp": "string", "concurrencyStamp": "string", "phoneNumber": "string", "phoneNumberConfirmed": true, "twoFactorEnabled": true, "lockoutEnd": "string", "lockoutEnabled": true, "accessFailedCount": 0, "createdAt": "string", "updateAt": "string", "branchId": 0, "status": "string", "twoFactorMethod": "string", "lastSeen": "string" }, "intermediaryId": 0, "userId": 0, "farms": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "clientId": { }, "client": { }, "campId": { }, "camp": { } } ], "firstName": "string", "middleName": "string", "lastName": "string", "idNumber": "string", "idType": "string", "gender": "string", "fullName": "string", "maritalStatus": "string" }, "policyId": "string", "policy": { "id": "string", "createdAt": "string", "updatedAt": "string", "clientId": "string", "client": { "id": "string", "createdAt": "string", "updatedAt": "string", "email": "string", "taxPayerId": "string", "bankDetail": { "name": { }, "branch": { }, "accountNumber": { }, "swiftCode": { }, "accountName": { } }, "phoneNumber": "string", "physicalAddress": "string", "insurerId": 0, "partnerId": 0, "type": "string", "status": "string", "dateOfBirth": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "intermediaryId": 0, "userId": 0, "farms": [ { } ] }, "policyNumber": "string", "status": "string", "approvedDate": "string", "startDate": "string", "endDate": "string", "partnerId": 0, "partner": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "email": "string", "apiKey": "string", "logoUrl": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "apiUser": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "apiUserId": 0, "bankId": 0, "bank": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "swiftCode": { }, "branches": { } }, "paymentMethod": [ { } ], "paymentMethods": [ { } ], "smsOriginatorId": "string", "type": "string", "status": "string", "category": "string", "partnerSelfServiceApiKey": "string", "paymentCallbackUrl": "string", "paymentGateways": [ { } ], "insurerApiConfigs": [ { } ] }, "insurerId": "string", "insurer": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "taxPayerId": "string", "logoUrl": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "email": "string", "popularity": 0, "insurerType": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "bankId": 0, "bank": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "swiftCode": { }, "branches": { } }, "status": "string", "shortName": "string" }, "productId": "string", "product": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "code": "string", "source": "string", "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "classOfBusinessId": "string", "classOfBusiness": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "order": { }, "products": { } }, "insurerId": "string", "insurer": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "taxPayerId": { }, "logoUrl": { }, "address": { }, "email": { }, "popularity": { }, "insurerType": { }, "createdById": { }, "createdBy": { }, "bankId": { }, "bank": { }, "status": { }, "shortName": { } }, "productCategoryId": 0, "productCategory": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "description": { }, "isActive": { }, "createdById": { }, "createdBy": { }, "classOfBusinessId": { }, "classOfBusiness": { }, "products": { } }, "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "createdById": 0, "status": "string", "documents": [ { } ], "distributionChannels": [ { } ], "paymentMethods": [ { } ], "discounts": [ { } ], "intermediaryCommissionRates": [ { } ], "premiumLimits": [ { } ], "codeRules": [ { } ] }, "createdById": "string", "createdBy": { "id": "string", "userName": "string", "normalizedUserName": "string", "email": "string", "normalizedEmail": "string", "emailConfirmed": true, "passwordHash": "string", "securityStamp": "string", "concurrencyStamp": "string", "phoneNumber": "string", "phoneNumberConfirmed": true, "twoFactorEnabled": true, "lockoutEnd": "string", "lockoutEnabled": true, "accessFailedCount": 0, "createdAt": "string", "updateAt": "string", "branchId": 0, "status": "string", "twoFactorMethod": "string", "lastSeen": "string" }, "currency": "string", "exchangeRate": 0, "sourceOfBusiness": { "id": "string", "createdAt": "string", "updatedAt": "string", "type": "string", "intermediaryId": 0, "partnerId": 0, "platform": "string" }, "sourceOfBusinessId": "string", "premiumLevy": 0, "basicPremium": 0, "grossPremium": 0, "extensionsPremium": 0, "discountsPremium": 0, "intermediaryId": 0, "intermediary": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "logoUrl": "string", "taxPayerId": "string", "email": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "bankDetail": { "name": { }, "branch": { }, "accountNumber": { }, "swiftCode": { }, "accountName": { } }, "status": "string", "mergedIntoId": 0, "type": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "bankId": 0, "bank": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "swiftCode": { }, "branches": { } }, "smsOriginatorId": "string", "systemPermissions": [ { } ], "insurerIntermediaryBranches": [ { } ], "insurerApiConfigs": [ { } ], "districtId": 0, "district": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "level": { }, "parentId": { }, "parent": { }, "children": { }, "province": { }, "provinceId": { } }, "insurerCodes": [ { } ] }, "branch": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "insurerId": 0, "intermediaryId": 0, "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } } }, "branchId": 0, "paymentPlanId": 0, "paymentPlan": { "id": "string", "createdAt": "string", "updatedAt": "string", "referenceNumber": "string", "description": "string", "startDate": "string", "totalAmount": 0, "firstInstallmentDate": "string", "numberOfInstallments": 0, "frequency": "string", "amountType": "string", "status": "string", "currency": "string", "outstandingBalance": 0, "paidAmount": 0, "clientId": "string", "client": { "id": { }, "createdAt": { }, "updatedAt": { }, "email": { }, "taxPayerId": { }, "bankDetail": { }, "phoneNumber": { }, "physicalAddress": { }, "insurerId": { }, "partnerId": { }, "type": { }, "status": { }, "dateOfBirth": { }, "createdById": { }, "createdBy": { }, "intermediaryId": { }, "userId": { }, "farms": { } }, "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "insurerId": 0, "insurer": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "taxPayerId": { }, "logoUrl": { }, "address": { }, "email": { }, "popularity": { }, "insurerType": { }, "createdById": { }, "createdBy": { }, "bankId": { }, "bank": { }, "status": { }, "shortName": { } }, "intermediaryId": 0, "intermediary": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "logoUrl": { }, "taxPayerId": { }, "email": { }, "address": { }, "bankDetail": { }, "status": { }, "mergedIntoId": { }, "type": { }, "createdById": { }, "createdBy": { }, "bankId": { }, "bank": { }, "smsOriginatorId": { }, "systemPermissions": { }, "insurerIntermediaryBranches": { }, "insurerApiConfigs": { }, "districtId": { }, "district": { }, "insurerCodes": { } }, "policyId": "string", "policy": { "id": { }, "createdAt": { }, "updatedAt": { }, "clientId": { }, "client": { }, "policyNumber": { }, "status": { }, "approvedDate": { }, "startDate": { }, "endDate": { }, "partnerId": { }, "partner": { }, "insurerId": { }, "insurer": { }, "productId": { }, "product": { }, "createdById": { }, "createdBy": { }, "currency": { }, "exchangeRate": { }, "sourceOfBusiness": { }, "sourceOfBusinessId": { }, "premiumLevy": { }, "basicPremium": { }, "grossPremium": { }, "extensionsPremium": { }, "discountsPremium": { }, "intermediaryId": { }, "intermediary": { }, "branch": { }, "branchId": { }, "paymentPlanId": { }, "paymentPlan": { }, "cancellationType": { }, "premiumStatus": { }, "beneficiaryPolicies": { } }, "paymentPlanConfigId": 0, "paymentPlanConfig": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "description": { }, "frequency": { }, "numberOfInstallments": { }, "amountType": { }, "insurerId": { }, "status": { }, "isLevyRequired": { }, "requireInitialPayment": { }, "createdById": { }, "createdBy": { }, "productAssignments": { }, "intermediaryAssignments": { }, "partnerAssignments": { } }, "invoices": [ { } ], "approvedBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "approvedById": 0, "approvedAt": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "createdById": 0, "transactions": [ { } ], "isDeleted": true, "deletedAt": "string", "deletedById": 0, "configSnapshot": { "name": { }, "description": { }, "frequency": { }, "numberOfInstallments": { }, "amountType": { }, "insurerId": { }, "isLevyRequired": { }, "requireInitialPayment": { }, "snapshotTakenAt": { } }, "modeOfPayment": "string" }, "cancellationType": "string", "premiumStatus": "string", "beneficiaryPolicies": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "beneficiaryId": { }, "beneficiary": { }, "policyId": { } } ], "name": "string", "claimNotificationDays": 0, "insuranceLevy": 0, "commissionRate": 0, "administrationRate": 0, "customRate": 0, "load": 0, "childMaximumAge": 0, "ageBands": [ { "fromAge": { }, "toAge": { }, "rate": { } } ], "benefits": [ { "benefitType": { }, "sumAssured": { } } ], "quotationId": "string", "quotation": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "corporateClientId": "string", "insurerId": "string", "intermediaryId": 0, "corporateClient": "string", "insurer": "string", "intermediary": "string", "product": "string", "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "productId": "string", "selectedScopeOfCoverIds": [ { } ], "freeCoverLimit": 0, "insuranceLevy": 0, "commissionRate": 0, "administrationRate": 0, "claimNotificationDays": 0, "status": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "customRate": 0, "load": 0, "childMaximumAge": 0, "benefits": [ { } ], "ageBands": [ { } ] }, "members": [ { } ] }, "scheduleId": "string", "ageNextBirthday": 0, "sumAssured": 0, "appliedRate": 0, "netPremium": 0, "grossPremium": 0, "levy": 0, "daysProRata": 0, "status": "string", "beneficiaries": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "groupFuneralMemberId": "string", "fullName": "string", "relationship": "string", "dateOfBirth": "string", "ageNextBirthday": 0, "sumAssured": 0, "netPremium": 0, "grossPremium": 0, "levy": 0, "status": "string" } ]
{
}
Get the quotations negotiated for me — the terms a policy can be opened on
GET
/group-funeral/quotations
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
InsurerId
Type
integer
PartnerId
Type
integer
Statuses
Type
array
CorporateClientId
Type
integer
IntermediaryId
Type
integer
FromDate
Type
string
ToDate
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "name": "string", "corporateClientId": "string", "corporateClient": "string", "insurerId": "string", "insurer": "string", "intermediaryId": 0, "intermediary": "string", "product": "string", "productId": "string", "status": "string", "freeCoverLimit": 0, "insuranceLevy": 0, "commissionRate": 0, "administrationRate": 0, "createdAt": "string" } ]
{
}
Get a quotation's full rate and benefit terms
GET
/group-funeral/quotations/{quotationId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
quotationId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "corporateClientId": "string", "insurerId": "string", "intermediaryId": 0, "corporateClient": "string", "insurer": "string", "intermediary": "string", "product": "string", "partnerId": 0, "partner": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "email": "string", "apiKey": "string", "logoUrl": "string", "address": { "country": "string", "province": "string", "district": "string", "street": "string", "plotNo": "string" }, "apiUser": { "id": "string", "userName": "string", "normalizedUserName": "string", "email": "string", "normalizedEmail": "string", "emailConfirmed": true, "passwordHash": "string", "securityStamp": "string", "concurrencyStamp": "string", "phoneNumber": "string", "phoneNumberConfirmed": true, "twoFactorEnabled": true, "lockoutEnd": "string", "lockoutEnabled": true, "accessFailedCount": 0, "createdAt": "string", "updateAt": "string", "branchId": 0, "status": "string", "twoFactorMethod": "string", "lastSeen": "string" }, "apiUserId": 0, "bankId": 0, "bank": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "swiftCode": "string", "branches": [ { } ] }, "paymentMethod": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "partnerId": { }, "partner": { }, "insurerId": { }, "insurer": { }, "brokerId": { }, "broker": { }, "paymentMethods": { } } ], "paymentMethods": [ "string" ], "smsOriginatorId": "string", "type": "string", "status": "string", "category": "string", "partnerSelfServiceApiKey": "string", "paymentCallbackUrl": "string", "paymentGateways": [ "string" ], "insurerApiConfigs": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "insurerId": { }, "insurer": { }, "intermediaryId": { }, "intermediary": { }, "partnerId": { }, "partner": { }, "apiKey": { }, "apiSecret": { }, "apiBaseUrl": { }, "settings": { } } ] }, "productId": "string", "selectedScopeOfCoverIds": [ 0 ], "freeCoverLimit": 0, "insuranceLevy": 0, "commissionRate": 0, "administrationRate": 0, "claimNotificationDays": 0, "status": "string", "createdById": "string", "createdBy": { "id": "string", "userName": "string", "normalizedUserName": "string", "email": "string", "normalizedEmail": "string", "emailConfirmed": true, "passwordHash": "string", "securityStamp": "string", "concurrencyStamp": "string", "phoneNumber": "string", "phoneNumberConfirmed": true, "twoFactorEnabled": true, "lockoutEnd": "string", "lockoutEnabled": true, "accessFailedCount": 0, "createdAt": "string", "updateAt": "string", "branchId": 0, "status": "string", "twoFactorMethod": "string", "lastSeen": "string" }, "customRate": 0, "load": 0, "childMaximumAge": 0, "benefits": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "groupFuneralQuotationId": "string", "benefitType": "string", "sumAssured": 0 } ], "ageBands": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "groupFuneralQuotationId": "string", "fromAge": 0, "toAge": 0, "rate": 0 } ]
{
}
Get an enrolment batch
GET
/group-funeral/schedules/{scheduleId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
scheduleId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "number": "string", "status": "string", "type": "string", "totalMembers": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string"
{
}
Get my group funeral policies
GET
/group-funeral/policies
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
InsurerId
Type
integer
PartnerId
Type
integer
Statuses
Type
array
CorporateClientId
Type
integer
IntermediaryId
Type
integer
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "name": "string", "policyNumber": "string", "status": "string", "startDate": "string", "endDate": "string", "currency": "string", "corporateClientId": "string", "corporateClient": "string", "insurerId": "string", "insurer": "string", "intermediaryId": 0, "intermediary": "string" } ]
{
}
Open a group funeral policy on an approved quotation
POST
/group-funeral/policies
The policy freezes the quotation's age-rate table and benefit tiers at creation, so later re-quoting cannot re-price cover already on risk.
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "name": "string", "quotationId": "string", "startDate": "string", "endDate": "string", "currency": "string"
{
}
Responses
Success
application/json
JSON "id": "string", "name": "string", "policyNumber": "string", "status": "string", "currency": "string", "startDate": "string", "endDate": "string", "freeCoverLimit": 0, "insuranceLevy": 0
{
}
Get a group funeral policy
GET
/group-funeral/policies/{policyId}
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Responses
Success
application/json
JSON "id": "string", "name": "string", "policyNumber": "string", "status": "string", "currency": "string", "startDate": "string", "endDate": "string", "freeCoverLimit": 0, "insuranceLevy": 0
{
}
Search covered households on a policy
GET
/group-funeral/policies/{policyId}/members
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Query Parameters
InsurerId
Type
integer
PartnerId
Type
integer
Statuses
Type
array
Query
Type
string
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "principalName": "string", "nrcNumber": "string", "sumAssured": 0, "ageNextBirthday": 0, "grossPremium": 0, "status": "string", "beneficiaryCount": 0, "beneficiaries": [ { } ] } ]
{
}
Enrol a batch of households
POST
/group-funeral/policies/{policyId}/members
Each member is a principal plus their beneficiaries (Spouse, Child, Parent), and each covered life is rated on its own age band. Straight-through: uploaded and approved in one call, which puts the households on risk. Approval does NOT collect money — the premium becomes due and is receipted separately as you remit, so cover starts while premium is still owed and outstandingPremium says how much. Approved, PartiallyReceipted or Receipted means covered; Pending means the batch was not approved and nobody is on risk.
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Request Body
application/json
JSON "members": [ { "fullName": "string", "nrcNumber": "string", "dateOfBirth": "string", "beneficiaries": [ { } ] } ], "currency": "string", "exchangeRate": 0, "midTermAddition": true
{
}
Responses
Success
application/json
JSON "id": "string", "number": "string", "status": "string", "type": "string", "totalMembers": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string"
{
}
Download the policy register (one row per covered life) as CSV
Get the enrolment batches for a policy
GET
/group-funeral/policies/{policyId}/schedules
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Path Parameters
policyId*
Type
Requiredstring
Query Parameters
InsurerId
Type
integer
PartnerId
Type
integer
Statuses
Type
array
PageNumber
Type
integer
PageSize
Type
integer
Responses
Success
application/json
JSON "totalItems": 0, "pageSize": 0, "pageNumber": 0, "totalPages": 0, "data": [ { "id": "string", "number": "string", "status": "string", "type": "string", "netPremium": 0, "grossPremium": 0, "totalMembers": 0, "totalSumAssured": 0, "createdAt": "string" } ]
{
}
Get a covered household by the principal's NRC number
GET
/group-funeral/members/by-nrc
Authorizations
BearerAuth
Type
HTTP (bearer)
Parameters
Query Parameters
nrcNumber
Type
string
Responses
Success
application/json
JSON "id": "string", "createdAt": "string", "updatedAt": "string", "clientId": "string", "client": { "id": "string", "createdAt": "string", "updatedAt": "string", "email": "string", "taxPayerId": "string", "bankDetail": { "name": "string", "branch": "string", "accountNumber": "string", "swiftCode": "string", "accountName": "string" }, "phoneNumber": "string", "physicalAddress": "string", "insurerId": 0, "partnerId": 0, "type": "string", "status": "string", "dateOfBirth": "string", "createdById": "string", "createdBy": { "id": "string", "userName": "string", "normalizedUserName": "string", "email": "string", "normalizedEmail": "string", "emailConfirmed": true, "passwordHash": "string", "securityStamp": "string", "concurrencyStamp": "string", "phoneNumber": "string", "phoneNumberConfirmed": true, "twoFactorEnabled": true, "lockoutEnd": "string", "lockoutEnabled": true, "accessFailedCount": 0, "createdAt": "string", "updateAt": "string", "branchId": 0, "status": "string", "twoFactorMethod": "string", "lastSeen": "string" }, "intermediaryId": 0, "userId": 0, "farms": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "clientId": { }, "client": { }, "campId": { }, "camp": { } } ], "firstName": "string", "middleName": "string", "lastName": "string", "idNumber": "string", "idType": "string", "gender": "string", "fullName": "string", "maritalStatus": "string" }, "policyId": "string", "policy": { "id": "string", "createdAt": "string", "updatedAt": "string", "clientId": "string", "client": { "id": "string", "createdAt": "string", "updatedAt": "string", "email": "string", "taxPayerId": "string", "bankDetail": { "name": { }, "branch": { }, "accountNumber": { }, "swiftCode": { }, "accountName": { } }, "phoneNumber": "string", "physicalAddress": "string", "insurerId": 0, "partnerId": 0, "type": "string", "status": "string", "dateOfBirth": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "intermediaryId": 0, "userId": 0, "farms": [ { } ] }, "policyNumber": "string", "status": "string", "approvedDate": "string", "startDate": "string", "endDate": "string", "partnerId": 0, "partner": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "email": "string", "apiKey": "string", "logoUrl": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "apiUser": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "apiUserId": 0, "bankId": 0, "bank": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "swiftCode": { }, "branches": { } }, "paymentMethod": [ { } ], "paymentMethods": [ { } ], "smsOriginatorId": "string", "type": "string", "status": "string", "category": "string", "partnerSelfServiceApiKey": "string", "paymentCallbackUrl": "string", "paymentGateways": [ { } ], "insurerApiConfigs": [ { } ] }, "insurerId": "string", "insurer": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "taxPayerId": "string", "logoUrl": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "email": "string", "popularity": 0, "insurerType": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "bankId": 0, "bank": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "swiftCode": { }, "branches": { } }, "status": "string", "shortName": "string" }, "productId": "string", "product": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "description": "string", "code": "string", "source": "string", "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "classOfBusinessId": "string", "classOfBusiness": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "order": { }, "products": { } }, "insurerId": "string", "insurer": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "taxPayerId": { }, "logoUrl": { }, "address": { }, "email": { }, "popularity": { }, "insurerType": { }, "createdById": { }, "createdBy": { }, "bankId": { }, "bank": { }, "status": { }, "shortName": { } }, "productCategoryId": 0, "productCategory": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "description": { }, "isActive": { }, "createdById": { }, "createdBy": { }, "classOfBusinessId": { }, "classOfBusiness": { }, "products": { } }, "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "createdById": 0, "status": "string", "documents": [ { } ], "distributionChannels": [ { } ], "paymentMethods": [ { } ], "discounts": [ { } ], "intermediaryCommissionRates": [ { } ], "premiumLimits": [ { } ], "codeRules": [ { } ] }, "createdById": "string", "createdBy": { "id": "string", "userName": "string", "normalizedUserName": "string", "email": "string", "normalizedEmail": "string", "emailConfirmed": true, "passwordHash": "string", "securityStamp": "string", "concurrencyStamp": "string", "phoneNumber": "string", "phoneNumberConfirmed": true, "twoFactorEnabled": true, "lockoutEnd": "string", "lockoutEnabled": true, "accessFailedCount": 0, "createdAt": "string", "updateAt": "string", "branchId": 0, "status": "string", "twoFactorMethod": "string", "lastSeen": "string" }, "currency": "string", "exchangeRate": 0, "sourceOfBusiness": { "id": "string", "createdAt": "string", "updatedAt": "string", "type": "string", "intermediaryId": 0, "partnerId": 0, "platform": "string" }, "sourceOfBusinessId": "string", "premiumLevy": 0, "basicPremium": 0, "grossPremium": 0, "extensionsPremium": 0, "discountsPremium": 0, "intermediaryId": 0, "intermediary": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "logoUrl": "string", "taxPayerId": "string", "email": "string", "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } }, "bankDetail": { "name": { }, "branch": { }, "accountNumber": { }, "swiftCode": { }, "accountName": { } }, "status": "string", "mergedIntoId": 0, "type": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "bankId": 0, "bank": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "swiftCode": { }, "branches": { } }, "smsOriginatorId": "string", "systemPermissions": [ { } ], "insurerIntermediaryBranches": [ { } ], "insurerApiConfigs": [ { } ], "districtId": 0, "district": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "level": { }, "parentId": { }, "parent": { }, "children": { }, "province": { }, "provinceId": { } }, "insurerCodes": [ { } ] }, "branch": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "insurerId": 0, "intermediaryId": 0, "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "address": { "country": { }, "province": { }, "district": { }, "street": { }, "plotNo": { } } }, "branchId": 0, "paymentPlanId": 0, "paymentPlan": { "id": "string", "createdAt": "string", "updatedAt": "string", "referenceNumber": "string", "description": "string", "startDate": "string", "totalAmount": 0, "firstInstallmentDate": "string", "numberOfInstallments": 0, "frequency": "string", "amountType": "string", "status": "string", "currency": "string", "outstandingBalance": 0, "paidAmount": 0, "clientId": "string", "client": { "id": { }, "createdAt": { }, "updatedAt": { }, "email": { }, "taxPayerId": { }, "bankDetail": { }, "phoneNumber": { }, "physicalAddress": { }, "insurerId": { }, "partnerId": { }, "type": { }, "status": { }, "dateOfBirth": { }, "createdById": { }, "createdBy": { }, "intermediaryId": { }, "userId": { }, "farms": { } }, "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "insurerId": 0, "insurer": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "taxPayerId": { }, "logoUrl": { }, "address": { }, "email": { }, "popularity": { }, "insurerType": { }, "createdById": { }, "createdBy": { }, "bankId": { }, "bank": { }, "status": { }, "shortName": { } }, "intermediaryId": 0, "intermediary": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "logoUrl": { }, "taxPayerId": { }, "email": { }, "address": { }, "bankDetail": { }, "status": { }, "mergedIntoId": { }, "type": { }, "createdById": { }, "createdBy": { }, "bankId": { }, "bank": { }, "smsOriginatorId": { }, "systemPermissions": { }, "insurerIntermediaryBranches": { }, "insurerApiConfigs": { }, "districtId": { }, "district": { }, "insurerCodes": { } }, "policyId": "string", "policy": { "id": { }, "createdAt": { }, "updatedAt": { }, "clientId": { }, "client": { }, "policyNumber": { }, "status": { }, "approvedDate": { }, "startDate": { }, "endDate": { }, "partnerId": { }, "partner": { }, "insurerId": { }, "insurer": { }, "productId": { }, "product": { }, "createdById": { }, "createdBy": { }, "currency": { }, "exchangeRate": { }, "sourceOfBusiness": { }, "sourceOfBusinessId": { }, "premiumLevy": { }, "basicPremium": { }, "grossPremium": { }, "extensionsPremium": { }, "discountsPremium": { }, "intermediaryId": { }, "intermediary": { }, "branch": { }, "branchId": { }, "paymentPlanId": { }, "paymentPlan": { }, "cancellationType": { }, "premiumStatus": { }, "beneficiaryPolicies": { } }, "paymentPlanConfigId": 0, "paymentPlanConfig": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "description": { }, "frequency": { }, "numberOfInstallments": { }, "amountType": { }, "insurerId": { }, "status": { }, "isLevyRequired": { }, "requireInitialPayment": { }, "createdById": { }, "createdBy": { }, "productAssignments": { }, "intermediaryAssignments": { }, "partnerAssignments": { } }, "invoices": [ { } ], "approvedBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "approvedById": 0, "approvedAt": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "createdById": 0, "transactions": [ { } ], "isDeleted": true, "deletedAt": "string", "deletedById": 0, "configSnapshot": { "name": { }, "description": { }, "frequency": { }, "numberOfInstallments": { }, "amountType": { }, "insurerId": { }, "isLevyRequired": { }, "requireInitialPayment": { }, "snapshotTakenAt": { } }, "modeOfPayment": "string" }, "cancellationType": "string", "premiumStatus": "string", "beneficiaryPolicies": [ { "id": { }, "createdAt": { }, "updatedAt": { }, "beneficiaryId": { }, "beneficiary": { }, "policyId": { } } ], "name": "string", "claimNotificationDays": 0, "insuranceLevy": 0, "commissionRate": 0, "administrationRate": 0, "customRate": 0, "load": 0, "childMaximumAge": 0, "ageBands": [ { "fromAge": { }, "toAge": { }, "rate": { } } ], "benefits": [ { "benefitType": { }, "sumAssured": { } } ], "quotationId": "string", "quotation": { "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "corporateClientId": "string", "insurerId": "string", "intermediaryId": 0, "corporateClient": "string", "insurer": "string", "intermediary": "string", "product": "string", "partnerId": 0, "partner": { "id": { }, "createdAt": { }, "updatedAt": { }, "name": { }, "email": { }, "apiKey": { }, "logoUrl": { }, "address": { }, "apiUser": { }, "apiUserId": { }, "bankId": { }, "bank": { }, "paymentMethod": { }, "paymentMethods": { }, "smsOriginatorId": { }, "type": { }, "status": { }, "category": { }, "partnerSelfServiceApiKey": { }, "paymentCallbackUrl": { }, "paymentGateways": { }, "insurerApiConfigs": { } }, "productId": "string", "selectedScopeOfCoverIds": [ { } ], "freeCoverLimit": 0, "insuranceLevy": 0, "commissionRate": 0, "administrationRate": 0, "claimNotificationDays": 0, "status": "string", "createdById": "string", "createdBy": { "id": { }, "userName": { }, "normalizedUserName": { }, "email": { }, "normalizedEmail": { }, "emailConfirmed": { }, "passwordHash": { }, "securityStamp": { }, "concurrencyStamp": { }, "phoneNumber": { }, "phoneNumberConfirmed": { }, "twoFactorEnabled": { }, "lockoutEnd": { }, "lockoutEnabled": { }, "accessFailedCount": { }, "createdAt": { }, "updateAt": { }, "branchId": { }, "status": { }, "twoFactorMethod": { }, "lastSeen": { } }, "customRate": 0, "load": 0, "childMaximumAge": 0, "benefits": [ { } ], "ageBands": [ { } ] }, "members": [ { } ] }, "scheduleId": "string", "ageNextBirthday": 0, "sumAssured": 0, "appliedRate": 0, "netPremium": 0, "grossPremium": 0, "levy": 0, "daysProRata": 0, "status": "string", "beneficiaries": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "groupFuneralMemberId": "string", "fullName": "string", "relationship": "string", "dateOfBirth": "string", "ageNextBirthday": 0, "sumAssured": 0, "netPremium": 0, "grossPremium": 0, "levy": 0, "status": "string" } ]
{
}