List available insurance products

GET 
/v1/products

This endpoint allows you to retrieve a list of available insurance products.

Request

Query Parameters

q string

Any text supplied here would be used to search products by their names

page integer

Default value: 1

The page of results

per_page integer

Default value: 20

Maximum Number of results per page

type string

Possible values: [health, 3rd_party_auto, comprehensive_auto, life, marine, git, credit_life, fire_burglary, gadget, job_loss, personal_accident, micro_health, travel, investment_life, investment]

Filter the products returned by product type. Must be the slug of one of the types as available on the product-types endpoint e.g health, auto, life, etcetera.
This is required, if you wish to use the 'calculate-premium' parameter listed below. 'auto' is an alias

with string

Possible values: [cover_benefits, travel_plans]

Include additional information within the response.
For Example: To add the cover benefits to the product result, the with parameter is valid for this use case.
'?with=cover_benefits'

insurer_country string

Use this to limit the products to only the ones that are insured by companies based in the country specified. This accepts an ISO alpha-2 country code.

travel_country string

For Travel products, use this parameter to limit the list to products that covers the country specified. This accepts an ISO alpha-2 country code.

calculate_premium integer

Possible values: [0, 1]

Set to 1 to calculate the premium value of the products returned. The type parameter must be supplied to use this parameter.

asset_value float

Value of the insured asset. May be required when calculate_premium is set to 1

net_income float

Employee's net monthly income

trip_days_per_year integer

Possible values: >= 1 and <= 365

Number of days in a year that have trips (max of 365). Required for 'recuring' GIT products when calculate_premium is set to 1

trips_per_day integer

Number of trips per day. Required for 'recuring' GIT products when calculate_premium is set to 1

trip_frequency string

Possible values: [single, recurring]

Default value: recurring

Frequency of trips. Required for GIT product when calculate_premium is set to 1

loan_duration integer

Possible values: <= 12

Loan duration in months. Required for credit life products when calculate_premium is set to

travel_duration integer

Possible values: <= 12

Travel duration in months. Required for travel products when calculate_premium is set to 1

shipment_type string

Possible values: [import, export]

For marine products. Use this to limit the results to products that cover the specified shipment type.

clause string

Possible values: [A, C]

For marine products. Use this to limit the results to products that cover the specified clause.

age integer

The age of the policy holder. May be required for some product types when calculate_premium is set to 1

beneficiaries integer

When attempting to calculate the premium of some products that require beneficiaries, please pass the total number of beneficiaries here.

policy_start_date date

When required, please provide the start date of the intended policy purchase here

duration integer

Duration of the life cover or savings plan

cover_amount float

The life cover amount

life_cover_amount float

The life cover amount

monthly_savings_amount float

How much would be saved on monthly basis. Note that if a quarterly savings_frequency is chosen, then expected amount every quarter is monthly_savings_amount multiplied by 3. The same applies to other frequencies.

savings_frequency any

How often savings will be made until the duration is complete.

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
title string
The name of the product
code string
The unique identifier for technical purposes
id integer
Unique Id of the product.
insurer object
An insurance provider
code string
The unique code of the insurer
name string
The name of the insurer
logo_url string
A link to the Insurer's logo
terms_conditions string
Insurer's terms and conditions
product type object
A major category of insurance e.g Health, Automobile, Life, Gadget, Goods in transit, etc
name string
The generally accepted human friendly name
slug string
The unique identifier for technical purposes
cover-benefits object
list of the nefits covered.
created-at string
Date of product creation
price integer
Price of product
premium-type string
Define the product premium tier.
premium-rate-unit integer
premium-rate number
premium number
partner-commision-rate number
min-premium string
premium-rules string
premium_frequency string
Possible values: [monthly, quarterly, annually]
Default value: annually
]
links object
first string
last string
prev string
next string

Example (from schema)

{
  "data": [
    {
      "title": "Comprehensive Car Plan XYZ",
      "code": "auto-com-xyz",
      "id": 1,
      "insurer": {
        "code": "AXA",
        "name": "Axa Mansard",
        "logo_url": null,
        "terms_conditions": null
      },
      "product type": {
        "name": "Goods in Transit",
        "slug": "GIT"
      },
      "cover-benefits": {},
      "created-at": "string",
      "price": 0,
      "premium-type": "string",
      "premium-rate-unit": 0,
      "premium-rate": 0,
      "premium": 0,
      "partner-commision-rate": 0,
      "min-premium": "string",
      "premium-rules": "string",
      "premium_frequency": "annually"
    }
  ],
  "links": {
    "first": "https://api.grow.curacel.co/products?page=1",
    "last": "https://api.grow.curacel.co/products?page=3",
    "prev": "https://api.grow.curacel.co/products?page=1",
    "next": "https://api.grow.curacel.co/products?page=2"
  }
}

422

Unprocessable Content

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "The given data was invalid"
}

Loading...