Group Quote Intents

Retrieve the quote for a group quote intent

Changed on

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

get/group_quote_intents/{group_quote_intent_id}/quote

Request

  • Base URL
    https://test.api.kota.io
  • URL
    https://test.api.kota.io/group_quote_intents/{group_quote_intent_id}/quote
  • Auth
    HTTP bearer

Path parameters

group_quote_intent_idstring required
Example:gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a

Response

OK

employee_countinteger required

Number of employees covered by the quote. An employee covered by more than one of the quote's levels is counted once.

total_monthly_premiumnumber double required

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

total_annual_premiumnumber double required

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 required

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.

pdf_urlstring nullable

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_atstring date-time nullable

When the PDF URL expires

generated_atstring date-time required

When the quote was generated

expires_atstring date-time required

When the quote expires

objectstring

Object type identifier

Example response

{
  "employee_count": 123,
  "cost_sharing": {
    "member_count": {
      "adults": 123,
      "children": 123
    },
    "member_selection": {
      "partner": true,
      "children": true
    },
    "member_selection_percentage_based": {
      "partner": true,
      "children": true,
      "percentage": 123
    },
    "percentage": {
      "percentage": 123
    },
    "fixed_amount": {
      "monthly_amount": 123.45
    },
    "pooled_member_count": {
      "dependents": 123
    }
  },
  "total_monthly_premium": 123.45,
  "total_annual_premium": 123.45,
  "breakdown": [
    {
      "amount": 123.45
    }
  ],
  "pdf_expires_at": "2024-12-01T00:00:00Z",
  "quote_pdfs": [
    {
      "expires_at": "2024-12-01T00:00:00Z"
    }
  ],
  "levels": [
    {
      "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "employee_count": 123,
      "monthly_premium": 123.45,
      "annual_premium": 123.45,
      "cost_sharing": {
        "member_count": {
          "adults": 123,
          "children": 123
        },
        "member_selection": {
          "partner": true,
          "children": true
        },
        "member_selection_percentage_based": {
          "partner": true,
          "children": true,
          "percentage": 123
        },
        "percentage": {
          "percentage": 123
        },
        "fixed_amount": {
          "monthly_amount": 123.45
        },
        "pooled_member_count": {
          "dependents": 123
        }
      },
      "quote_pdfs": [
        {
          "expires_at": "2024-12-01T00:00:00Z"
        }
      ]
    }
  ],
  "generated_at": "2024-12-01T00:00:00Z",
  "expires_at": "2024-12-01T00:00:00Z"
}

Changes

  • 998f7cb004abRevision changes
    • warning

      deleted the header request parameter X-Platform-Id

  • ce9736d28f93Revision changes
    • warning

      added the new pooled_member_count enum value to the ///////// response property for the response status

    • warning

      added the new pooled_member_count enum value to the /////////// response property for the response status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /////// to the response with the status