Benefits | Documentation

curl https://api-staging.nibtravelinsurance.com/products/v1/nibau/plans/1000000/benefits \
     -H "Authorization: Bearer <token>"

{
  "expirySeconds": 86400,
  "planId": 280,
  "displayLimitsPerPolicy": true,
  "effectiveFromDate": "effectiveFromDate",
  "effectiveToDate": "effectiveToDate",
  "benefits": [
    {
      "benefitId": 10971,
      "code": "OVERSEASMEDICAL",
      "optionTypeCode": "optionTypeCode",
      "displayOrder": 10,
      "name": "Overseas medical expenses",
      "description": "Emergency overseas medical expenses including hospitals, doctors, day surgery, outpatient treaments and prescribed medicines, for up to a year after the sudden illness (including coronavirus) first appeared or the serious injury first occurred.",
      "longDescription": "<a href=\"{PolicyUrl}section-11-overseas-medical-expenses\" target=\"_blank\"> Emergency overseas medical expenses</a> including hospitals, doctors, day surgery, outpatient treatments and prescribed medicines, for up to a year after the sudden illness (including coronavirus) first appeared or the serious injury first occurred.",
      "appliesToDependents": false,
      "perPolicyHolderLimit": 5000000,
      "perPolicyLimit": 1.1,
      "limitLabel": "limitLabel",
      "limitDescription": "limitDescription"
    },
    {
      "benefitId": 11306,
      "code": "CORONAVIRUSTRAVELCOSTS",
      "optionTypeCode": "optionTypeCode",
      "displayOrder": 15,
      "name": "Coronavirus Travel Costs",
      "description": "This benefit under the Explorer Plan offers cover for 8 specific events related to coronavirus, such as contracting the virus causing you to cancel the trip or causing your quarantine; a healthcare worker's leave being cancelled; or you being denied boarding due to your suspected infection with coronavirus. This is a separate benefit to the cover offered for coronavirus for Overseas medical expenses and Emergency medical transport & repatriation.",
      "longDescription": "This benefit under the Explorer Plan offers cover for 8 specific events related to coronavirus, such as contracting the virus causing you to cancel the trip or causing your quarantine; a healthcare worker's leave being cancelled; or you being denied boarding due to your suspected infection with coronavirus. This is a separate benefit to the cover offered for coronavirus for Overseas medical expenses and Emergency medical transport & repatriation.",
      "appliesToDependents": false,
      "perPolicyHolderLimit": 1.1,
      "perPolicyLimit": 1.1,
      "limitLabel": "limitLabel",
      "limitDescription": "Not Insured"
    }
  ],
  "availableTranslations": {
    "key": "value"
  }
}

Returns detailed configuration data about the Benefits for an insurance plan

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

brandCodeenumRequired

Brand code

Allowed values:

planIdlongRequiredDefaults to 0

Query parameters

langstringOptional

effectiveAtstringOptional

Response

Success

expirySecondsinteger

planIdlongDefaults to 0

displayLimitsPerPolicybooleanDefaults to false

effectiveFromDatestring

effectiveToDatestring

benefitslist of objects

availableTranslationsmap from strings to optional strings