Retrieve the quote for a group quote intent

GET

/group_quote_intents/:group_quote_intent_id/quote

GET

/group_quote_intents/:group_quote_intent_id/quote

curl https://test.api.kota.io/group_quote_intents/gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a/quote \
     -H "Authorization: Bearer <apiKey>"

{
  "employee_count": 123,
  "total_monthly_premium": 123.45,
  "total_annual_premium": 123.45,
  "currency": "string",
  "breakdown": [
    {
      "type": "premium",
      "currency": "string",
      "amount": 123.45
    }
  ],
  "quote_pdfs": [
    {
      "url": "string",
      "expires_at": "2024-12-01T00:00:00Z"
    }
  ],
  "levels": [
    {
      "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "employee_count": 123,
      "currency": "string",
      "monthly_premium": 123.45,
      "annual_premium": 123.45,
      "cost_sharing": {
        "type": "member_count",
        "member_count": null,
        "member_selection": null,
        "member_selection_percentage_based": null,
        "percentage": null,
        "family_type": null,
        "fixed_amount": null
      },
      "quote_pdfs": [
        {
          "url": "string",
          "expires_at": "2024-12-01T00:00:00Z"
        }
      ]
    }
  ],
  "generated_at": "2024-12-01T00:00:00Z",
  "expires_at": "2024-12-01T00:00:00Z",
  "cost_sharing": null,
  "pdf_url": null,
  "pdf_expires_at": "2024-12-01T00:00:00Z",
  "object": "string"
}

Retrieves the quote details for a group_quote_intent. Returns pricing information and a fresh PDF URL. Only available when status is quote_available.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

group_quote_intent_idstringRequiredformat: "gqi_.+"

Response

employee_countinteger

Number of employees covered by the quote. On a multi-level quote, the sum across levels.

total_monthly_premiumdouble

Total monthly premium for the group, excluding any insurance premium tax. Tax is a separate line of breakdown.

total_annual_premiumdouble

Total annual premium for the group, excluding any insurance premium tax. Where the provider prices the year in its own right, this is that figure rather than twelve times the monthly premium.

currencystring

Currency of the premium (e.g. EUR, GBP). Every level of a quote is in one currency today; when a quote can span currencies, the totals and this field become null and levels[].currency is the only answer.

breakdownlist of objects

What makes up the annual cost: the premium, and the insurance premium tax charged on it when there is any. Amounts are annual and sum to what the employer pays.

quote_pdfslist of objects

The documents the provider issued for the quote as a whole. Documents issued per level are on levels[].quote_pdfs instead, and never repeated here.

levelslist of objects

The priced levels of the quote, one per level of the intent — match them up by group_id and plan_id rather than by position. Always present: a single quote returns one entry, so a consumer reads one shape for both.

generated_atdatetime

When the quote was generated

expires_atdatetime

When the quote expires

cost_sharingobjectOptional

Cost sharing configuration for the quote. Null on a multi-level quote, whose cost sharing is per level — read it from levels[].cost_sharing.

pdf_urlstring or nullOptional

URL to download the quote PDF. The first whole-quote document, or the first level document when the provider issued none for the quote as a whole. Prefer quote_pdfs, which returns every document rather than one of them.

pdf_expires_atdatetime or nullOptional

When the PDF URL expires

objectstringOptionalRead-only

Object type identifier

Errors

400

Bad Request Error

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors