Skip to main content

Get a single insurance product

GET 
/v1/products/:id

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

Request​

Path Parameters

    id integerrequired

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

Query Parameters

    asset_value number

    Required when calculate_premium is set to 1

    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

    calculate_premium integer

    Possible values: [0, 1]

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

    using_product_code integer

    Possible values: [0, 1]

    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.

    age integer

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

Responses​

OK

Schema
    data object

    An individual insurance product or plan

    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

Loading...