Skip to content

Short-Term API 1.0 documentation

Quotes

A quote request is created as part of the cover details step.

Retrieving Quotes

The quote request endpoint is polled for the incoming quotes. The quote request endpoint should be polled until completed is true.

quotes screen — Quotes Screen

Single Quote Example (Not Complete)

This example shows the request and corresponding response. The response denotes that quoting is not complete, but a single quote has been processed.

Request

curl -X 'GET' \
  'https://st.igate-test.co.uk/api/v1/quote-requests/b224f44b-d620-4176-bccb-104a61175e84/' \
  -H 'Authorization: Bearer abc123xyz...' \
  -H 'accept: application/json'

Response

Type: 200 OK

{
  "url": "https://st.igate-test.co.uk/api/v1/quote-requests/b224f44b-d620-4176-bccb-104a61175e84/",
  "uuid": "b224f44b-d620-4176-bccb-104a61175e84",
  "policy_start_date": "2025-01-20",
  "vehicle": "https://st.igate-test.co.uk/api/v1/user/vehicles/09eef7c7-e1b3-4574-ab7b-2d935cf209fc/",
  "vehicle_keeper": "https://st.igate-test.co.uk/api/v1/user/vehicle-keepers/d0373a50-8ed8-4ac9-a1bf-a964c8915699/",
  "days_required": 5,
  "reason_id": "1",
  "reason_name": "Borrowing someone's car",
  "completed": false,
  "quotes_all_returned": false,
  "quote_principle_returned": true,
  "quote_pitch": "**Best Value** quote is **14 days** cover for only **4.60** per day.",
  "quotes": [
    {
      "url": "https://st.igate-test.co.uk/api/v1/quote-requests/quotes/9e1cd7ea-39bb-421b-8c4b-57acbf397152/",
      "uuid": "9e1cd7ea-39bb-421b-8c4b-57acbf397152",
      "created_at": "2025-01-20T11:59:22.341419Z",
      "updated_at": "2025-01-20T11:59:22.346240Z",
      "quote_days": 14,
      "principle": true,
      "quote_ref": "199/3949167/Z442/WEB",
      "quote_status": "QUOTE",
      "quote_price": "64.40",
      "quote_fees": "5.00",
      "quote_day_price": "4.60",
      "label": "Your Quote",
      "cheapest_quote": false,
      "best_value_quote": false,
      "show_quote": true
    }
  ]
}

Notes

The above request has quotes processing as completed is false.
A single quote has been processed at this time.
quote_pitch is the text to display below the quotes - this mat be null. Here it has updated due to the
incoming quote.

Quotes Processed

By polling the quote request endpoint further the response will change:

Request

curl -X 'GET' \
  'https://st.igate-test.co.uk/api/v1/quote-requests/b224f44b-d620-4176-bccb-104a61175e84/' \
  -H 'Authorization: Bearer abc123xyz...' \
  -H 'accept: application/json'

Response

Type: 200 OK

{
  "url": "https://st.igate-test.co.uk/api/v1/quote-requests/b224f44b-d620-4176-bccb-104a61175e84/",
  "uuid": "b224f44b-d620-4176-bccb-104a61175e84",
  "policy_start_date": "2025-01-20",
  "vehicle": "https://st.igate-test.co.uk/api/v1/user/vehicles/09eef7c7-e1b3-4574-ab7b-2d935cf209fc/",
  "vehicle_keeper": "https://st.igate-test.co.uk/api/v1/user/vehicle-keepers/d0373a50-8ed8-4ac9-a1bf-a964c8915699/",
  "days_required": 5,
  "reason_id": "1",
  "reason_name": "Borrowing someone's car",
  "completed": true,
  "quotes_all_returned": true,
  "quote_principle_returned": true,
  "quote_pitch": "**Best Value** quote is **17 days** cover for only **4.20** per day. Extend your insurance and save!",
  "quotes": [
    {
      "url": "https://st.igate-test.co.uk/api/v1/quote-requests/quotes/9e1cd7ea-39bb-421b-8c4b-57acbf397152/",
      "uuid": "9e1cd7ea-39bb-421b-8c4b-57acbf397152",
      "created_at": "2025-01-20T11:59:22.341419Z",
      "updated_at": "2025-01-20T11:59:22.346240Z",
      "quote_days": 14,
      "principle": true,
      "quote_ref": "199/3949167/Z442/WEB",
      "quote_status": "QUOTE",
      "quote_price": "64.40",
      "quote_fees": "5.00",
      "quote_day_price": "4.60",
      "label": "Your Quote",
      "cheapest_quote": false,
      "best_value_quote": false,
      "show_quote": true
    },
    {
      "url": "https://st.igate-test.co.uk/api/v1/quote-requests/quotes/9e1cd7ea-39bb-421b-8c4b-57acbf397153/",
      "uuid": "9e1cd7ea-39bb-421b-8c4b-57acbf397153",
      "created_at": "2025-01-20T11:59:23.341419Z",
      "updated_at": "2025-01-20T11:59:23.346240Z",
      "quote_days": 10,
      "principle": false,
      "quote_ref": "199/3949167/Z443/WEB",
      "quote_status": "QUOTE",
      "quote_price": "48.00",
      "quote_fees": "5.00",
      "quote_day_price": "4.20",
      "label": "Cheapest",
      "cheapest_quote": true,
      "best_value_quote": false,
      "show_quote": true
    },
    {
      "url": "https://st.igate-test.co.uk/api/v1/quote-requests/quotes/9e1cd7ea-39bb-421b-8c4b-57acbf397154/",
      "uuid": "9e1cd7ea-39bb-421b-8c4b-57acbf397154",
      "created_at": "2025-01-20T11:59:24.341419Z",
      "updated_at": "2025-01-20T11:59:24.346240Z",
      "quote_days": 17,
      "principle": false,
      "quote_ref": "199/3949167/Z444/WEB",
      "quote_status": "QUOTE",
      "quote_price": "71.40",
      "quote_fees": "5.00",
      "quote_day_price": "4.20",
      "label": "Best value",
      "cheapest_quote": false,
      "best_value_quote": false,
      "show_quote": true
    }
  ]
}

Notes

completed is now true and therefore all quotes have been received for this request.
quote_pitch has updated with the new details from the new quotes.

No Received Quotes

Note the number of quotes processed for a quote request may vary, and can sometimes be empty. Wait until the quote request states that completed is true before handling no quotes.

Request

curl -X 'GET' \
  'https://st.igate-test.co.uk/api/v1/quote-requests/b224f44b-d620-4176-bccb-104a61175e84/' \
  -H 'Authorization: Bearer abc123xyz...' \
  -H 'accept: application/json'

Response

Type: 200 OK

{
  "url": "https://st.igate-test.co.uk/api/v1/quote-requests/b224f44b-d620-4176-bccb-104a61175e84/",
  "uuid": "b224f44b-d620-4176-bccb-104a61175e84",
  "policy_start_date": "2025-01-20",
  "vehicle": "https://st.igate-test.co.uk/api/v1/user/vehicles/09eef7c7-e1b3-4574-ab7b-2d935cf209fc/",
  "vehicle_keeper": "https://st.igate-test.co.uk/api/v1/user/vehicle-keepers/d0373a50-8ed8-4ac9-a1bf-a964c8915699/",
  "days_required": 5,
  "reason_id": "1",
  "reason_name": "Borrowing someone's car",
  "completed": true,
  "quotes_all_returned": false,
  "quote_principle_returned": false,
  "quote_pitch": null,
  "quotes": []
}