Create Guarantee Quote

post https://protect.sandbox.sensibleweather.io/api/v0_1/quote/guarantee

Creates a new Guarantee Quote which converts to a Guarantee when accepted. An exposure location must be included, which can be provided by including both exposurelatitude and exposure_longitude _OR exposure_address. Response variables under the Documents section will be translated according to the lang_locale.

Body Params

product_id

uuid

required

Identifier for the Product used to define behavior for Quotes and Guarantees - provided by SensibleWeather

coverage_start_date

string

required

The day on which coverage begins

coverage_end_date

string

required

The day on which coverage ends

exposure_name

string

required

length ≥ 1

The human-readable/user-facing name of the location or experience being covered. This field has a character limit of 50, any longer content will be truncated.

exposure_latitude

float

-90 to 90

The latitude in decimal degrees of the exposure location

exposure_longitude

float

-180 to 180

The longitude in decimal degrees of the exposure location

exposure_address

object

A physical address for the exposure location

exposure_total_coverage_amount

float

required

≥ 0.01

The total value of the exposure to be covered

include_plain_language

boolean

Optionally toggle plain language. Returns plain language explanations of coverage to display to consumers for perils and thresholds. Default is true.

external_id

string | null

An identifier used to associate a Quote to an order/reservation/booking in another system if available. Alternatively, a shopping cart ID or another type of unique session ID can be used to aggregate Quotes for a browsing experience by a customer

billing_address

object

A physical address for billing

coverage_start_hour_number

integer

0 to 23

The hour when coverage should begin on each of the covered days - overrides the Product default if provided. Required if the Product has no default. Should be provided in the local time of the location of the guarantee.

coverage_end_hour_number

integer

1 to 24

The hour when coverage should end on each of the covered days - overrides the Product default if provided. Required if the Product has no default. Should be provided in the local time of the location of the guarantee.

Responses

Response body

object

uuid

Unique quote identifier

product_id

uuid

Identifier for the Product used to define behavior for Quotes and Guarantees - provided by SensibleWeather

created_at

date-time | null

The datetime when this object was created

lang_locale

string | null

The language used to translate response in BCP47 format. If none are sent it will use the product default. If the specific lang_locale is not supported, but a lang_locale with the same root language is supported, the supported lang_locale will be used as a fall back. For example, if fr-CA is sent and only fr-FR is supported, then requests with fr-CA will have responses translated using fr-FR. On quote creation, this field is used to translate document section of the response body. However, on quote acceptance, this field is also used as the initial lang_locale setting for a new User. If the User already exists with Sensible Weather, their lang_locale will not be updated by this field and the Quote Accept response will respond with the lang_locale preference of the User regardless of what was sent in the request body.

tax_was_assessed

boolean

Boolean specifying whether the quote includes tax or not

expires_at

date-time

The datetime at which point this quote can no longer be accepted and turned into an active guarantee

external_id

string | null

plain_language

object | null

main

object

details

object

documents

array of objects

documents

object

name

string

Terms and Conditions Privacy Policy

link

url

offer_key

string

The type of offer for the quote.

guarantee_id

uuid | null

The ID of the guarantee that was created when this quote was accepted. Will only show up if the quote has been accepted and successfully created a linked guarantee

accepted_at

date-time | null

The datetime when this quote was accepted. Will only show up if the quote has been accepted and successfully created a linked guarantee

declined_at

date-time | null

The datetime when this quote was declined. Will only show up if the quote has been declined; once it has been declined, it can no longer be accepted

coverage_start_date

string

The day on which coverage begins

coverage_end_date

string

The day on which coverage ends

currency

string

length between 3 and 3

3 character ISO code representing the currency of the quote - overrides the Product default if provided.

coverage_start_hour

string

The hour when coverage begins on each of the covered days - determined by Product

coverage_end_hour

string

The hour when coverage ends on each of the covered days - determined by Product

wholesale_price

float

The price of the Guarantee excluding any markups

suggested_price

float

The price of the Guarantee including suggested markups

tax_amount

float

The amount of tax assessed on the quote price

tax_rate

float

The tax rate assessed on the quote price.

exposure_name

string

length ≥ 1

The human-readable/user-facing name of the location or experience being covered. This field has a character limit of 50, any longer content will be truncated.

exposure_latitude

float

-90 to 90

The latitude in decimal degrees of the exposure location

exposure_longitude

float

-180 to 180

The longitude in decimal degrees of the exposure location

exposure_total_coverage_amount

float

≥ 0.01

The total value of the exposure to be covered

exposure_protections

array of objects

The specific protections and the thresholds at which a given hour will be considered bad weather

exposure_protections

object

name

string

The type of bad weather that is covered

unit

string

The units that the threshold is measured in

upper_threshold

float

The value at which the observed weather at or above this threshold counts as covered weather. Either upper or lower will be present depending on the type of weather

lower_threshold

float

The value at which the observed weather at or below this threshold counts as covered weather. Either upper or lower will be present depending on the type of weather

payout_tiers

array of objects

The schedule matching payout amount to minimum hours of bad weather experienced

payout_tiers

object

number_of_hours

float

The minimum number of hours that will trigger this payout

payout_amount

float

The amount that will be paid out if the number of hours has been met for a single period of coverage

documents

array of objects

documents

object

name

string

Terms and Conditions Privacy Policy

link

url

200Quote successfully created

400Error: createGuaranteeQuote request has invalid fields in the request body

401Error: request is not authorized

404Error: Product not found for given Product ID

422Error: createGuaranteeQuote request could not be processed, typically because the quote start time is within 24 hours or the quote risk is too high

500Unexpected internal service error

503Retryable internal service error