Create a group quote intent

POST

/group_quote_intents

POST

/group_quote_intents

$ curl -X POST https://test.api.kota.io/group_quote_intents \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
>   "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a"
> }'

1 {
2   "id": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3   "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
4   "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
5   "status": "processing",
6   "consent_links": [
7     {
8       "type": "terms_of_business",
9       "url": "string",
10       "version": "string"
11     }
12   ],
13   "disclosures": [
14     {
15       "category": "regulatory",
16       "type": "intermediary_role",
17       "text": "string"
18     }
19   ],
20   "cost_sharing": null,
21   "expected_start_date": "2024-12-01",
22   "action_required": null,
23   "object": "string"
24 }

Creates a group_quote_intent to request a quote for a group and plan combination. The intent coordinates the quote workflow including requirements collection and quote generation.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Request

This endpoint expects an object.

group_idstringRequiredformat: "gr_.+"

Unique identifier for the group to get a quote for

plan_idstringRequiredformat: "pl_.+"

Unique identifier for the plan to get a quote for

cost_sharingobjectOptional

Cost sharing configuration for the quote

expected_start_datedate or nullOptional

Expected start date for the insurance coverage

coverage_selectionslist of objects or nullOptional

Plan coverage option selections for group-policy-scoped configurations.

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

400

Bad Request Error

404

Not Found Error