Benefits | Documentation

1 import requests 2 3 url = "https://api-staging.nibtravelinsurance.com/products/v1/nibau/plans/1000000/benefits" 4 5 headers = {"Authorization": "Bearer <token>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "expirySeconds": 86400, 3 "planId": 280, 4 "displayLimitsPerPolicy": true, 5 "effectiveFromDate": "effectiveFromDate", 6 "effectiveToDate": "effectiveToDate", 7 "benefits": [ 8 { 9 "benefitId": 10971, 10 "code": "OVERSEASMEDICAL", 11 "optionTypeCode": "optionTypeCode", 12 "displayOrder": 10, 13 "name": "Overseas medical expenses", 14 "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.", 15 "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.", 16 "appliesToDependents": false, 17 "perPolicyHolderLimit": 5000000, 18 "perPolicyLimit": 1.1, 19 "limitLabel": "limitLabel", 20 "limitDescription": "limitDescription" 21 }, 22 { 23 "benefitId": 11306, 24 "code": "CORONAVIRUSTRAVELCOSTS", 25 "optionTypeCode": "optionTypeCode", 26 "displayOrder": 15, 27 "name": "Coronavirus Travel Costs", 28 "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.", 29 "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.", 30 "appliesToDependents": false, 31 "perPolicyHolderLimit": 1.1, 32 "perPolicyLimit": 1.1, 33 "limitLabel": "limitLabel", 34 "limitDescription": "Not Insured" 35 } 36 ], 37 "availableTranslations": { 38 "key": "value" 39 } 40 }

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 or null

planIdlong or nullDefaults to 0

displayLimitsPerPolicyboolean or nullDefaults to false

effectiveFromDatestring or null

effectiveToDatestring or null

benefitslist of objects or null

availableTranslationsmap from strings to optional strings or null