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 <token>"

1 {
2   "id": "dmi_7f9a2c4e8b1d4f3a9c2e7b6d5f8a9c0b",
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       "coverage_selections": null,
11       "requirement_id": null
12     }
13   ],
14   "plan": {
15     "id": "pl_4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a",
16     "name": "Comprehensive Family Health Plan",
17     "description": "A health insurance plan covering the entire family with extensive benefits.",
18     "pricing": {
19       "type": "per_member",
20       "per_member": null,
21       "tier_based": null
22     }
23   },
24   "disclosures": [
25     {
26       "category": "regulatory",
27       "type": "intermediary_role",
28       "text": "This policy is offered through an authorized intermediary acting on behalf of the insurer."
29     }
30   ],
31   "object": "dependents_management_intent",
32   "coverage_options": null,
33   "action_required": null
34 }

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.

statusenum

Current status of the dependents management intent.

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.

coverage_optionslist of objects or null

Available member-scoped coverage options for the plan. Present when the plan has member-scoped coverage configurations.

action_requiredobject

Details of the action required from the caller. Populated only when status is action_required and a required action has been recorded on the intent (e.g. restricted dependents detected by compliance screening).

Errors

400

Bad Request Error

404

Not Found Error