Skip to content

Insurance Book

  • The Book Insurance API enables users to seamlessly book their chosen travel insurance plan, along with details such as client reference, total cost, selected insurance plan, passenger information, and payment details.
  • Upon successful booking, the API returns a confirmation with key details, including a unique booking reference ID, client reference, supplier reference ID, booking status, and transaction date.
  • This endpoint streamlines the process of securing travel insurance, offering a convenient way to integrate insurance booking functionality into various applications or platforms.

API service end point 

/api/v1/reservation/insurance-book


Insurance Book Request

Tags Attribute Description
InsuranceBookingCriteria (JsonObject)
clientReference*
(String)		 Unique Key for client reference .This should be unique for all bookings.
totalNet*
(Double)		 Total amount calculated for the transaction
currency*
(String)		 Selling currency of insurance plan
searchKey*
(String)		 Unique Key for the search .This should be taken from Insurance search response
selectedInsurance (JsonObject)
insuranceKey*
(String)		 Unique Key for the insurance plan .This should be taken from Insurance search response.
planRiders (JsonArray)
riderKey
(String)		 Unique Key for the rider plan .This should be taken from Insurance search response.
passengers passengers
(JsonArray)
passenger passenger*
(JsonObject)
passengerKey *
(String)		 A unique key for the passenger.
ptc *
(String)		 Passenger type code, Eg : Adult as "ADT",Child as "CHD".
passengerInfo passengerInfo
(JsonObject)
nameTitle *
(String)		 Salutation, Eg(Mr,Ms).
givenName *
(String)		 First name of the passenger, with a minimum length of 2 characters and a maximum length of 25 characters.
middleName
(String)		 Middle name of the passenger, if available.
surname *
(String)		 Last name of the passenger, with a minimum length of 2 characters and a maximum length of 25 characters.
gender *
(String)		 Gender of the passenger, Eg(M,F).
birthDate *
(String)		 Date of birth of the passenger, in the format "YYYY-MM-DD".
nomineeDetail nomineeDetail
(JsonObject)		 This encloses nominee details if passenger is lead.
nameTitle *
(String)		 Salutation of the nominee's name, Eg(Mr,Ms).
givenName *
(String)		 First name of the nominee, with a minimum length of 2 characters and a maximum length of 25 characters.
middleName
(String)		 Middle name of the nominee, if available.
surname *
(String)		 Last name of the nominee, with a minimum length of 2 characters and a maximum length of 25 characters.
relation *
(String)		 Relationship with the nominee.
birthDate *
(String)		 Date of birth of the nominee, in the format "YYYY-MM-DD".
identityDocuments (JsonArray)
identityDocument (JsonObject)
idDocumentNumber *
(String)		 Document number.
idType *
(String)		 Type of identity document.
issuingCountryCode *
(String)		 Country code where the document is issued.
residenceCountryCode *
(String)		 Country code of residence.
dateOfIssue *
(String)		 Date of issue of the document, in the format "YYYY-MM-DD".
expiryDate *
(String)		 Expiry date of the document, in the format "YYYY-MM-DD".
contact contact *
(JsonObject)
postalAddress postalAddress *
(JsonObject)
label
(String)		 Label for the address.
street *
(JsonArray)
postalCode *
(String)		 Postal code.
cityName *
(String)		 City name.
countryCode *
(String)		 Country code.
contactsProvided (JsonArray) Supports only for a single contact provide
contactProvided (JsonObject)
emailAddress*
(listOfString)		 Email address - supports only for a single email id
phone (JsonObject)
label
(String)		 Phone label
phoneNumber *
(String)		 Phone number
areaCode *
(String)		 Area code
paymentDetails (JsonObject) Payment mode.
paymentMode *
(String)		 Payment mode.
cardInfo *
(String)		 Encrypted card details to be passed here.
address address *
(JsonObject)
label
(String)		 Label for the address.
street *
(JsonArray)
postalCode *
(String)		 Postal code.
cityName *
(String)		 City name.
countryCode *
(String)		 Country code.

Insurance Book 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
{
  "clientReference": "OTA-2022-151522",
  "totalNet": 355.74,
  "currency": "AED",
  "searchKey": "9f02e328-2245-457f-adfc-2887c557234e",
  "selectedInsurance": {
    "insuranceKey": "9f02e328-2245-457f-adfc-2887c557234e-AIG73960016",
    "planRiders": [
      {
        "riderKey": "9f02e328-2245-457f-adfc-2887c557234e-AIG73960017"
      }
    ]
  },
  "passengers": [
    {
      "passengerKey": "SH4H23B-1",
      "ptc": "ADT",
      "passengerInfo": {
        "nameTitle": "DR",
        "givenName": "TEST",
        "middleName": "",
        "surname": "ONE",
        "gender": "M",
        "birthDate": "1993-08-14"
      },
      "nomineeDetail": {
        "nameTitle": "DR",
        "givenName": "KameCho",
        "middleName": "",
        "surname": "ONE",
        "relation": "Brother",
        "birthDate": "2007-02-27"
      },
      "identityDocuments": [
        {
          "idDocumentNumber": "2342352352352",
          "idType": "PT",
          "issuingCountryCode": "IN",
          "residenceCountryCode": "IN",
          "dateOfIssue": "2023-09-27",
          "expiryDate": "2025-09-27"
        }
      ],
      "contact": {
        "postalAddress": {
          "label": "AddressAtDestination",
          "street": [
            "Beeches Apartment",
            "200 Lampton Road"
          ],
          "postalCode": "TW345RT",
          "cityName": "NYK",
          "countryCode": "USA"
        },
        "contactsProvided": [
          {
            "emailAddress": [
              "AA@BA.COM"
            ],
            "phone": [
              {
                "label": "origin",
                "areaCode": 44,
                "phoneNumber": 2087385301
              }
            ]
          }
        ]
      }
    }
  ],
  "paymentDetails": {
    "paymentMode": "CR",
    "cardInfo": "encripted.card.details.to.be.passed.here",
    "address": {
      "label": "Billing",
      "street": [
        "Beeches Apartment",
        "200 Lampton Road"
      ],
      "postalCode": "TW345RT",
      "cityName": "NYK",
      "countryCode": "USA"
    }
  }
}

Insurance Book Response

Tags Attribute Description
meta meta
(JsonObject)
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 .
data (JsonArray) This encloses insurance plan information.
insuranceKey
(String)		 Unique Key for the insurance plan .This should be taken from Insurance search response.
bookingReferenceId
(String)		 This attribute contains the unique booking reference id.
clientReference
(String)		 This attribute contains the client reference id.
supplierReferenceId
(String)		 This attribute contains the supplier reference id.
bookingStatus
(String)		 Booking status.
transactionDate
(String)		 Date of which the transaction has been placed, in the format "YYYY-MM-DD".
totalAmount
(Double)		 Total amount of insurance plan including rider plan.
insuranceInfo (JsonObject)
segments (JsonArray)
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 origin location
fromCountryCode
(String)		 This tag indicates the origin location country code
toIata
(String)		 This tag indicates the destination location
toCountryCode
(String)		 This tag indicates the destination location country code
planName
(String)		 Name of the insurance plan.
planType
(String)		 Type of insurance plan, e.g., "Individual".
insuranceName
(String)		 Name of the insurance.
coverageType
(String)		 Type of coverage, e.g., "Individual".
planPremiumInfo (JsonArray)
premiumInfo (JsonObject)
planCode
(String)		 Code for the insurance plan.
benefitName
(String)		 Name of the benefit provided by the plan.
premiumCharges (JsonObject)
baseFare
(Double)		 Base fare of the insurance plan.
premiumAmount
(Double)		 Premium amount for the insurance plan.
currencyCode
(String)		 Currency code for the premium amount.
perPaxPremiumAmount
(Double)		 Premium amount per passenger for 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
planRiders planRiders
(JsonArray)
riderInfo riderInfo
(JsonObject)
riderKey
(String)		 Unique key for each rider plan.
riderCode
(String)		 Code for the rider plan.
riderName
(String)		 Name of the rider plan.
planRiderDisplayName
(String)		 Display name of the rider plan.
riderCharges riderCharges
(JsonObject)		 Object containing charges information for the rider.
totalAmount
(Double)		 Total amount of the rider plan.
currencyCode
(String)		 Currency code for the rider plan.
riderBaseFare
(Double)		 Base fare of the rider plan.
perPaxPremiumAmount
(Double)		 Premium amount per passenger for the 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
passengers passengers
(JsonArray)
passenger passenger
(JsonObject)
passengerKey
(String)		 A unique key for the passenger.
ptc
(String)		 Passenger type code, Eg : Adult as "ADT",Child as "CHD".
passengerInfo (JsonObject)
nameTitle
(String)		 Salutation, Eg(Mr,Ms).
givenName
(String)		 First name of the passenger.
middleName
(String)		 Middle name of the passenger, if available.
surname
(String)		 Last name of the passenger.
gender
(String)		 Gender of the passenger, Eg(M,F).
birthDate
(String)		 Date of birth of the passenger, in the format "YYYY-MM-DD".
contactProvided (JsonObject)
emailAddress
(listOfString)		 Email address - supports only for a single email id
phone (JsonObject)
label
(String)		 Phone label
phoneNumber
(String)		 Phone number
areaCode
(String)		 Area code
nomineeDetail nomineeDetail
(JsonObject)		 This encloses nominee details if passenger is lead.
nameTitle
(String)		 Salutation of the nominee's name, Eg(Mr,Ms).
givenName
(String)		 First name of the nominee.
middleName
(String)		 Middle name of the nominee, if available.
surname
(String)		 Last name of the nominee.
relation
(String)		 Relationship with the nominee.
birthDate
(String)		 Date of birth of the nominee, in the format "YYYY-MM-DD".
identityDocuments identityDocuments
(JsonArray)		 An array containing information about identity documents.
identityDocument identityDocument
(JsonObject)		 An object containing details about an identity document.
idDocumentNumber

(String)
 Document number.
idType

(String)
 Type of identity document.
issuingCountryCode

(String)
 Country code where the document is issued.
residenceCountryCode

(String)
 Country code of residence.
dateOfIssue

(String)
 Date of issue of the document, in the format "YYYY-MM-DD".
expiryDate

(String)
 Expiry date of the document, in the format "YYYY-MM-DD".
financialInfo (JsonObject)
supplier
(String)		 Name of the supplier
payment (JsonObject)
paymentTypes
(String)		 Payment types Eg: CARD,CR


Insurance Book Response
  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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
{
  "meta": {
    "success": true,
    "statusCode": 1,
    "statusMessage": "SUCCESS",
    "actionType": "INSURANCE_BOOK",
    "conversationId": "2cff57b0-4db9-4703-856a-37cc2e41418a"
  },
  "commonData": {
    "searchKey": "bd66b1aa-50b4-4677-b9d5-c5d87a4f1bd7",
    "culture": "en"
  },
  "data": [
    {
      "bookingReferenceId": "BKR-2022-000012",
      "clientReference": "OTA-2022-is1522",
      "supplierReferenceId": "833097893",
      "bookingStatus": "Confirmed",
      "transactionDate": "2023-10-09",
      "totalAmount": 510.0,
      "insuranceKey": "bd66b1aa-50b4-4677-b9d5-c5d87a4f1bd7-AIG73960000",
      "insuranceInfo": {
        "segments": [
            {
              "startDate": "2023-11-14",
              "endDate": "2023-11-15",
              "fromIata": "DXB",
              "fromCountryCode": "AE",
              "toIata": "BOM",
              "toCountryCode": "IN"
            }
          ],
        "planName": "Gold - Individual",
        "planType": "Individual",
        "insuranceName": "Gold WORLDWIDE UAE - INDIVIDUAL",
        "coverageType": "Individual"
      },
      "planPremiumInfo": [
        {
          "premiumInfo": {
            "planCode": "WRLDWD",
            "benefitName": "Winter Sports Cover",
            "termsAnConditions": "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
            }
          }
        }
      ],
      "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
            }
          }
        }
      ],
      "passengers": [
        {
          "passengerKey": "1",
          "isLead": true,
          "ptc": "ADT",
          "passengerInfo": {
            "birthDate": "1991-12-15",
            "gender": "M",
            "nameTitle": "Mr",
            "givenName": "Prince",
            "middleName": "",
            "surname": "Kumar"
          },
          "contactsProvided": [
            {
              "emailAddress": [
                "tarana@BA.COM"
              ],
              "phone": [
                {
                  "label": "Origin",
                  "areaCode": 979,
                  "phoneNumber": "12345567896"
                }
              ]
            }
          ],
          "nomineeDetail": {
            "nameTitle": "DR",
            "givenName": "KameCho",
            "middleName": "",
            "surname": "ONE",
            "relation": "Brother",
            "birthDate": "2007-02-27"
          },
          "identityDocuments": [
            {
              "idDocumentNumber": "2342352352352",
              "idType": "PT",
              "issuingCountryCode": "IN",
              "dateOfIssue": "2023-09-27",
              "expiryDate": "2025-09-27"
            }
          ]
        },
        {
          "passengerKey": "2",
          "ptc": "ADT",
          "passengerInfo": {
            "birthDate": "1991-12-15",
            "gender": "M",
            "nameTitle": "Mr",
            "givenName": "Prince",
            "middleName": "",
            "surname": "Kumar"
          },
          "contactsProvided": [
            {
              "emailAddress": [
                "tarana@BA.COM"
              ],
              "phone": [
                {
                  "label": "Origin",
                  "areaCode": 979,
                  "phoneNumber": "12345567896"
                }
              ]
            }
          ],
          "identityDocuments": [
            {
              "idDocumentNumber": "AJKDKB515",
              "idType": "PT",
              "issuingCountryCode": "IN",
              "dateOfIssue": "2023-09-27",
              "expiryDate": "2025-09-27"
            }
          ]
        }
      ],
      "financialInfo": {
        "supplier": "AIG",
        "payment": {
          "paymentTypes": [
            "Credit"
          ]
        }
      }
    }
  ]
}