For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get access
Getting Started Key Concepts Integration Types Core Components Embed Hosted API API Reference
  • API Reference
    • Contribution Reports
    • Events and Webhooks
      • GETList all policy amendment intents for a policy
      • POSTCreate a new policy amendment intent
      • GETRetrieve a policy amendment intent
      • POSTConfirm policy amendment intent
      • POSTCancel a policy amendment intent
      • POSTCreate a dependents management intent for a policy amendment
    • API Errors
Get access
LogoLogo
API ReferencePolicy Amendment Intents

Create a dependents management intent for a policy amendment

POST
/policies/:policy_id/policy_amendment_intents/:id/create_dependents_management_intent
POST
/policies/:policy_id/policy_amendment_intents/:id/create_dependents_management_intent
$curl -X POST https://test.api.kota.io/policies/p_3b1333d87d9d4fd6ad83ba7f6b0e951a/policy_amendment_intents/pai_3b1333d87d9d4fd6ad83ba7f6b0e951a/create_dependents_management_intent \
>     -H "Authorization: Bearer <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "id": "dmi_7f9a2c4e8b1d4f3a9c2e7b6d5a8f9e01",
3  "parent_intent_id": "pai_3b1333d87d9d4fd6ad83ba7f6b0e951a",
4  "parent_intent_type": "policy_amendment_intent",
5  "status": "action_required",
6  "dependents": [
7    {
8      "associated_person_id": "ap_9c8b7a6d5e4f3a2b1c0d9e8f7a6b5c4d",
9      "status": "pending_confirmation"
10    }
11  ],
12  "plan": {
13    "id": "pl_4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a",
14    "name": "Comprehensive Family Health Plan",
15    "description": "A health insurance plan covering the entire family with extensive benefits.",
16    "pricing": {
17      "type": "per_member"
18    }
19  },
20  "disclosures": [
21    {
22      "category": "regulatory",
23      "type": "intermediary_role",
24      "text": "This intermediary acts as a broker and does not provide medical advice."
25    }
26  ],
27  "object": "dependents_management_intent"
28}

Creates a dependents management intent as a sub-intent of a policy amendment intent. The sub-intent allows the platform to add or remove dependents from the policy. The policy amendment intent must be in action_required status with a dependents requested change.

Previous

Cancel a policy amendment intent

Next

List all policy import intents

Built with

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

policy_idstringRequiredformat: "p_.+"
idstringRequiredformat: "pai_.+"

Response

OK
idstringformat: "dmi_.+"

Unique identifier for the dependents management intent. Prefixed with dmi_.

parent_intent_idstring

The parent intent ID (e.g. Policy Amendment Intent ID). Prefixed based on type.

parent_intent_typeenum
The type of parent intent.
Allowed values:
statusenum
Current status of the dependents management intent.
Allowed values:
dependentslist of objects
List of dependents being managed.
planobject
Plan information including pricing details.
disclosureslist of objects
Disclosures associated with this intent.
objectstringRead-only
Object type identifier.

Errors

400
Bad Request Error
404
Not Found Error