Add dependents to a dependents management intent | Kota Developer Products Documentation

curl -X POST https://test.api.kota.io/dependents_management_intents/dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a/dependents \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "associated_person_ids": [
    "ap_7f9c2d8e4a1b4c3d9e0f123456789abc"
  ]
}'

{
  "id": "dmi_7f9c2d8e4a1b4c3d9e0f123456789abc",
  "parent_intent_id": "pai_4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b",
  "parent_intent_type": "policy_amendment_intent",
  "status": "action_required",
  "dependents": [
    {
      "associated_person_id": "ap_7f9c2d8e4a1b4c3d9e0f123456789abc",
      "status": "pending_confirmation"
    }
  ],
  "plan": {
    "id": "pl_1a2b3c4d5e6f7g8h9i0jklmnopqrstuv",
    "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 underwrite the insurance products."
    }
  ],
  "object": "dependents_management_intent"
}

Adds one or more existing associated persons as dependents to a dependents management intent.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

dependents_management_intent_idstringRequiredformat: "dmi_.+"

Request

This endpoint expects an object.

associated_person_idslist of stringsRequired

List of associated person IDs to add as dependents. Must not be empty.

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