Skip to main content

Fetch Product By ID

View detail information about a specific product using its ID .
GET /api/v1/client/products/:id

Headers​

authorization : bearer token
sessionToken : client session token

Path params​

NameDescriptionRequiredType
idUnique ID of a productRequiredstring

Sample response​

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": {
    }
}