Retrieve a dependents management intent | Kota Developer Products Documentation

curl https://test.api.kota.io/dependents_management_intents/dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json"

{
  "id": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "parent_intent_id": "pai_7f8e9d6c4b3a2f1e0d9c8b7a6f5e4d3c",
  "parent_intent_type": "policy_amendment_intent",
  "status": "action_required",
  "dependents": [
    {
      "associated_person_id": "ap_9f8e7d6c5b4a3e2d1c0b9a8f7e6d5c4b",
      "status": "pending_confirmation"
    }
  ],
  "plan": {
    "id": "pl_4d3c2b1a0f9e8d7c6b5a4e3f2d1c0b9a",
    "name": "Comprehensive Family Health Plan",
    "description": "A health insurance plan covering the entire family with extensive benefits.",
    "pricing": {
      "type": "per_member",
      "per_member": {
        "currency": "usd",
        "member_type_pricing": [
          {
            "code": "adult",
            "display_name": "Adult",
            "monthly_premium": 350
          },
          {
            "code": "young_adult",
            "display_name": "Young Adult",
            "monthly_premium": 250
          },
          {
            "code": "child",
            "display_name": "Child",
            "monthly_premium": 150
          }
        ]
      }
    }
  },
  "disclosures": [
    {
      "category": "regulatory",
      "type": "intermediary_role",
      "text": "This intermediary acts as a broker and does not underwrite the insurance products."
    }
  ],
  "object": "dependents_management_intent"
}

curl https://test.api.kota.io/dependents_management_intents/dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json"

{
  "id": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "parent_intent_id": "pai_7f8e9d6c4b3a2f1e0d9c8b7a6f5e4d3c",
  "parent_intent_type": "policy_amendment_intent",
  "status": "action_required",
  "dependents": [
    {
      "associated_person_id": "ap_9f8e7d6c5b4a3e2d1c0b9a8f7e6d5c4b",
      "status": "pending_confirmation"
    }
  ],
  "plan": {
    "id": "pl_4d3c2b1a0f9e8d7c6b5a4e3f2d1c0b9a",
    "name": "Comprehensive Family Health Plan",
    "description": "A health insurance plan covering the entire family with extensive benefits.",
    "pricing": {
      "type": "per_member",
      "per_member": {
        "currency": "usd",
        "member_type_pricing": [
          {
            "code": "adult",
            "display_name": "Adult",
            "monthly_premium": 350
          },
          {
            "code": "young_adult",
            "display_name": "Young Adult",
            "monthly_premium": 250
          },
          {
            "code": "child",
            "display_name": "Child",
            "monthly_premium": 150
          }
        ]
      }
    }
  },
  "disclosures": [
    {
      "category": "regulatory",
      "type": "intermediary_role",
      "text": "This intermediary acts as a broker and does not underwrite the insurance products."
    }
  ],
  "object": "dependents_management_intent"
}

Retrieves a dependents_management_intent object by ID.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

dependents_management_intent_idstringRequiredformat: "dmi_.+"

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

404

Not Found Error

$	curl https://test.api.kota.io/dependents_management_intents/dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json"

1	{
2	"id": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"parent_intent_id": "pai_7f8e9d6c4b3a2f1e0d9c8b7a6f5e4d3c",
4	"parent_intent_type": "policy_amendment_intent",
5	"status": "action_required",
6	"dependents": [
7	{
8	"associated_person_id": "ap_9f8e7d6c5b4a3e2d1c0b9a8f7e6d5c4b",
9	"status": "pending_confirmation"
10	}
11	],
12	"plan": {
13	"id": "pl_4d3c2b1a0f9e8d7c6b5a4e3f2d1c0b9a",
14	"name": "Comprehensive Family Health Plan",
15	"description": "A health insurance plan covering the entire family with extensive benefits.",
16	"pricing": {
17	"type": "per_member",
18	"per_member": {
19	"currency": "usd",
20	"member_type_pricing": [
21	{
22	"code": "adult",
23	"display_name": "Adult",
24	"monthly_premium": 350
25	},
26	{
27	"code": "young_adult",
28	"display_name": "Young Adult",
29	"monthly_premium": 250
30	},
31	{
32	"code": "child",
33	"display_name": "Child",
34	"monthly_premium": 150
35	}
36	]
37	}
38	}
39	},
40	"disclosures": [
41	{
42	"category": "regulatory",
43	"type": "intermediary_role",
44	"text": "This intermediary acts as a broker and does not underwrite the insurance products."
45	}
46	],
47	"object": "dependents_management_intent"
48	}