API Reference

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

integer
Defaults to 1

The page of results

integer
Defaults to 20

Maximum Number of results per page

string
enum

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

string
enum

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'

Allowed:
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.

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.

integer
enum
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.

Allowed:
float

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

float

Employee's net monthly income

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

integer

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

string
enum
Defaults to recurring

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

Allowed:
integer
≤ 12

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

integer
≤ 12

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

string
enum

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

Allowed:
string
enum

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

Allowed:
integer

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

integer

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

date

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

integer

Duration of the life cover or savings plan

float

The life cover amount

float

The life cover 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.

enum

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

Allowed:
string

The medical practitioner's occupation. Required for medical malpractice products when calculate_premium is set to 1. Must be one of the valid options available for this product (use the field-options endpoint to get available options)

float

The maximum amount that can be paid out for a single claim. Required for medical malpractice products when calculate_premium is set to 1

float

The maximum total amount that can be paid out for all claims during the policy period. Required for medical malpractice products when calculate_premium is set to 1

Responses

Updated over 2 years ago

Language
Credentials
Bearer
API KEY from your account dashboard
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago