Quotes

Priced offers from an insurer.

GET/quotes

List quotes

The quotes this business has requested, newest first.

lock

Requires API key authentication. The API key issued to the business, sent as `<keyId>:<secret>`, for example `sk_test_0123456789abcdef0123456789abcdef:<secret>`. The key id prefix selects the environment: `sk_test_` keys read and write test data, `sk_live_` keys production data.

Parameters

productIdquerystringdefault: Only quotes for this product.

Responses

One page of quotes.

{
  "items": [],
  "pagination": null
}
boltTry it
env
GET/api/v1/quotes

Query parameters

productId

Code samples

curl -X GET '/api/v1/quotes'
POST/quotes

Request a quote

Prices a product with the answers collected on its quote form. formId and formVersion must be the ones /products/{providerId}/{productId}/form served. The stored quote is validated against the OIIS quote schema: an insurer response that fails it is 422 and no retry of the same request will help. Fetch the form from GET /products/{providerId}/{productId}/form before quoting: a formId@formVersion this API has not fetched from that insurer is 422 VALIDATION_FAILED, not 404.

lock

Requires API key authentication. The API key issued to the business, sent as `<keyId>:<secret>`, for example `sk_test_0123456789abcdef0123456789abcdef:<secret>`. The key id prefix selects the environment: `sk_test_` keys read and write test data, `sk_live_` keys production data.

Request body

application/json
{
  "providerId": null,
  "productId": "",
  "formId": "",
  "formVersion": 0,
  "configuration": null,
  "context": null,
  "country": null,
  "currency": null,
  "channel": null
}

Responses

The quote this Idempotency-Key already produced, replayed.

null
boltTry it
env
POST/api/v1/quotes

Request body

Code samples

curl -X POST '/api/v1/quotes' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "providerId": null,
  "productId": "",
  "formId": "",
  "formVersion": 0,
  "configuration": null,
  "context": null,
  "country": null,
  "currency": null,
  "channel": null
}'
GET/quotes/{providerId}/{quoteId}

Read one quote

A quote another business owns is the same 404 as one that does not exist.

lock

Requires API key authentication. The API key issued to the business, sent as `<keyId>:<secret>`, for example `sk_test_0123456789abcdef0123456789abcdef:<secret>`. The key id prefix selects the environment: `sk_test_` keys read and write test data, `sk_live_` keys production data.

Parameters

quoteIdpathstringrequireddefault: The insurer's quote id.

Responses

The stored quote.

null
boltTry it
env
GET/api/v1/quotes/{providerId}/{quoteId}

Path parameters

quoteId*

Code samples

curl -X GET '/api/v1/quotes/{providerId}/{quoteId}'