Retrieve a group quote intent

GET

/group_quote_intents/:group_quote_intent_id

GET

/group_quote_intents/:group_quote_intent_id

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

{
  "id": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "status": "processing",
  "items": [
    {
      "benefit_type": "health_insurance",
      "levels": [
        {
          "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
          "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
          "cost_sharing": null,
          "coverage_selections": null
        }
      ],
      "ref": null
    }
  ],
  "consent_links": [
    {
      "id": "cst_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "text": "string",
      "links": [
        {
          "token": "string",
          "type": "terms_of_business",
          "label": "string",
          "url": "string",
          "version": "string"
        }
      ],
      "object": "string"
    }
  ],
  "disclosures": [
    {
      "category": "regulatory",
      "type": "intermediary_role",
      "text": "string",
      "links": [
        {
          "token": "string",
          "type": "intermediary_role",
          "label": "string",
          "url": "string",
          "version": "string"
        }
      ]
    }
  ],
  "type": null,
  "cost_sharing": null,
  "expected_start_date": "2024-12-01",
  "action_required": null,
  "object": "string"
}

Retrieves a group_quote_intent object.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

group_quote_intent_idstringRequiredformat: "gqi_.+"

Response

idstringformat: "gqi_.+"

Unique identifier for the group quote intent

group_idstring or nullformat: "gr_.+"

Unique identifier for the group. Null only on a multi-level intent, whose groups are on its levels.

plan_idstring or nullformat: "pl_.+"

Unique identifier for the plan. Null only on a multi-level intent, whose plans are on its levels.

statusenum

Current status of the group quote intent

itemslist of objects

The benefits this intent quotes and the levels they are quoted at. Always present: a single intent echoes its group, plan and cost sharing as one item of one level, so a consumer reads one shape for both.

consent_linkslist of objects

The statements the customer must accept to proceed, each a sentence and the documents it names. Display them in the order given, each with its own acceptance, and submit every one back on consent_approvals when creating the group policy intent. A statement carries no type: it can bundle several documents, so its id identifies it instead. Empty until statements are configured.

disclosureslist of objects

Disclosures associated with this intent. On a multi-level intent, the deduplicated union across its levels' plans.

typeenumOptional

Whether the intent quotes one (group, plan) pair or several levels. Absent or null means single, so readers of intents created before multi-level quoting need no migration.

Allowed values:

cost_sharingobjectOptional

Cost sharing configuration for the quote. Null on a multi-level intent, whose cost sharing is per level.

expected_start_datedate or nullOptional

Expected start date for the insurance coverage

action_requiredobjectOptional

Details of the action required from the caller, if the intent is in action_required status.

objectstringOptionalRead-only

Object type identifier

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors