Skip to main content

List of Products

Fetch of list all the products available on your platform. This endpoint allows you to query all the products (including inactive products).

GET /api/v1/client/products

Headers​

authorization : bearer token
session : client session token

Query Params​

By using one or a combination of these parameters, you choose a specific product that should be added to the response.

NameSettingDescriptionRequiredType
assignedDefault: falseGet only products which
have been assigned to
brokers or agents		Not Requiredboolean
categoryExample: category=AUTOFilter products by category nameNot Requiredstring
distributionEnum: "ONLINE" "OFFLINE"
Example: description=OFFLINE		Filter products by distributionNot Requiredstring
insurerExample: insurer=GLICO InsuranceFilter products by insurer's nameNot Requiredstring
limitDefault: 100
Example: limit=50		Number of items to return per pageNot Requiredstring
nameExample: name=Motor ComprehensionFilter products by nameNot Requiredstring
pageDefault: 1
Example: page=1		Page numberNot Requirednumber
subCategoryExample: subCategory=COMPREHENSIVEFilter products by subcategory nameNot Requiredstring

Response Sample​

name
required
string

The poduct's name

code
string

The code used by the insurer to identify the product

description
string

Short description of the product

premiumRates
object (Map)
category
required
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"

Category of the product

subCategory
required
string

The sub category of the product

benefits
required
Array of strings

Benefits of the product

object (ProductCommissionDto)
status
required
string
Default: "ACTIVE"
Enum: "ACTIVE" "DEACTIVATED"

The status of the product (active or inactive). Policies can be created only if the product is active

distribution
required
string
Default: "OFFLINE"
Enum: "ONLINE" "OFFLINE"

Whether the product is available in client applications (ONLINE) eg. mobile app or to only staffs (OFFLINE)

id
required
string

Unique ID of the product

Array of objects (CompanyRespDto)

Agents & Brokers to which the product has also been assigned

required
object

The insurer (owner company) of the product - is not null if product is an assigned one

createdAt
required
string <date-time>

Date at which the product was created

assignedAt
string <date-time>

Date at which the product was assigned

updatedAt
required
string <date-time>

Date at which the product was updated

object

The staff who created the product

object

The staff who assigned the product

required
object (ProductCommissionDto)
required
object (ProductCommissionDto)
{
  • "name": "Motor Insurance",
  • "code": "CLAGC",
  • "description": "lorem ipsum dolor sit amet",
  • "premiumRates": { },
  • "category": "AUTO",
  • "subCategory": "COMPREHENSIVE",
  • "benefits": [
    ],
  • "otherCommission": {
    },
  • "status": "ACTIVE",
  • "distribution": "OFFLINE",
  • "id": "619c0911b46b424f5f3e470f",
  • "assignedTo": [
    ],
  • "insurer": {
    },
  • "createdAt": "2020-05-05T00:00:00.000Z",
  • "assignedAt": "2020-05-05T00:00:00.000Z",
  • "updatedAt": "2020-05-05T00:00:00.000Z",
  • "createdBy": {
    },
  • "assignedBy": {
    },
  • "standardCommission": {
    },
  • "overriderCommission": {
    }
}