Quote

The Quote endpoint enables the RentalCover server to generate a policy quote based on the parameters provided.

Normally this endpoint is called during the checkout process when the user has chosen a vehicle and is offered an excess reduction policy. However, it can be called at any point in the search / book process as long as the required parameters are available.

This API call will generate a URL to the generated RentalCover quote. This URL can be integrated into the booking confirmation page and confirmation emails so that users can click the link and be redirected to their corresponding quote page on RentalCover.

Endpoint: /insurances/quote

Method: POST

POST /insurances/quote

curl -i -X POST \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
-d '{"FromDate":"2014-09-20 00:00:00","ToDate":"2014-09-21 00:00:00", "CustomerAge":21, "DestinationCountry":"AU", "FirstName":"Jack", "LastName":"Smith", "Address1":"21 This Street", "City":"Sydney","Email":"[email protected]","Country":"AU"}' \
https://api-staging.rentalcover.com/insurances/quote

Response

Request Parameters

X_API_KEY string [varchar(32)] required	API Key, provided by RentalCover.com.
FromDate date [yyyy-mm-dd hh:mm:ss] required	Date/time of vehicle pickup.
ToDate date [yyyy-mm-dd hh:mm:ss] required	Date/time of vehicle drop-off.
DestinationCountry string [varchar(2)] required	ISO 3166 two character country code for country of travel.
CustomerAge integer required	Customer age.
Email string required	Customer email.
FirstName string required	Customer first name (if unknown use NULL).
LastName string required	Customer last name (if unknown use NULL).
Country string [varchar(2)] required	ISO 3166 two character country code for customer country of residence or IP.
Type string	[ExcessReduction, CDW, Comprehensive, RoadsideAssistance, FullProtection] Requested policy type By Default we provide, ExcessReduction and Comprehensive policies To Request RoadsideAssistance policies (customers travelling to US), request with “Type”:“RoadsideAssistance” To Request CDW policies (US Residents travelling elsewhere), request with “Type”:“CDW”.
FromLocationName string	Full geographical location of vehicle pick-up. Format should be a unique free-text identifier, preferably comma-separated in order of increasing specificity. Airports should end with a colon followed by IATA code. Non-airport example: "Paris,Paris Montparnasse Railway Station", airport example: "Paris,Paris Le Bourget Airport:LBG".
ToLocationName string	Full geographical location of vehicle drop-off. Format should be a unique free-text identifier, preferably comma-separated in order of increasing specificity. Airports should end with a colon followed by IATA code.
Address1 string	Customer street address line 1 (50 character limit).
Address2 string	Customer street address line 2 (50 character limit).
City string	Customer suburb.
PostalCode string	Customer post code or zip code.
Phone string	Customer phone.
OtherEmail string	Customer other email.
Region string	The customer's state, region or territory, this is a 2 or 3-letter code. See supported regions.
OtherDriveAge1 integer	Age of second driver.
OtherDriveAge2 integer	Age of third driver.
CoverAmount float	The amount of cover required.
PolicyPrice float	Price of partner policy (if partner sets price). If < RC policy then partner price will be used.
VehicleStdLiabilityHigh float	If >1 standard excess available for vehicle, this is the higher amount. If only 1 standard excess, use this field.
VehicleStdLiabilityLow float	If >1 standard excess available for the vehicle this is the lower amount. If only 1 standard liability available, use VehicleStdLiabilityHigh. Policy quotes will use this amount to determine the amount of cover required. if this value isn’t passed in the request then CoverAmount will be used.
VehicleStdLiabilityCurrency string [varchar(3)]	Currency of vehicle’s standard liability.
VehicleSupplierId string	Vehicle supplier ID.
VehicleSupplierIdTwo string	Vehicle supplier ID of second supplier.
VehicleSupplierName string	Vehicle supplier name.
VehicleSupplierCountryId string [varchar(2)]	Vehicle supplier country code.
VehicleName string	Vehicle name.
VehicleCategory string	Vehicle category (if SIPP not used).
VehicleCode string	Vehicle SIPP code.
VehicleBerths string	Vehicle berths.
VehicleOffroad4x4 boolean default is false	Vehicle off road.
VehicleClass string	Vehicle class.
VehicleNettPrice float	The wholesale price of the vehicle paid by the OTA.
VehicleRentalGross float	The retail price of the vehicle.
ContactCustomer boolean [0|1] default is 1	Whether to allow RC email contact with customer. Would be 1 if RC allowed to send “opt out” emails.
LanguageCode string [varchar(2)] default is en	Two character language code. See supported languages.
LDWIncluded boolean [0|1]	If LDW is included we remove theft from the Comparison Table in Content endpoint.
SLIIncluded boolean [0|1]
CDWIncluded boolean [0|1]	Specifies if the policy includes Collision Damage Waiver (CDW). This is typically used for full protection policies. If omitted, the system defaults this value to 0 (False).
UserIpAddress string [20]	The end user’s IP address.
VehiclePickupTime datetime in UTC	The local vehicle pickup time with UTC offset (Atom format).e.g. 2018-12-04T22:00:00-05:00. Used to determine cancellation grace period. Allows customers to cancel up to time of pickup +15 minutes. If null then cancellation is midnight +15mins.
VehiclePickupCity string [varchar(50)]	Unstructured data. Pass whatever you use as your own city identifiers.
VehiclePickupCountry string [varchar(2)]	Two Letter Country Code.
VehicleDropoffTime datetime in UTC	The vehicle drop off time in UTC with offset (Atom format) e.g. 2018-12-04T22:00:00-05:00.
VehicleDropoffCity string [varchar(50)]
VehicleDropoffCountry string [varchar(2)]
VehiclePickupRegion string [varchar(50)]	This indicates the state, region or territory code the customer is picking their vehicle up from, e.g. NY for New York. See supported regions.
Currency string [varchar(3)]	If passed all the responses in the quote response will be in the specified currency. Also all subsequent actions to that quote will be in the specified currency (i.e. purchase, update, and cancel). See supported currencies.
PartnerSite string [50]	Used if partner has multiple sites to determine partner’s referring domain. Use this format: yoursite.com string would be yoursitecom.
RoadSideAssistanceCoverOption boolean [0|1]	Used to request for roadside assistance cover option.
BWCookie string	Used to send BW Cookie ID to RentalCover.
VehicleTypes string [100]	Comma separated list of vehicle types. Codes here: car,motorhome,campervan,4x4, minibus,lighttruck,bus
PartnerCollectingPayment boolean	Indicates whether the partner is collecting the payment.
ExpressCode string[50]	Used to request a specific policy to run policy experiments (ExpressCode to be provided by Client Solution Engineers and is disabled by default)
MetaData json (object | string)	Additional user-defined data, provided as a valid JSON object. This field allows clients to send supplementary information relevant to their specific use case. The structure and content of this object are entirely determined by the client. e.g. { "securitytoken": "39456fdhUIHIUH", "esim": { "esim_eligible": true } }

Response Attributes

Response properties with the text Formatted appended are formatted with the relevant currency code and symbol.

BookingId integer	Internal ID of the booking (primary key)
Reference string	This is the sole identifier for all claims and support requests. Unique booking reference ending with -INS that is created for for each policy booked. Customers will receive this reference in confirmation emails. Also used in the purchase and cancel requests.
Status string	See booking statuses.
FromDate datetime	Start date/time of booking.
ToDate datetime	End date/time of booking.
TotalAmount float	Total amount customer is to pay for the policy (already includes discounts & markups).
InsuranceCoverAmount float	Amount of cover the policy includes.
SupplierReference string	Supplier’s (i.e. the insurer’s) policy number. Usually issued upon payment. This is not used for any claims or customer support (we use Reference).
Expired boolean	Flag whether the policy has expired.
PoweredByLogo string	URL of RentalCover logo.
CoveredDays integer	Number of days the customer is covered for.
Discount float	Amount of discount that has been applied to the TotalAmount.
DestinationCountry string	Full name of destination country of travel.
DestinationCountryObject.Code string	ISO 3166 two character destination country code.
DestinationCountryObject.Name string	Full name of destination country of travel.
DestinationCountryObject.PhoneCode string	Destination country phone prefix.
VehiclePickupRegion string	This indicates the state, region or territory code the customer is picking their vehicle up from.
Currency string	Three character currency of the booking.
TotalAmountFormatted string	Total amount customer must pay for the policy (already includes discounts & markups). Includes currency formatting.
InsuranceCoverAmountFormatted string	Amount of cover the policy includes.
DiscountFormatted string	Amount of discount that has been applied to the TotalAmount.
DailyAmountFormatted string	TotalAmount / No Days.
Commission.TotalCommission string	Total commission for the partner (already includes discounts and markups).
Commission.TotalCommissionFormatted string	Formatted version of the TotalCommission.
SettlementCurrencyObject.SettlementCurrency string	Three character settlement currency of the booking.
SettlementCurrencyObject.SettlementAmount float	Total amount customer must pay for the policy, in the settlement currency rate (already includes discounts and markups).
SettlementCurrencyObject.SettlementAmountFormatted string	Formatted version of the Settlement Amount.
SettlementCurrencyObject.Commission.SettlementCommission float	Total commission for the partner, in the settlement currency rate.
SettlementCurrencyObject.Commission.SettlementCommissionFormatted string	Formatted version of the SettlementCommission.
Disclaimer string	Policy disclaimer.
Policy.GapCoverAmount float	Amount of gap cover that the policy includes.
Policy.Name string	Name of the policy.
Policy.Type string	Type of the Policy.
Policy.Code string	Policy code.
Policy.ExpressCode string	Policy ExpressCode. Only available when ExpressCode included in the request.
Policy.Excess float	Amount of excess.
Policy.Inclusions string	Policy inclusions.
Policy.Description string	Policy description.
Policy.SellingPoints string	Policy selling points / benefits.
Policy.SpecialMessage string	Any special messages related to the policy will be passed through this field.
Policy.GapCoverAmountFormatted string	Amount of gap cover that the policy includes.
Policy.ExcessFormatted string	Amount of excess.
Policy.PdsUrl string	URL to the policy PDS PDF.
Policy.SupplierName string	Name of the policy supplier.
Policy.ModifyUrl string	URL that allows the policy to be modified (if not using API endpoint).
Policy.CancelUrl string	URL that allows the policy to be cancelled (if not using API endpoint).
Customer.FirstName string	First name of customer.
Customer.LastName string	Last name of customer.
Customer.Email string	Email address of customer.
Customer.Age integer	Age of customer.
Customer.Country string	Customer country code.
Customer.Coupons object	0:n coupons, not returned if no coupons available.
Customer.Coupons.[coupon_code] string	Coupon code.
Customer.Coupons.[coupon_code].Title string	Coupon title.
Customer.Coupons.[coupon_code].Value integer	Value of coupon.
Customer.Coupons.[coupon_code].ValueType string	Fixed or percentage.
Customer.Coupons.[coupon_code].AmountRemaining float	Amount remaining on coupon [null].
Customer.Coupons.[coupon_code].EffectiveFrom date	Date that coupon is effective from.
Customer.Coupons.[coupon_code].EffectiveTo date	Date that coupon is effective to.
Customer.Coupons.[coupon_code].Ters string	Coupon terms and conditions.
QuoteUrl string	Quote URL of the policy. Can be used if customer opts out. Renders the payment page on RentalCover.com, customer can then complete payment for the policy.
Documentation.Ipid string	URL for the policy IPID. This will only be returned if given criteria is met.
EsimCouponEligible string	Returns true if a coupon code for an eSIM can be sent to the partner's email. This requires both the partner and the destination country to be eligible for the coupon. If either is ineligible, it returns false.