Download OpenAPI specification:Download
API documentation for Travel APIs and Merchant Quotes
Bind Policy for requested passenger details
| partner_id required | string Partner ID |
| X-API-Key required | string Default: your-default-api-key-value API Key |
Bind Policy request payload
required | object |
required | object |
required | Array of objects List of passengers on the trip with their details |
{- "tripDetails": {
- "bookingId": "string",
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z"
}, - "policyDetails": {
- "policyNo": "string",
- "planName": "string",
- "insurerCode": "CARE",
- "nomineeName": "string"
}, - "passengerDetails": [
- {
- "title": "Mr.",
- "firstName": "string",
- "lastName": "string",
- "dob": "2019-08-24",
- "mobileNo": "string",
- "email": "string"
}
]
}{- "status": "1",
- "success": true,
- "message": "Policies bound successfully for all passengers",
- "data": {
- "policyDetails": {
- "policyNo": "string",
- "bookingId": "string"
}
}
}Get Policy for requested policy number
| partner_id required | string Partner ID |
| X-API-Key required | string Default: your-default-api-key-value API Key |
Get Policy request payload
| policyNo required | string Unique number of this policy |
| bookingId required | string Booking ID of the travel |
{- "policyNo": "string",
- "bookingId": "string"
}Create quote for the requested merchant cover
| partner_id required | string Partner ID |
| X-API-Key required | string Default: your-default-api-key-value API Key |
Quote creation request payload
| insurers required | Array of strings Items Enum: "bajajAllianz" "iciciLombard" List of insurer codes |
| correlationId required | string Correlation ID for tracking |
| policyStartDate required | string <date> Start date of the policy |
| typeOfPolicy required | string Enum: "New Business" "Renewal" Type of policy |
required | object |
required | Array of objects |
Array of objects |
{- "insurers": [
- "bajajAllianz"
], - "correlationId": "string",
- "policyStartDate": "2019-08-24",
- "typeOfPolicy": "New Business",
- "customerDetails": {
- "customerType": "Individual",
- "companyName": "string",
- "customerName": "string",
- "email": "user@example.com",
- "phoneNumber": "string",
- "mobileISD": "string",
- "dateOfBirth": "2019-08-24",
- "panCardNo": "string",
- "address": "string",
- "pincode": "string",
- "areaPostOffice": "string",
- "state": "string",
- "city": "string",
- "gender": "MALE"
}, - "locationBasedRiskAndCoverPackages": [
- {
- "locationId": 0,
- "occupancyType": "001",
- "riskLocation": {
- "pincode": "string",
- "areaPostOffice": "string",
- "address": "string",
- "state": "string",
- "city": "string"
}, - "buildingRiskProfile": {
- "ageOfBuildingInYr": 0,
- "distanceFromNearestWaterBodyInKm": 0,
- "distanceFromNearestFireBrigadeInKm": 0,
- "safetyAndFirePrecautionMeasures": {
- "hasFireExtinguisher": true,
- "hasHydrantSystem": true,
- "hasSmokeDetectionSystem": true,
- "has24x7WatchAndWard": true,
- "hasCommonWatchman": true,
- "isAMCForFireAppliancesActive": true
}, - "constructionDetails": {
- "puccaOrKutcha": "Pucca",
- "typeOfClass": "string"
}, - "hasBasementRisk": true,
- "noOfStoreys": 0,
- "floorToCover": {
- "basement": true,
- "groundFloor": true,
- "firstFloorAndAbove": [
- 0
]
}
}, - "isHypothecationRequired": true,
- "hypothecationDetails": {
- "financierName": "string",
- "branchAddress": "string",
- "agreementType": "string",
- "loanType": "Mudra Loan",
- "hypothecations": [
- "string"
]
}, - "risks": [
- {
- "riskName": "Building Including Plinth & Foundation",
- "sumInsured": 0,
- "subRisks": [
- {
- "subRiskName": "Raw Material",
- "sumInsured": 0,
- "description": "string"
}
], - "riskLevelAddOnCovers": [
- {
- "coverName": "Accidental Damage",
- "required": true,
- "options": {
- "option1": "string"
}
}
]
}
], - "standardCovers": [
- {
- "coverName": "RSMD Cover",
- "required": true
}
]
}
], - "policyLevelAddOnCovers": [
- {
- "coverName": "Waiver of Involuntary Improvement",
- "required": true,
- "options": {
- "subLimitOfLossInPercent": 25
}
}
]
}{- "status": "success",
- "success": true,
- "message": "Quote created successfully",
- "data": {
- "quoteId": "string",
- "userId": "string",
- "status": "Created",
- "correlationId": "string",
- "policyStartDate": "2019-08-24",
- "policyEndDate": "2019-08-24",
- "quoteCreatedAt": "2019-08-24T14:15:22Z",
- "quotes": [
- {
- "insurer": "BajajAllianz",
- "quoteDetails": {
- "premium": 0.1,
- "taxOnPremium": 0.1,
- "total": 0.1,
- "sumInsured": 0.1,
- "coverages": [
- "string"
]
}
}
]
}
}Record a payment with UTR Number, Quote ID, Total Amount, Premium, Tax on Premium, and Correlation ID
| partner_id required | string Partner ID |
| X-API-Key required | string Default: your-default-api-key-value API Key |
Payment recording request payload
| utrNumber required | string Unique Transaction Reference (UTR) number |
| userId required | string Encrypted User ID |
| quoteId required | string ID of the quote related to this payment |
| totalAmount required | number Total amount of the payment |
| premium required | number Premium amount for the policy |
| taxOnPremium required | number Tax applied to the premium |
| correlationId required | string Correlation ID for tracking the payment |
| insurerCode required | string Enum: "bajajAllianz" "iciciLombard" The code of the insurer for which payment is to be made |
{- "utrNumber": "string",
- "userId": "string",
- "quoteId": "string",
- "totalAmount": 0,
- "premium": 0,
- "taxOnPremium": 0,
- "correlationId": "string",
- "insurerCode": "bajajAllianz"
}{- "status": "success",
- "message": "Payment recorded successfully",
- "paymentId": "string",
- "data": {
- "utrNumber": "string",
- "userId": "string",
- "quoteId": "string",
- "totalAmount": 0,
- "premium": 0,
- "taxOnPremium": 0,
- "correlationId": "string"
}
}Store KYC details including PAN and GST files
| partner_id required | string Partner ID |
| X-API-Key required | string Default: your-default-api-key-value API Key |
| user_id required | string Encrypted User ID |
| correlationId required | string Enter the Correlation ID that you got from the Payments API |
| name required | string Name of the insured user |
| email required | string <email> Email of the insured user |
| mobile_number required | string Mobile number of the insured user |
| gst_number required | string GST number of the business |
| pan_number required | string PAN number of the business |
| pan_document required | string <binary> PAN Document |
| gst_document required | string <binary> GST Document |
{- "status": "success",
- "message": "KYC Created successfully"
}Download the policy certificate by providing the policy number and correlation ID
| partner_id required | string Partner ID |
| X-API-Key required | string Default: your-default-api-key-value API Key |
Request payload for downloading the policy certificate
| policyNumber required | string The unique policy number |
| correlationId required | string Correlation ID for tracking the request |
| userId required | string Encrypted User ID |
{- "policyNumber": "string",
- "correlationId": "string",
- "userId": "string"
}Bind Cargo Delay Policy for the requested shipment details
| partner_id required | string Unique identifier for the partner |
| X-API-Key required | string Default: your-default-api-key-value API Key for authentication |
Bind Cargo Delay Policy request payload
| transportMode required | string Enum: "air" "sea" "land" Mode of transport used for cargo shipment |
required | object Details of the shipment being insured |
| customerName required | string Name of the customer purchasing the cargo insurance |
| customerCountry required | string Country code of the customer's location |
| customerEmail required | string <email> Email address of the customer for communication and policy documents |
{- "transportMode": "air",
- "shipment": {
- "awb": "00012113334",
- "departureDate": "2025-03-10",
- "origin": "SGN",
- "destination": "SFO",
- "eta": "2025-05-01T19:30:00+05:30",
- "carrierCode": "FX",
- "value": {
- "amount": 250000,
- "currency": "USD"
}, - "goods_description": "Consumer Electronics"
}, - "customerName": "Covrzy Test Customer",
- "customerCountry": "US",
- "customerEmail": "jeremy+covrzy@otonomi.ai"
}{- "status": "booked",
- "amount": 74.8,
- "policyId": "7b9c0d2a-34ef-41f9-bb10-123456789abc"
}Get Cargo Delay Policy for the requested policy number
| partner_id required | string Partner ID |
| X-API-Key required | string Default: your-default-api-key-value API Key |
Get Cargo Delay Policy request payload
| policyNo required | string Unique number of this policy |
| consignmentId required | string Consignment ID related to the policy |
{- "policyNo": "string",
- "consignmentId": "string"
}