Add dependents to a dependents management intent

1 import requests 2 3 url = "https://test.api.kota.io/dependents_management_intents/dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a/dependents" 4 5 payload = { "associated_person_ids": ["ap_3b1333d87d9d4fd6ad83ba7f6b0e951a"] } 6 headers = { 7 "Authorization": "Bearer <token>", 8 "Content-Type": "application/json" 9 } 10 11 response = requests.post(url, json=payload, headers=headers) 12 13 print(response.json())

1 { 2 "id": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a", 3 "parent_intent_id": "string", 4 "parent_intent_type": "policy_amendment_intent", 5 "status": "action_required", 6 "dependents": [ 7 { 8 "associated_person_id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a", 9 "status": "pending_confirmation" 10 } 11 ], 12 "object": "string" 13 }

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.

objectstring or null

Object type identifier.

Authentication

Path parameters

Request

Response

Errors