Skip to main content

All Policies

List all the policies available on your platform. The list contains the client ID and Name, endDate, limit, page, policy number, Staff ID and Name, StartDate and State of the policy as indicated in the query parameters below. This endpoint allows you to query all the policies.

GET /api/v1/client/policies

Headers​

authorization : bearer token
sessionToken : client session token

Query param​

NameDescriptionType
clientIdThe Id of the clientstring
clientNameThe name of the clientstring
endDateFilter policies by end dateArray of strings
limitNumber of items to return per page. Example: limit=50number
pagePage number. Example: page=1number
policyNoPolicy no.string
staffIdStaff Id.string
staffNameStaff name.string
startDateFilter policies by start date.Array of strings
stateEnum: "DRAFT" "PROCESSING" "CANCELLED" "AWAITING_DEBIT" "ACTIVE" "UNDER_WRITER" "ACCOUNT_RECEIVABLE" "COMPLETE" "EXPIRED"Array of strings

Example Success Response​

policyNo
string

Optional policy number

coverageType
string

Optional coverage type for the policy. It is automatically derived from product information (if any)

generateInvoice
boolean
Default: true

Whether the system should auto generate a debit after creating the policy

currency
required
string

Policy currency code. Refer to /currencies for available currencies.

startDate
required
string

Policy start date in iso8601 format

endDate
required
string

Policy end date in iso8601 format

oldPolicyId
string

The id of the old policy, if any.
This is used only if business type of the policy is RENEWAL

originatingStaffId
string

The staff who sold the policy to the client. If null, currently logged in staff will be used.
Optional if the policy is created from a client application

notes
string

Additional notes about the policy

premium
required
number >= 1

Policy premium

exchangeRate
number >= 0
Default: 1

Currency exchange rate

businessType
required
string
Enum: "NEW_BUSINESS" "CROSS_SELLING" "RENEWAL" "EXTENSION"

Policy business type

businessCategory
string
Default: "LOCAL"
Enum: "LOCAL" "GLOBAL"

Business category of the policy. Default is LOCAL

coverType
string

Provided coverType if the policy uses one coverType for all assets.
If some assets have different coverTypes, then it must be provided in the assets property

policyType
string
Enum: "AUTO" "BANKERS_INDEMNITY" "BLANKET_BOND" "BONDS" "BOILER_OR_PRESSURE_VESSEL" "BURGLARY" "BUSINESS_INTERRUPTION" "MONEY" "DIRECTORS_OFFICERS_LIABILITY" "ELECTRONIC_EQUIPMENT" "EMPLOYERS_LIABILITY" "ERECTION_ALL_RISKS" "CONTRACTORS_ALL_RISKS" "FIDELITY_GUARANTEE" "GENERAL_LIABILITY" "GOODS_IN_TRANSIT" "GROUP_PERSONAL_ACCIDENT" "HOME" "MARINE" "PERSONAL_ACCIDENT" "PLANT_ALL_RISKS" "PLANT_AND_MACHINERY" "PROFESSIONAL_INDEMNITY" "PROPERTY_DAMAGE" "PUBLIC_LIABILITY" "TRAVEL" "AVIATION" "WORKMENS_COMPENSATION" "FIRE_AND_ALLIED_PERILS" "ASSETS_ALL_RISKS" "AGRICULTURAL" "STOCK_DETERIORATION" "MOTOR_TRADERS" "LIFE" "GROUP_LIFE_PERSONAL_ACCIDENT" "GROUP_LIFE" "GROUP_FUNERAL" "HEALTH" "PENSION"

Type of policy

object

Additional information about the policy

groupId
string

Id of the group which the policy belongs to

description
string

Additional notes about the policy

required
object

Client information

required
object

Product information

object

The staff who created the policy on the system.
Value is null if the policy is created by the client

object

Similar to createdBy, but is the staff who actually sold the policy to the client.
Value is null if the policy is created by the client

{
  • "policyNo": "POL-0012",
  • "coverageType": "MOTOR_COMPREHENSIVE",
  • "generateInvoice": true,
  • "currency": "GHS",
  • "startDate": "2020-01-01T00:00:00.000Z",
  • "endDate": "2020-12-01T00:00:00.000Z",
  • "oldPolicyId": "619c0911b46b424f5f3e470f",
  • "originatingStaffId": "619c0911b46b424f5f3e470f",
  • "notes": "This is an auto insurance policy. It covers a car.",
  • "premium": 5000,
  • "exchangeRate": 1,
  • "businessType": "NEW_BUSINESS",
  • "businessCategory": "LOCAL",
  • "coverType": "COMPREHENSIVE",
  • "policyType": "AUTO",
  • "additionalInformation": {
    },
  • "groupId": "63403b8a088f7a3cd5f8e717",
  • "description": "This is an auto insurance policy. It covers a car.",
  • "client": {
    },
  • "product": {
    },
  • "createdBy": {
    },
  • "originatingStaff": {
    }
}