BOOK INSURANCE

Book method is called to generate the insurance policy based on the selected insurance plan. On successful policy creation a policy number is generated. In case of multi passenger booking for each passenger separate insurance policy will generate.

Service URL (REST) to be used:
Book
Insurance Book Request
Level Element Format Comments Mandatory
1 EndUserIp String IP Address of the end Mandatory
2 ClientId String Client ID provided to the agency at registration Mandatory
3 UserName String Username provided to the agency at registration Mandatory
4 Password String Password provided to the agency at registration Mandatory
5 APIType String API Provider Type Mandatory
6 TraceId String Unique identifier for identifying every unique search Required for audit purpose Mandatory
7 GenerateInsurancePolicy Boolean Mandatory
8 ResultIndex Integer Define the Result no Mandatory
9 Passenger[] Array Array of passenger details for the insurance policy as requested in Insurance search Mandatory
9.1 Title String Title of the passenger
(Possible values can be
Mr, Mrs, Miss,Ms,SHRI,SMT)
Mandatory
9.2 FirstName String First name of the Insured passenger Mandatory
9.3 LastName String Last name of the Insured passenger Mandatory
9.4 BeneficiaryName String Beneficiary name of the Insured passenger Mandatory
9.5 RelationShipToInsured String RelationShipToInsured(Ex: Self) Mandatory
9.6 RelationToBeneficiary String Insured person relationship to Beneficiary
(Ex: Son, Father, Mother, Brother, Sister)
Mandatory
9.7 Gender String Gender Of Insured person
(Male-1, Female-2)
Mandatory
9.8 Sex Integer Sex Of Insured person
(Male-1, Female-2)
Mandatory
9.9 DOB Date Time DOB of the insured passenger
Format: (yyyy-mm-ddT00:00:00)
Mandatory
9.10 PassportNo String Passport no of insured passenger Mandatory
9.11 PhoneNumber Integer PhoneNumber of insured passenger Mandatory
9.12 EmailId String EmailId of insured passenger Mandatory
9.13 AddressLine1 String AddressLine1 of insured passenger Mandatory
9.14 AddressLine2 String AddressLine2 of insured passenger Mandatory
9.15 CityCode String City Code of insured passenger Mandatory
9.16 CountryCode String CountryCode of insured passenger Mandatory
9.17 MajorDestination String Destination where passenger is travelling Mandatory
9.18 PinCode Integer PinCode of insured passenger Mandatory
Insurance Book Response
Level Element Format Comments Mandatory
1 Error{} Object Error Mandatory
1.1 ErrorCode String ErrorCode Mandatory
1.2 ErrorMessage String Error Message Mandatory
2 TraceId Integer Trace ID Mandatory
3 ResponseStatus String Simple result data version Mandatory
4 APIType String API Type of the Request Mandatory
5 Response[] Array Result Array Of Book Request Mandatory
5.1 Itinerary[] Array Itinerary Array Of Book Request Mandatory
5.1.1 BookingId Integer Unique booking id of the successful policy Mandatory
5.1.2 InsuranceId Integer Unique insurance id of the successful policy Mandatory
5.1.3 PlanType Enumeration Define insurance is single trip or AnnualMultiTrip
(Ex: SingleTrip = 1, AMT = 2)
Mandatory
5.1.4 PlanName String Name of Insurance plan Mandatory
5.1.5 PlanDescription String Describe the coverage amount and other details Mandatory
5.1.6 PlanCoverage Enumeration Define whether the plan coverage area is US, NON us and India
(Ex: US = 1,
Non_US = 2,
WorldWide = 3,
India = 4,
Asia = 5,
Canada = 6,
Australia = 7
SchenegenCountries = 8)
Mandatory
5.1.7 CoverageDetails[] Array Coverage Detials Mandatory
5.1.7.1 Coverage String Define the Insurance cover area ( Ex: 24/7 Worldwide Medical Assistance, Travel Assistance, ravel Insurance, Dental Cover Mandatory
5.1.7.2 SumInsured Decimal Define the service wise cover amount
(Ex Dental Cover -$250,
Personal Accident-$10000)
Mandatory
5.1.8 PlanCategory Integer Define the category of plan whether its Domestic, Overseas and studentoversea plan. Possible values can be
DomesticTravelPolicy = 1,
OverseasTravelInsurance = 2,
StudentOverseasInsurance = 3,
SchengenOverseasInsurance = 4,
InboundTravelPolicy = 5,
CancellationInsurance = 6
Mandatory
5.1.9 PaxInfo[] Array Passenfer Info Array Mandatory
5.1.9.1 PaxId Integer Passenger ID in policy Mandatory
5.1.9.2 PolicyNo Integer Unique policy number of the successful booking Mandatory
5.1.9.3 ClaimCode String ClaimCode generated after successfull booking. Mandatory
5.1.9.4 SiebelPolicyNumber String SiebelPolicyNumber Generated after successfull booking. Mandatory
5.1.9.5 DocumentURL String DocumentURL generated after successfull booking. Mandatory
5.1.9.6 MaxAge Integer Define max age of passenger Mandatory
5.1.9.7 MinAge Integer Define min age of passenger Mandatory
5.1.9.8 Title String Title of the passenger
(Possible values can be
Mr, Mrs, Miss,Ms,SHRI,SMT)
Mandatory
5.1.9.9 FirstName String First name of the Insured passenger Mandatory
5.1.9.10 LastName String Last name of the Insured passenger Mandatory
5.1.9.11 Gender String Gender Of Insured person
(Male-1, Female-2)
Mandatory
5.1.9.12 DOB Date Time DOB of the insured passenger
Format: (yyyy-mm-ddT00:00:00)
Mandatory
5.1.9.13 BeneficiaryName String Beneficiary name of the Insured passenger Mandatory
5.1.9.14 RelationShipToInsured String RelationShipToInsured(Ex: Self) Mandatory
5.1.9.15 RelationToBeneficiary String Insured person relationship to Beneficiary
(Ex: Son, Father, Mother, Brother, Sister)
Mandatory
5.1.9.16 EmailId String EmailId of insured passenger Mandatory
5.1.9.17 PhoneNumber Integer PhoneNumber of insured passenger Mandatory
5.1.9.18 PassportNo String Passport no of insured passenger Mandatory
5.1.9.19 AddressLine1 String AddressLine1 of insured passenger Mandatory
5.1.9.20 AddressLine2 String AddressLine2 of insured passenger Mandatory
5.1.9.21 Country String Country of insured passenger Mandatory
5.1.9.22 State String State of insured passenger Mandatory
5.1.9.23 City String City of insured passenger Mandatory
5.1.9.24 PinCode Integer PinCode of insured passenger Mandatory
5.1.9.25 MajorDestination String Destination where passenger is travelling Mandatory
5.1.9.26 OldPolicyNumber String Old Policy Number Mandatory
5.1.9.27 PolicyStatus Enumeration Mandatory
5.1.9.28 ErrorMsg String Mandatory
5.1.10 PolicyStartDate Date Time Policy start date
Format: (yyyy-mm-ddT00:00:00)
Mandatory
5.1.11 PolicyEndDate Date Time Policy End date
Format: (yyyy-mm-ddT00:00:00)
Mandatory
5.1.12 CreatedOn Date Time Policy Created On date
Format: (yyyy-mm-ddT00:00:00)
Mandatory
5.1.13 Source String Source from which the policy is created. Mandatory
5.1.14 IsDomestic Boolean Is Domestic (Will be set true if Indian city) Mandatory
5.1.15 Status Enumeration Mandatory