List available insurance products

get https://api.playbox.grow.curacel.co/api/v1/products

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

Query Params

string

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

page

integer

Defaults to 1

The page of results

per_page

integer

Defaults to 20

Maximum Number of results per page

type

string

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

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

Defaults to 0

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

1 to 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

Defaults to recurring

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

loan_duration

integer

≤ 12

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

travel_duration

integer

≤ 12

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

shipment_type

string

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

clause

string

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

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

Responses

Language

Credentials

Bearer

API KEY from your account dashboard

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.playbox.grow.curacel.co/api/v1/products?page=1&per_page=20&calculate_premium=0&trip_frequency=recurring' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

422Unprocessable Content