Get a single insurance product

get

https://api.playbox.grow.curacel.co/api/v1/products/{id}

This endpoint allows you to get a product using it's id

Path Params

integer

required

The ID of the product or the code of the product when the using_product_code parameter is set to 1

Query Params

asset_value

number

Required when calculate_premium is set to 1

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

enum

Defaults to recurring

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

Allowed:

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

calculate_premium

integer

enum

Defaults to 0

Set to 1 to calculate the premium value of the product. This is only necessary for relative products such as Goods In Transit (GIT).

Allowed:

using_product_code

integer

enum

Must be one of 1,0. Ideally, you should only use this with the value set to 1 only when the id path contains the code of the product. Simply omit it when using the product's id.

Allowed:

age

integer

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

occupation

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)

duration

integer

Duration of the policy coverage in months. Required for medical malpractice products when calculate_premium is set to 1

indemnity_limit

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

aggregated_claim_limit

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

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

200OK

404404 Not Found