This endpoint ingests the car quotes, booking and insurance opt-in data to assist with market-neutral pricing analysis.
partnerId required | string <= 128 characters Partner identifier. Your business name to differentiate you from other partners |
eventType required | string The type of event, use "Search" as a fixed value BrightwriteSearchEvent |
rentalCarPickUpBranchAddress | string <= 256 characters Branch address where the rental car will be picked up |
rentalCarPickUpBranchCode | string <= 128 characters Internal branch code where the rental car will be picked up |
rentalCarPickUpCity required | string <= 128 characters City where the rental car will be picked up |
rentalCarPickUpCountry | string <= 128 characters Country of the rental car will be picked up |
rentalCarPickUpState | string <= 128 characters State name where the rental car will be picked up |
rentalCarDropOffBranchAddress | string <= 256 characters Branch address where the rental car will be dropped off |
rentalCarDropOffBranchCode | string <= 128 characters Internal branch code where the rental car will be dropped off |
rentalCarDropOffCity required | string <= 128 characters City where the rental car will be dropped off |
rentalCarDropOffCountry | string <= 128 characters Country of the rental car will be dropped off |
rentalCarDropOffState | string <= 128 characters State where the rental car will be dropped off |
currencyForExcessAndLiability | string 3 characters Three character ISO 4217 |
insurancePrice | number <double> The price above which the insurance must be sold if the book is to be profitable |
insurancePriceCurrency | string 3 characters Currency used. Three character ISO 4217 |
partnerQuoteId | string <= 128 characters Quote identifier in partner's database. This is useful in the future for data consolidation, stitching etc.. |
policyDestinationCountryCode | string 2 characters ISO 3166 Two Character standard |
policyEffectiveDateTime | string <date-time> Effective date and time for the policy (use 00:00:00 time if coverage starts beginning of day) |
policyExcess | number <double> Excess that the underwriter has quoted |
policyExpirationDateTime | string <date-time> Expiration date and time of the policy (use 23:59:59 if date is inclusive OR 00:00:00 time of next day if date is exclusive. |
policyLiability | number <double> Liability that the underwriter has quoted |
policyType | string <= 128 characters Requested policy type [ ExcessReduction, CDW, Comprehensive, RoadsideAssistance, FullProtection ]. This is the policy type code agreed with Partner in advance. |
requestedLiability | number <double> This is the max payout for the policy requested by the partner (the Cover Amount in RC.com API) |
cookieId required | string <= 128 characters Cookie identifier |
ipAddress | string <= 45 characters Client IP Address, v4 or v6 |
sessionId | string <= 128 characters Session identifier |
userAgent | string <= 256 characters The device user agent string |
The data is successfully loaded
Accepts information about quoted policy and related booking information and returns price recommendation for a given policy
partnerPrimaryInsuredId | string <= 128 characters Insured Person ID of the policy holder |
partnerQuoteId | string <= 128 characters Quote identifier in partner's database |
effectiveDateTime required | string <date-time> Effective date and time for the policy (use 00:00:00 time if coverage starts beginning of day) |
requestDateTime required | string <date-time> Timestamp of the quote request when it was first received by the distributor |
expirationDateTime required | string <date-time> Expiration date and time of the policy (use 23:59:59 if date is inclusive OR 00:00:00 time of next day if date is exclusive. |
currency required | string 3 characters Currency used. Three character ISO 4217 |
insuredPersons required | Array of object (InsuredPerson) List of people who are insured/covered by this policy |
partnerId required | string <= 128 characters Partner identifier. Human and machine readable so we can use in tagging |
pricingRequestOrigin | string <= 512 characters Identifier, which partner use to specify pricing request origin |
partnerPrice required | number <double> The price above which the insurance must be sold if the book is to be profitable |
appId | string <= 128 characters Optinal field to identify source of traffic. For example website name or mobile app identifier. |
appEnv | string <= 128 characters Optinal field which can be used to distinguish production and staging or any other test environments which partners can use as part of their processes. |
purchaser | object (Purchaser) |
brightwriteCookieId | string <= 128 characters BrightWrite cookie identifier |
experimentGroup | string The experimentGroup (only turned on for RentalCars) |
policyDestinationCountryCode required | string 2 characters ISO 3166 Two Character standard |
policyType required | string <= 128 characters Requested policy type [ ExcessReduction, CDW, Comprehensive, RoadsideAssistance, FullProtection ]. This is the policy type code agreed with Partner in advance. |
requestedLiability | number <double> This is the max payout for the policy requested by the partner (the Cover Amount in RC.com API) |
policyExcess required | number <double> Excess that the underwriter has quoted |
policyLiability required | number <double> Liability that the underwriter has quoted |
currencyForExcessAndLiability required | string 3 characters Three character ISO 4217 |
rentalCarBooking required | object (BookingRentalCar) |
Pricing request has been succesfully processed
Invalid pricing request has been sent
Takes in information about insurance quote conversion along with some other info
partnerQuoteId | string <= 128 characters Quote ID used by the distributor. Required if we are also collecting quote info with java script from the distributor's website. Optional if we are not getting info from javasript |
pricingRequestId | string <= 256 characters If it's impossible to use any type of quote IDs, we need to report conversions based on prcing request ID privdied in pricing request endpoint |
purchaser required | object (Purchaser) |
rentalCarBooking | object (BookingRentalCar) |
Quote conversion ahs been successfully reported