Skip to content

Insurance Search

  • The Insurance Search API is designed to assist users in finding suitable travel insurance plans.
  • By providing details such as travel dates, origin, destination, and passenger ages, users can receive a list of available insurance plans. The API offers comprehensive information about each plan, including coverage details, premium information, and important conditions. This endpoint facilitates a user-friendly comparison of different insurance options to help users make well-informed decisions when purchasing travel insurance.
  • For users seeking additional coverage, the API includes details about rider plans. These plans offer supplementary benefits to enhance the overall coverage.

API service end point 

/api/v1/insurance/search

Insurance Search Request

Tags Attribute Description
InsuranceSearchCriteria (JsonObject)
segments (JsonArray) Maximum number of segment allowed is one.
segment segment*
(JsonObject)
startDate*
(Date)		 Start date of the insurance coverage, in the format "YYYY-MM-DD".
endDate*
(Date)		 End date of the insurance coverage, in the format "YYYY-MM-DD".
fromIata*
(String)		 This tag indicates the source airport location
fromCountryCode*
(String)		 This tag indicates the source location country code
toIata*
(String)		 This tag indicates the destination airport location
toCountryCode*
(String)		 This tag indicates the destination location country code
travelerNationality travelerNationality*
(String)		 Traveller nationality - EG:IN,AE
passengerAges passengerAges *
(JsonArray)
passengerAge passengerAge *
(JsonObject)
years*
(Integer)		 This tag indicates age of passenger in years.
months
(Integer)		 This tag indicates age of passenger in months, not mandatory for adults.
culture (String) culture


Insurance Search Request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "segments": [
    {
      "startDate": "2023-10-18",
      "endDate": "2023-10-19",
      "fromIata": "DXB",
      "fromCountryCode": "AE",
      "toIata": "PAR",
      "toCountryCode": "FR"
    }
  ],
  "travelerNationality": "AE",
  "passengerAges": [
    {
      "years": 23,
      "months":10
    },
    {
      "years": 8
    }
  ],
  "culture": "en"
}


Insurance Search Response

Tags Attribute Description
meta meta
(Object)
success
(Boolean)		 Response status will be return Ex: true
statusCode
(Integer)		 Response statusCode will be return Ex: 1
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Insurance search and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData (JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
culture
(String)
 Language, Eg. "en".
data insurances
(JsonArray)		 This encloses insurance plans information.
insuranceKey
(String)
 Unique Key for each Insurance. This should be used for search to booking flow.
insuranceInfo (JsonObject) This encloses insurance plan information
planName
(String)		 Insurance Plan Name
planDescription
(String)		 Insurance Plan Description
planType
(String)		 Insurance Plan Type Eg: (Individual/Family)
coverageType
(String)		 Insurance Plan Coverage Eg: (Individual/Family)
adultAgeStartFrom
(Integer)		 Minimum age of adult passenger for that insurance plan
maximumRiderAllowed
(Integer)		 Maximum rider benefits allowed in plan
segments (JsonArray)
segment (JsonObject) This encloses insurance search segment
startDate
(String)		 Start date of the insurance coverage, in the format "YYYY-MM-DD".
endDate
(String)		 End date of the insurance coverage, in the format "YYYY-MM-DD".
fromIata
(String)		 Source Airport location
fromCountryCode
(String)		 Source Country code
toIata
(String)		 Destination Airport location
toCountryCode
(String)		 Destination Country code
planPremiumInfo (JsonObject) This encloses insurance plan premium information
premiumInfo (JsonObject)
planCode
(String)		 Plan Code
benefitName
(String)		 Benefit provided
termsAndConditions
(String)		 Terms and Conditions document name
premiumCharges (JsonObject)
baseFare
(Double)		 Base fare of Insurance Plan
premiumAmount
(Double)		 Premium amount for Insurance Plan
currencyCode
(String)		 Currency Code
perPaxPremiumAmount
(Double)		 Premium amount per passenger insurance Plan
taxes (JsonArray)
tax (JsonObject)
name
(String)		 Tax name
amount
(Double)		 Tax amount
included
(Boolean)		 Shows if the tax is included in the insurance plan or not.
customerAdditionalFareInfo (JsonObject)
transactionFeeEarned
(Double)		 Transaction fee earned
tdsOnCommission
(Double)		 TDS on commission
commissionEarned
(Double)		 Commission earned
markupEarned
(Double)		 Markup earned
discount
(Double)		 Discount applied
vat
(Double)		 VAT
cgst
(Double)		 CGST
sgst
(Double)		 SGST
igst
(Double)		 IGST
planDetail (JsonObject)
responseType
(String)		 Response type for plan details
responseContent
(String)		 Plan details
financialInfo (JsonObject)
supplier
(String)		 Name of the supplier
payment (JsonObject)
paymentTypes
(String)		 Payment types Eg: CARD,CR
planRiders (JsonArray) This encloses available rider plans
planRider (JsonObject) This encloses rider plan information
riderKey
(String)		 Unique Key for each Rider plan. This should be used for search to booking flow.
riderInfo (JsonObject)
riderCode
(String)		 Code for rider plan
riderName
(String)		 Rider plan name
planRiderDisplayName
(String)		 Rider plan display name
riderCharges (JsonObject)
totalAmount
(Double)		 Total amount of rider plan
currencyCode
(String)		 Currency code
riderBaseFare
(Double)		 Base fare of rider plan
perPaxPremiumAmount
(Double)		 Premium amount per passenger for rider plan
taxes (JsonArray)
tax (JsonObject)
name
(String)		 Tax name
amount
(Double)		 Tax amount
included
(Boolean)		 Shows if the tax is included in the rider plan or not.
customerAdditionalFareInfo (JsonObject)
transactionFeeEarned
(Double)		 Transaction fee earned
tdsOnCommission
(Double)		 TDS on commission
commissionEarned
(Double)		 Commission earned
markupEarned
(Double)		 Markup earned
discount
(Double)		 Discount applied
vat
(Double)		 VAT
cgst
(Double)		 CGST
sgst
(Double)		 SGST
igst
(Double)		 IGST
importantConditions (JsonArray)
condition
(String)		 Important condition associated with insurance plan


Insurance Search Request
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
{
  "meta": {
    "success": true,
    "statusCode": 1,
    "statusMessage": "SUCCESS",
    "actionType": "INSURANCE_SEARCH",
    "conversationId": "2cff57b0-4db9-4703-856a-37cc2e41418a"
  },
  "commonData": {
    "searchKey": "bd66b1aa-50b4-4677-b9d5-c5d87a4f1bd7",
    "culture": "en"
  },
  "data": [
    {
      "insuranceKey": "bd66b1aa-50b4-4677-b9d5-c5d87a4f1bd7-AIG73960000",
      "insuranceInfo": {
        "planName": "Gold - Individual",
        "planType": "Individual",
        "planDescription": "Gold WORLDWIDE UAE - INDIVIDUAL",
        "coverageType": "Individual",
        "adultAgeStartFrom": 12,
        "maximumRiderAllowed": 1
      },
      "planPremiumInfo": {
        "premiumInfo": {
          "planCode": "WRLDWD",
          "benefitName": "Winter Sports Cover",
          "termsAndConditions": "https://domain.com/public/doc/aig_dnata_policy.pdf"
        },
        "premiumCharges": {
          "baseFare": 163.0,
          "premiumAmount": 170.03,
          "currencyCode": "AED",
          "perPaxPremiumAmount": 0.0,
          "taxes": [
            {
              "name": "VAT ON TF",
              "amount": 0.0,
              "included": true
            }
          ],
          "customerAdditionalFareInfo": {
            "transactionFeeEarned": 0,
            "tdsOnCommission": 0,
            "commissionEarned": 15.52,
            "markupEarned": 10.0,
            "discount": 3.3,
            "vat": 8.09,
            "cgst": 0,
            "sgst": 0,
            "igst": 0
          }
        },
        "planDetail": [
          {
            "responseType": "html",
            "responseContent": ""
          }
        ],
        "financialInfo": {
          "supplier": "AIGTravelguard",
          "payment": {
            "paymentTypes": [
              "Credit"
            ]
          }
        },
        "planRiders": [
          {
            "riderKey": "bd66b1aa-50b4-4677-b9d5-c5d87a4f1bd7-AIG73960001",
            "riderInfo": {
              "riderCode": "AC",
              "riderName": "Airspace Close",
              "planRiderDisplayName": "Worldwide - Airspace Close (Family)"
            },
            "riderCharges": {
              "totalAmount": 185.71,
              "currencyCode": "AED",
              "riderBaseFare": 179.0,
              "riderPerPaxPremiumAmount": 179.0,
              "taxes": [
                {
                  "name": "VAT ON TF",
                  "amount": 0.0,
                  "included": true
                }
              ],
              "customerAdditionalFareInfo": {
                "transactionFeeEarned": 0,
                "tdsOnCommission": 0,
                "commissionEarned": 17.04,
                "markupEarned": 10.0,
                "discount": 3.61,
                "vat": 8.84,
                "cgst": 0,
                "sgst": 0,
                "igst": 0
              }
            }
          }
        ],
        "importantConditions": [
          {
            "condition": "Travelers must be below 75 years old."
          }
        ]
      }
    }
  ]
}