v1.0.0

Inshuwa Partner API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

Digital Insurance Infrastructure API for distributing insurance products through your digital touchpoints.

Contact

Inshuwa Support

Servers

https://partner-dev-api.inshuwa.com/api/v1Development server

---

Individuals

Individual policyholder management

Operations

GET/policyholders/individualsPOST/policyholders/individualsGET/policyholders/{id}/individuals

---

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

Content-Type

application/json

{

  

"totalItems": 0,

  

"pageSize": 0,

  

"pageNumber": 0,

  

"totalPages": 0,

  

"data": [

  

]

}

GET

/policyholders/individuals

Playground

Authorization

BearerAuth

Variables

Key

Value

Query

FirstName

LastName

IdNumber

PhoneNumber

Email

PageNumber

PageSize

Samples

---

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

{

  

"email": "string",

  

"phoneNumber": "26021312312",

  

"physicalAddress": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"idNumber": "string",

  

"gender": "string",

  

"idType": "string"

}

Responses

Individual policyholder created

Content-Type

application/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"

}

POST

/policyholders/individuals

Playground

Authorization

BearerAuth

Body

Samples

---

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

string

Required

Responses

Individual policyholder

Content-Type

application/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

/policyholders/{id}/individuals

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

---

Corporates

Corporate policyholder management

Operations

GET/policyholders/corporatesPOST/policyholders/corporatesGET/policyholders/{id}/corporates

---

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

Content-Type

application/json

{

  

"totalItems": 0,

  

"pageSize": 0,

  

"pageNumber": 0,

  

"totalPages": 0,

  

"data": [

  

]

}

GET

/policyholders/corporates

Playground

Authorization

BearerAuth

Variables

Key

Value

Query

PageNumber

PageSize

Samples

---

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

{

  

"email": "string",

  

"bankDetail": {

  

  

"name": "string",

  

  

"branch": "string",

  

  

"accountNumber": "string",

  

  

"swiftCode": "string",

  

  

"accountName": "string"

  

},

  

"phoneNumber": "string",

  

"physicalAddress": "string",

  

"name": "string",

  

"taxPayerId": "string",

  

"postalAddress": "string",

  

"registrationNumber": "string",

  

"contactPerson": "string",

  

"contactPersonPhoneNumber": "string"

}

Responses

Corporate policyholder created

Content-Type

application/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"

}

POST

/policyholders/corporates

Playground

Authorization

BearerAuth

Body

Samples

---

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

string

Required

Responses

Corporate policyholder

Content-Type

application/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

/policyholders/{id}/corporates

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

---

Vehicles

Vehicle registration and lookup

Operations

GET/policyholders/{id}/vehiclesPOST/policyholders/{id}/vehiclesGET/policyholders/vehicles/search

---

Get client vehicles

GET

/policyholders/{id}/vehicles

Returns all vehicles registered under a client.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

string

Required

Query Parameters

Status

Type

string

Valid values

"HasPolicy""NoPolicy"

PageNumber

Type

integer

PageSize

Type

integer

Responses

List of vehicles

Content-Type

application/json

{

  

"totalItems": 0,

  

"pageSize": 0,

  

"pageNumber": 0,

  

"totalPages": 0,

  

"data": [

  

]

}

GET

/policyholders/{id}/vehicles

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Status

PageNumber

PageSize

Samples

---

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

string

Required

Request Body

application/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": 0

  

}

]

Responses

Vehicle created

Content-Type

application/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"

  

]

}

POST

/policyholders/{id}/vehicles

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Body

Samples

---

Search vehicles

GET

/policyholders/vehicles/search

Search for vehicles by registration number, chassis number, or engine number. Also returns insurance status.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

regNumber*

Vehicle registration number

Type

string

Required

Responses

Vehicle details

Content-Type

application/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"

  

]

}

GET

/policyholders/vehicles/search

Playground

Authorization

BearerAuth

Variables

Key

Value

regNumber*

Samples

---

Products

Insurance product catalog

Operations

GET/productsGET/products/motorGET/products/{productId}GET/products/travelGET/products/lifeGET/products/life/{productId}

---

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

Content-Type

application/json

{

  

"totalItems": 0,

  

"pageSize": 0,

  

"pageNumber": 0,

  

"totalPages": 0,

  

"data": [

  

]

}

GET

/products

Playground

Authorization

BearerAuth

Variables

Key

Value

Query

PageNumber

PageSize

Samples

---

Get all motor products

GET

/products/motor

Returns motor insurance products available to your partner account, including risk categories and premium rates. The response includes thirdPartyRates and comprehensiveRates arrays.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

PageNumber

Type

integer

PageSize

Type

integer

Responses

Motor products list

Content-Type

application/json

{

  

"totalItems": 0,

  

"pageSize": 0,

  

"pageNumber": 0,

  

"totalPages": 0,

  

"data": [

  

]

}

GET

/products/motor

Playground

Authorization

BearerAuth

Variables

Key

Value

PageNumber

PageSize

Samples

---

Get product by ID

GET

/products/{productId}

Returns a single product by its hashed ID, including full package and benefit details.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

productId*

Type

string

Required

Responses

Product details

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"insurer": "string",

  

"packages": [

  

]

}

GET

/products/{productId}

Playground

Authorization

BearerAuth

Variables

Key

Value

productId*

Samples

---

Get all travel products

GET

/products/travel

Returns travel insurance products with package details and pricing tiers. Each product contains packages with destination coverage, benefits, and premium amounts.

Authorizations

BearerAuth

Type

HTTP (bearer)

Responses

Travel products

Content-Type

application/json

[

  

{

  

}

]

GET

/products/travel

Playground

Authorization

BearerAuth

Samples

---

Get all life products

GET

/products/life

Returns life/micro-insurance products available to your partner account. Each product contains benefit tiers, coverage amounts, and premium rates.

Authorizations

BearerAuth

Type

HTTP (bearer)

Responses

Life products

Content-Type

application/json

[

  

{

  

}

]

GET

/products/life

Playground

Authorization

BearerAuth

Samples

---

Get life product by ID

GET

/products/life/{productId}

Returns a single life product by its hashed ID with full benefit and coverage details.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

productId*

Type

string

Required

Responses

Life product details

Content-Type

application/json

{

}

GET

/products/life/{productId}

Playground

Authorization

BearerAuth

Variables

Key

Value

productId*

Samples

---

Motor Quotations

Motor insurance quotations

Operations

POST/quotations/motor/inquiryPOST/quotations/motor/comparisonGET/quotations/motorPOST/quotations/motor

---

Motor quotation inquiry

POST

/quotations/motor/inquiry

Get a quick premium estimate for a motor insurance product without creating a formal quotation.

Authorizations

BearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"productId": "string",

  

"vehicleId": "string",

  

"startDate": "string",

  

"duration": 0,

  

"quarters": 0

}

Responses

Quotation inquiry result

Content-Type

application/json

{

}

POST

/quotations/motor/inquiry

Playground

Authorization

BearerAuth

Body

Samples

---

Motor quotation comparison

POST

/quotations/motor/comparison

Compare premiums across multiple motor insurance products for the same vehicle and coverage period.

Authorizations

BearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"vehicleId": "string",

  

"startDate": "string",

  

"duration": 0,

  

"quarters": 0

}

Responses

Comparison results

Content-Type

application/json

[

  

{

  

}

]

POST

/quotations/motor/comparison

Playground

Authorization

BearerAuth

Body

Samples

---

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

Content-Type

application/json

{

  

"totalItems": 0,

  

"pageSize": 0,

  

"pageNumber": 0,

  

"totalPages": 0,

  

"data": [

  

]

}

GET

/quotations/motor

Playground

Authorization

BearerAuth

Variables

Key

Value

StartDate

EndDate

ClientId

Query

PageNumber

PageSize

Samples

---

Create motor quotation

POST

/quotations/motor

Create a formal motor insurance quotation. Returns a quoteId used to issue a policy.

Authorizations

BearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"productId": "string",

  

"vehicleId": "string",

  

"clientId": "string",

  

"startDate": "string",

  

"duration": 0,

  

"quarters": 0

}

Responses

Motor quotation created

Content-Type

application/json

{

  

"id": "string",

  

"premium": 0,

  

"status": "string"

}

POST

/quotations/motor

Playground

Authorization

BearerAuth

Body

Samples

---

Travel Quotations

Travel insurance quotations

Operations

GET/quotations/travelPOST/quotations/travelGET/quotations/{quoteId}/travel

---

Get travel quotations

GET

/quotations/travel

Returns a list of travel quotations.

Authorizations

BearerAuth

Type

HTTP (bearer)

Responses

List of travel quotations

Content-Type

application/json

[

  

{

  

}

]

GET

/quotations/travel

Playground

Authorization

BearerAuth

Samples

---

Create travel quotation

POST

/quotations/travel

Create a travel insurance quotation. Returns a quoteId used to issue a policy.

Authorizations

BearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"packageId": "string",

  

"clientId": "string",

  

"destination": "string",

  

"startDate": "string",

  

"policyHolder": {

  

  

"firstName": "string",

  

  

"lastName": "string",

  

  

"email": "string",

  

  

"phoneNumber": "string",

  

  

"idNumber": "string",

  

  

"idType": "string",

  

  

"gender": "string",

  

  

"physicalAddress": "string"

  

},

  

"beneficiaries": [

  

  

{

  

  

}

  

]

}

Responses

Travel quotation created

Content-Type

application/json

{

}

POST

/quotations/travel

Playground

Authorization

BearerAuth

Body

Samples

---

Get travel quotation by ID

GET

/quotations/{quoteId}/travel

Returns a single travel quotation by its ID.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

quoteId*

Type

string

Required

Responses

Travel quotation

Content-Type

application/json

{

}

GET

/quotations/{quoteId}/travel

Playground

Authorization

BearerAuth

Variables

Key

Value

quoteId*

Samples

---

Travel Policies

Travel insurance policy management

Operations

POST/quotations/{quoteId}/travelPOST/quotations/travel/instant-issuePOST/policies/travel/{policyId}/renew/payGET/quotations/{policyId}/travel/documents/certificateGET/quotations/travel/policiesGET/quotations/travel/policies/{policyId}

---

Issue travel policy

POST

/quotations/{quoteId}/travel

Issue a travel policy by paying for a travel quotation.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

quoteId*

Type

string

Required

Request Body

application/json

{

  

"mobileMoneyAccountNumber": "string",

  

"cardDetails": {

  

},

  

"reference": "string"

}

Responses

Travel policy issued

Content-Type

application/json

{

}

POST

/quotations/{quoteId}/travel

Playground

Authorization

BearerAuth

Variables

Key

Value

quoteId*

Body

Samples

---

Instant issue travel policy

POST

/quotations/travel/instant-issue

Create, quote, and issue a travel policy in a single step with payment.

Authorizations

BearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"packageId": "string",

  

"clientId": "string",

  

"destination": "string",

  

"startDate": "string",

  

"policyHolder": {

  

  

"firstName": "string",

  

  

"lastName": "string",

  

  

"email": "string",

  

  

"phoneNumber": "string",

  

  

"idNumber": "string",

  

  

"idType": "string",

  

  

"gender": "string",

  

  

"physicalAddress": "string"

  

},

  

"beneficiaries": [

  

  

{

  

  

}

  

],

  

"mobileMoneyAccountNumber": "string",

  

"cardDetails": {

  

},

  

"reference": "string"

}

Responses

Travel policy issued instantly

Content-Type

application/json

{

}

POST

/quotations/travel/instant-issue

Playground

Authorization

BearerAuth

Body

Samples

---

Renew and pay travel policy

POST

/policies/travel/{policyId}/renew/pay

Renew a travel insurance policy with payment.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Request Body

application/json

{

  

"startDate": "string",

  

"endDate": "string",

  

"destination": "string",

  

"reference": "string",

  

"payment": {

  

}

}

Responses

Travel policy renewed and paid

Content-Type

application/json

{

}

POST

/policies/travel/{policyId}/renew/pay

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Body

Samples

---

Get travel policy certificate

GET

/quotations/{policyId}/travel/documents/certificate

Download the insurance certificate for a travel policy.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Responses

Travel policy certificate

Content-Type

application/pdf

GET

/quotations/{policyId}/travel/documents/certificate

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Samples

---

Get travel policies

GET

/quotations/travel/policies

Returns a list of issued travel insurance policies.

Authorizations

BearerAuth

Type

HTTP (bearer)

Responses

List of travel policies

Content-Type

application/json

[

  

{

  

}

]

GET

/quotations/travel/policies

Playground

Authorization

BearerAuth

Samples

---

Get travel policy by ID

GET

/quotations/travel/policies/{policyId}

Returns a single travel insurance policy by its ID.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Responses

Travel policy details

Content-Type

application/json

{

}

GET

/quotations/travel/policies/{policyId}

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Samples

---

Life Quotations

Life insurance quotations

Operations

GET/quotations/lifePOST/quotations/lifeGET/quotations/{quoteId}/life

---

Get life quotations

GET

/quotations/life

Returns a list of life insurance quotations.

Authorizations

BearerAuth

Type

HTTP (bearer)

Responses

List of life quotations

Content-Type

application/json

[

  

{

  

}

]

GET

/quotations/life

Playground

Authorization

BearerAuth

Samples

---

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

{

  

"startDate": "string",

  

"packageId": "string",

  

"clientId": "string",

  

"policyHolder": {

  

  

"firstName": "string",

  

  

"lastName": "string",

  

  

"email": "string",

  

  

"phoneNumber": "string",

  

  

"idNumber": "string",

  

  

"idType": "string",

  

  

"gender": "string",

  

  

"physicalAddress": "string"

  

},

  

"nextOfKin": {

  

},

  

"beneficiaries": [

  

  

{

  

  

}

  

],

  

"beneficiaryAddonAmmount": 0

}

Responses

Life quotation created

Content-Type

application/json

{

}

POST

/quotations/life

Playground

Authorization

BearerAuth

Body

Samples

---

Get life quotation by ID

GET

/quotations/{quoteId}/life

Returns a single life insurance quotation by its ID.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

quoteId*

Type

string

Required

Responses

Life quotation

Content-Type

application/json

{

}

GET

/quotations/{quoteId}/life

Playground

Authorization

BearerAuth

Variables

Key

Value

quoteId*

Samples

---

Life Policies

Life insurance policy management

Operations

POST/quotations/{quoteId}/lifePOST/quotations/life/instant-issuePOST/policies/life/{quoteId}/renew/payGET/quotations/{policyId}/life/documents/certificateGET/quotations/life/policiesGET/quotations/life/policies/{policyId}

---

Issue life policy

POST

/quotations/{quoteId}/life

Issue a life policy by paying for a life quotation.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

quoteId*

Type

string

Required

Request Body

application/json

{

  

"mobileMoneyAccountNumber": "string",

  

"cardDetails": {

  

},

  

"reference": "string"

}

Responses

Life policy issued

Content-Type

application/json

{

}

POST

/quotations/{quoteId}/life

Playground

Authorization

BearerAuth

Variables

Key

Value

quoteId*

Body

Samples

---

Instant issue life policy

POST

/quotations/life/instant-issue

Create, quote, and issue a life policy in a single step with payment.

Authorizations

BearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"startDate": "string",

  

"packageId": "string",

  

"clientId": "string",

  

"nextOfKin": {

  

},

  

"beneficiaries": [

  

  

{

  

  

}

  

],

  

"beneficiaryAddonAmmount": 0,

  

"mobileMoneyAccountNumber": "string",

  

"cardDetails": {

  

},

  

"reference": "string"

}

Responses

Life policy issued instantly

Content-Type

application/json

{

}

POST

/quotations/life/instant-issue

Playground

Authorization

BearerAuth

Body

Samples

---

Renew and pay life policy

POST

/policies/life/{quoteId}/renew/pay

Renew a life insurance policy with payment.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

quoteId*

Type

string

Required

Request Body

application/json

{

  

"startDate": "string",

  

"endDate": "string",

  

"reference": "string",

  

"payment": {

  

}

}

Responses

Life policy renewed and paid

Content-Type

application/json

{

}

POST

/policies/life/{quoteId}/renew/pay

Playground

Authorization

BearerAuth

Variables

Key

Value

quoteId*

Body

Samples

---

Get life policy certificate

GET

/quotations/{policyId}/life/documents/certificate

Download the insurance certificate for a life policy.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Responses

Life policy certificate

Content-Type

application/pdf

GET

/quotations/{policyId}/life/documents/certificate

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Samples

---

Get life policies

GET

/quotations/life/policies

Returns a list of issued life insurance policies.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

Statuses

Type

string

Responses

List of life policies

Content-Type

application/json

[

  

{

  

}

]

GET

/quotations/life/policies

Playground

Authorization

BearerAuth

Variables

Key

Value

Statuses

Samples

---

Get life policy by ID

GET

/quotations/life/policies/{policyId}

Returns a single life insurance policy by its ID.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Responses

Life policy details

Content-Type

application/json

{

}

GET

/quotations/life/policies/{policyId}

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Samples

---

Payments

Payment processing

Operations

POST/payments/{quoteId}/payGET/payments/transactions/{reference}/status

---

Pay for quotation

POST

/payments/{quoteId}/pay

Initiate a payment for a motor insurance quotation. Supports mobile money (Airtel, MTN, Zamtel), card (Visa/Mastercard), and mobile banking.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

quoteId*

Type

string

Required

Request Body

application/json

{

  

"reference": "string",

  

"payment": {

  

  

"method": "string",

  

  

"mobileMoneyAccountNumber": "string",

  

  

"cardDetails": {

  

  

}

  

}

}

Responses

Payment initiated

Content-Type

application/json

{

  

"status": "string",

  

"reference": "string"

}

POST

/payments/{quoteId}/pay

Playground

Authorization

BearerAuth

Variables

Key

Value

quoteId*

Body

Samples

---

Get transaction status

GET

/payments/transactions/{reference}/status

Check the status of a payment transaction by its reference number.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

reference*

Type

string

Required

Responses

Transaction status

Content-Type

application/json

{

  

"reference": "string",

  

"status": "string",

  

"amount": 0,

  

"currency": "string"

}

GET

/payments/transactions/{reference}/status

Playground

Authorization

BearerAuth

Variables

Key

Value

reference*

Samples

---

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/{referenceId}GET/policies/motor/risk-categoriesGET/policies/motor/vehicle/{registrationNumber}GET/policies/motor/{id}/documents/scheduleGET/policies/motor/{id}/documents/certificateGET/policies/motor/{id}/documents/receiptPOST/policies/motor/{policyId}/extension/premiumsPOST/policies/motor/{policyId}/renew/premiums

---

Issue motor policy

POST

/policies/motor/{quoteId}/issue

Issue a motor insurance policy from an existing paid quotation.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

quoteId*

Type

string

Required

Query Parameters

reference

Type

string

Responses

Motor policy issued

Content-Type

application/json

{

}

POST

/policies/motor/{quoteId}/issue

Playground

Authorization

BearerAuth

Variables

Key

Value

quoteId*

reference

Samples

---

Instant issue motor policy

POST

/policies/motor/instant/issue

Create and issue a motor policy in a single step without a separate quotation.

Authorizations

BearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"productId": "string",

  

"vehicleId": "string",

  

"clientId": "string",

  

"startDate": "string",

  

"duration": 0,

  

"quarters": 0

}

Responses

Motor policy issued instantly

Content-Type

application/json

{

}

POST

/policies/motor/instant/issue

Playground

Authorization

BearerAuth

Body

Samples

---

Instant issue and pay motor policy

POST

/policies/motor/instant/issue/pay

Create, issue, and pay for a motor policy in a single step.

Authorizations

BearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"productId": "string",

  

"vehicleId": "string",

  

"clientId": "string",

  

"startDate": "string",

  

"duration": 0,

  

"quarters": 0,

  

"reference": "string",

  

"payment": {

  

}

}

Responses

Motor policy issued and paid

Content-Type

application/json

{

}

POST

/policies/motor/instant/issue/pay

Playground

Authorization

BearerAuth

Body

Samples

---

Renew motor policy

POST

/policies/motor/{policyId}/renew

Renew an existing motor insurance policy.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Request Body

application/json

{

  

"quarters": 0,

  

"duration": 0,

  

"startDate": "string"

}

Responses

Motor policy renewed

Content-Type

application/json

{

}

POST

/policies/motor/{policyId}/renew

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Body

Samples

---

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

string

Required

Request Body

application/json

{

  

"quarters": 0,

  

"duration": 0,

  

"startDate": "string",

  

"reference": "string",

  

"payment": {

  

}

}

Responses

Motor policy renewed and paid

Content-Type

application/json

{

}

POST

/policies/motor/{policyId}/renew/pay

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Body

Samples

---

Extend motor policy

POST

/policies/motor/{policyId}/extend

Extend an existing motor insurance policy duration.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Request Body

application/json

{

  

"quarters": 0

}

Responses

Motor policy extended

Content-Type

application/json

{

}

POST

/policies/motor/{policyId}/extend

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Body

Samples

---

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

string

Required

Request Body

application/json

{

  

"quarters": 0,

  

"reference": "string",

  

"payment": {

  

}

}

Responses

Motor policy extended and paid

Content-Type

application/json

{

}

POST

/policies/motor/{policyId}/extend/pay

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Body

Samples

---

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

Content-Type

application/json

{

  

"totalItems": 0,

  

"pageSize": 0,

  

"pageNumber": 0,

  

"totalPages": 0,

  

"data": [

  

]

}

GET

/policies/motor

Playground

Authorization

BearerAuth

Variables

Key

Value

Statuses

StartDate

EndDate

ClientId

Query

PageNumber

PageSize

Samples

---

Get motor policy by reference

GET

/policies/motor/{referenceId}

Returns a motor insurance policy by its reference ID.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

referenceId*

Type

string

Required

Responses

Motor policy details

Content-Type

application/json

{

}

GET

/policies/motor/{referenceId}

Playground

Authorization

BearerAuth

Variables

Key

Value

referenceId*

Samples

---

Get motor risk categories

GET

/policies/motor/risk-categories

Returns the list of motor insurance risk categories (e.g., private, commercial, PSV).

Authorizations

BearerAuth

Type

HTTP (bearer)

Responses

List of risk categories

Content-Type

application/json

[

  

{

  

}

]

GET

/policies/motor/risk-categories

Playground

Authorization

BearerAuth

Samples

---

Get policy by vehicle registration

GET

/policies/motor/vehicle/{registrationNumber}

Returns the active motor policy for a vehicle by its registration number.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

registrationNumber*

Type

string

Required

Responses

Motor policy for vehicle

Content-Type

application/json

{

}

GET

/policies/motor/vehicle/{registrationNumber}

Playground

Authorization

BearerAuth

Variables

Key

Value

registrationNumber*

Samples

---

Get policy schedule document

GET

/policies/motor/{id}/documents/schedule

Download the policy schedule PDF for a motor insurance policy.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

string

Required

Responses

Policy schedule PDF

Content-Type

application/pdf

GET

/policies/motor/{id}/documents/schedule

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

---

Get insurance certificate

GET

/policies/motor/{id}/documents/certificate

Download the insurance certificate PDF for a motor insurance policy.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

string

Required

Responses

Insurance certificate PDF

Content-Type

application/pdf

GET

/policies/motor/{id}/documents/certificate

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

---

Get payment receipt

GET

/policies/motor/{id}/documents/receipt

Download the payment receipt PDF for a motor insurance policy.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

string

Required

Responses

Payment receipt PDF

Content-Type

application/pdf

GET

/policies/motor/{id}/documents/receipt

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

---

Calculate extension premium

POST

/policies/motor/{policyId}/extension/premiums

Calculate the premium amount for a motor policy extension.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Request Body

application/json

{

  

"duration": 0,

  

"startDate": "string"

}

Responses

Extension premium calculation

Content-Type

application/json

{

}

POST

/policies/motor/{policyId}/extension/premiums

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Body

Samples

---

Calculate renewal premium

POST

/policies/motor/{policyId}/renew/premiums

Calculate the premium amount for a motor policy renewal.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Request Body

application/json

{

  

"duration": 0,

  

"startDate": "string"

}

Responses

Renewal premium calculation

Content-Type

application/json

{

}

POST

/policies/motor/{policyId}/renew/premiums

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Body

Samples

---

General Policies

General insurance policy management

Operations

POST/policies/{policyId}/issuePOST/policies/{policyId}/renewPOST/policies/instant/issueGET/policies

---

Issue general policy

POST

/policies/{policyId}/issue

Issue a general insurance policy from a quotation.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Request Body

application/json

{

  

"endDate": "string"

}

Responses

General policy issued

Content-Type

application/json

{

}

POST

/policies/{policyId}/issue

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Body

Samples

---

Renew general policy

POST

/policies/{policyId}/renew

Renew an existing general insurance policy.

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Request Body

application/json

{

  

"startDate": "string",

  

"endDate": "string"

}

Responses

General policy renewed

Content-Type

application/json

{

}

POST

/policies/{policyId}/renew

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Body

Samples

---

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

{

  

"productId": "string",

  

"quarters": 0,

  

"currency": "ZMW",

  

"startDate": "string",

  

"policyHolder": {

  

  

"firstName": "string",

  

  

"lastName": "string",

  

  

"email": "string",

  

  

"phoneNumber": "string",

  

  

"idNumber": "string",

  

  

"idType": "string",

  

  

"gender": "string",

  

  

"physicalAddress": "string"

  

},

  

"risks": [

  

  

{

  

  

}

  

]

}

Responses

General policy issued instantly

Content-Type

application/json

{

}

POST

/policies/instant/issue

Playground

Authorization

BearerAuth

Body

Samples

---

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

Content-Type

application/json

{

  

"totalItems": 0,

  

"pageSize": 0,

  

"pageNumber": 0,

  

"totalPages": 0,

  

"data": [

  

]

}

GET

/policies

Playground

Authorization

BearerAuth

Variables

Key

Value

PageNumber

PageSize

Samples

---

Insurers

Insurer information

Operations

GET/insurers

---

Get all insurers

GET

/insurers

Returns the list of insurance companies available on the Inshuwa platform.

Authorizations

BearerAuth

Type

HTTP (bearer)

Responses

List of insurers

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"code": "string"

  

}

]

GET

/insurers

Playground

Authorization

BearerAuth

Samples

---