Create a group quote intent | Kota Developer Products Documentation

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

{
  "id": "gqi_4e5d6c7b8a9f0e1d2c3b4a5f6e7d8c9b",
  "group_id": "gr_9f8b7c6d5e4a3b2c1d0e9f8a7b6c5d4e",
  "plan_id": "pl_1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p",
  "status": "processing",
  "consent_links": [
    {
      "type": "terms_of_business",
      "url": "https://kota.io/consents/terms-of-business-v2.pdf",
      "version": "v2.0"
    }
  ],
  "disclosures": [
    {
      "category": "regulatory",
      "type": "intermediary_role",
      "text": "This intermediary acts as a broker and does not underwrite the insurance policies."
    }
  ],
  "object": "group_quote_intent"
}

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

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

objectstringRead-only

Object type identifier

Errors

400

Bad Request Error

404

Not Found Error