Remove a dependent from a Dependents Management Intent | Kota Developer Products Documentation

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

{
  "id": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "parent_intent_id": "pai_7f8e9d6c4b2a1f0e3d4c5b6a",
  "parent_intent_type": "policy_amendment_intent",
  "status": "action_required",
  "dependents": [
    {
      "associated_person_id": "ap_9f8e7d6c5b4a3e2d1c0b9a8f",
      "status": "pending_confirmation"
    }
  ],
  "plan": {
    "id": "pl_4a3b2c1d0e9f8a7b6c5d4e3f",
    "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 policy."
    }
  ],
  "object": "dependents_management_intent"
}

Removes a specific dependent from a Dependents Management Intent by their associated person ID. The operation returns the updated DMI state.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

dependents_management_intent_idstringRequiredformat: "dmi_.+"

associated_person_idstringRequiredformat: "ap_.+"

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