Create a dependents management intent for a policy amendment

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 '{}'

{
  "id": "dmi_7f9a2c4e8b1d4f3a9c2e7b6d5a8f9e01",
  "parent_intent_id": "pai_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "parent_intent_type": "policy_amendment_intent",
  "status": "action_required",
  "dependents": [
    {
      "associated_person_id": "ap_9c8b7a6d5e4f3a2b1c0d9e8f7a6b5c4d",
      "status": "pending_confirmation"
    }
  ],
  "plan": {
    "id": "pl_4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a",
    "name": "Comprehensive Family Health Plan",
    "description": "A health insurance plan covering the entire family with extensive benefits.",
    "pricing": {
      "type": "per_member"
    }
  },
  "disclosures": [
    {
      "category": "regulatory",
      "type": "intermediary_role",
      "text": "This intermediary acts as a broker and does not provide medical advice."
    }
  ],
  "object": "dependents_management_intent"
}

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.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

policy_idstringRequiredformat: "p_.+"

idstringRequiredformat: "pai_.+"

Response

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