For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get access
Getting Started Key Concepts Integration Types Core Components Embed Hosted API API Reference
  • API Reference
    • Contribution Reports
    • Events and Webhooks
      • GETRetrieve a dependents management intent
      • GETRetrieve associated persons eligibility for a dependents management intent
      • POSTAdd dependents to a dependents management intent
      • DELRemove a dependent from a Dependents Management Intent
      • POSTConfirm dependent list
      • POSTCancel the dependents management intent
    • API Errors
Get access
LogoLogo
API ReferenceDependents Management Intents

Retrieve associated persons eligibility for a dependents management intent

GET
/dependents_management_intents/:dependents_management_intent_id/associated_persons_eligibility
GET
/dependents_management_intents/:dependents_management_intent_id/associated_persons_eligibility
$curl https://test.api.kota.io/dependents_management_intents/dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a/associated_persons_eligibility \
>     -H "Authorization: Bearer <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "items": [
3    {
4      "associated_person_id": "ap_7f9c2d8a4e6b4f3a9c1d2e7f8b0a1234",
5      "first_name": "Emily",
6      "last_name": "Johnson",
7      "date_of_birth": "2010-05-15",
8      "sex_at_birth": "female",
9      "relationship": "child",
10      "eligibility_status": "eligible",
11      "object": "associated_person_eligibility"
12    },
13    {
14      "associated_person_id": "ap_1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p",
15      "first_name": "Michael",
16      "last_name": "Johnson",
17      "date_of_birth": "1980-11-22",
18      "sex_at_birth": "male",
19      "relationship": "spouse",
20      "eligibility_status": "ineligible",
21      "ineligibility_reason": "Not enrolled in the current plan",
22      "object": "associated_person_eligibility"
23    }
24  ],
25  "page": 1,
26  "page_size": 2,
27  "total_count": 2,
28  "has_next_page": false,
29  "has_previous_page": false
30}

Retrieves all associated persons for the employee with their eligibility status for the specific policy/plan.

Previous

Retrieve a dependents management intent

Next

Add dependents to a dependents management intent

Built with

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

dependents_management_intent_idstringRequiredformat: "dmi_.+"

Query parameters

pageintegerOptional
The page of results to return. Defaults to 1 if not provided.
page_sizeintegerOptional
The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

Response

OK
itemslist of objects
A paginated array containing the response elements
pageinteger
The current page of the results
page_sizeinteger
The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size
total_countinteger
The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.
has_next_pagebooleanRead-only
Whether there are more pages available after this page
has_previous_pagebooleanRead-only
Whether there are more pages available before this page

Errors

404
Not Found Error