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 <token>"

1 {
2   "id": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3   "group_id": "gr_9f8e7d6c5b4a3210fedcba9876543210",
4   "plan_id": "pl_1a2b3c4d5e6f7890abcdef1234567890",
5   "status": "processing",
6   "consent_links": [
7     {
8       "type": "terms_of_business",
9       "url": "https://kota.io/consents/terms-of-business/v3",
10       "version": "3.0"
11     }
12   ],
13   "disclosures": [
14     {
15       "category": "regulatory",
16       "type": "intermediary_role",
17       "text": "This intermediary acts as a broker and does not underwrite the insurance products."
18     }
19   ],
20   "cost_sharing": null,
21   "expected_start_date": "2024-12-01",
22   "action_required": null,
23   "object": "group_quote_intent"
24 }

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_idstringformat: "gr_.+"

Unique identifier for the group

plan_idstringformat: "pl_.+"

Unique identifier for the plan

statusenum

Current status of the group quote intent

consent_linkslist of objects

Consent links that need to be acknowledged

disclosureslist of objects

Disclosures associated with this intent.

cost_sharingobject

Cost sharing configuration for the quote

expected_start_datedate or null

Expected start date for the insurance coverage

action_requiredobject

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

objectstringRead-only

Object type identifier

Errors

404

Not Found Error