Create a group policy intent | Kota Developer Products Documentation

Creates a group_policy_intent from a group_quote_intent that has a quote available. The intent coordinates the policy setup workflow including requirements collection and policy creation.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Request

This endpoint expects an object.

quote_intent_idstringRequiredformat: "gqi_.+"

Unique identifier for the group quote intent to create a policy intent from

cost_sharingobjectOptional

Cost sharing configuration override for the setup. If not provided, falls back to the quote intent's cost sharing.

consent_approvalslist of objects or nullOptional

Consent approvals to record at the time of intent creation

Response

idstringformat: "gpi_.+"

Unique identifier for the group policy intent

group_idstringformat: "gr_.+"

Unique identifier for the group

plan_idstringformat: "pl_.+"

Unique identifier for the plan

quote_intent_idstringformat: "gqi_.+"

Unique identifier for the group quote intent this policy intent was created from

statusenum

Current status of the group policy intent

disclosureslist of objects

Disclosures associated with this intent.

due_datedatetime or null

Due date for the policy intent

cost_sharingobject or null

Cost sharing configuration for the policy intent

objectstring or nullRead-only

Object type identifier

1	import requests
2
3	url = "https://test.api.kota.io/group_policy_intents"
4
5	payload = { "quote_intent_id": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }
6	headers = {
7	"Authorization": "Bearer <apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"id": "gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
4	"plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
5	"quote_intent_id": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
6	"status": "processing",
7	"disclosures": [
8	{
9	"category": "regulatory",
10	"type": "intermediary_role",
11	"text": "string"
12	}
13	],
14	"due_date": "2024-12-01T00:00:00Z",
15	"object": "string"
16	}

Authentication

Request

Response

Errors