Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kota dependentsManagementIntents API

The dependentsManagementIntents API from Kota — 6 operation(s) for dependentsmanagementintents.

Kota dependentsManagementIntents API is one of 33 APIs that Kota publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include dependentsManagementIntents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 6 paths, and defines 44 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://test.api.kota.io, https://api.kota.io.

6 operations 6 paths 44 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.kota.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kota dependentsManagementIntents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Authorization header using the Bearer scheme

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

dependentsManagementIntents 6
GET
/dependents_management_intents/{dependents_management_intent_id}
Retrieve a dependents management intent
retrieve-dependents-management-intent 2 params → 200404
GET
/dependents_management_intents/{dependents_management_intent_id}/associated_persons_eligibility
Retrieve associated persons eligibility for a dependents management intent
get-associated-persons-eligibility 4 params → 200404
POST
/dependents_management_intents/{dependents_management_intent_id}/dependents
Add dependents to a dependents management intent
add-dependents-to-dependents-management-intent 2 params body → 200400404
DELETE
/dependents_management_intents/{dependents_management_intent_id}/dependents/{associated_person_id}
Remove a dependent from a Dependents Management Intent
remove-dependent-from-dependents-management-intent 3 params → 200400404
POST
/dependents_management_intents/{dependents_management_intent_id}/confirm
Confirm dependent list
confirm-dependents-management-intent 2 params → 204400404
POST
/dependents_management_intents/{dependents_management_intent_id}/cancel
Cancel the dependents management intent
cancel-dependents-management-intent 2 params → 204400404

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are PlanCoverageResponse (11 properties), DependentsManagementIntentResponse (10 properties), AssociatedPersonEligibilityResponse (9 properties), PlanCoverageOptionResponse (8 properties). Each schema is shown below with its type and property counts.

PlanWithPricingResponse
object
4 properties 4 required
PlanCoverageOptionInputType
string
PlanCoverageOptionScope
string
PlanCoverageResponse
object
11 properties 6 required
PlanCoverageOptionSelectionRequest
object
2 properties 2 required
DependentsManagementIntentStatus
string
AssociatedPersonEligibilityResponsePagedList
object
6 properties 4 required
TierBasedPricingResponse
object
2 properties 2 required
DependentCoverageSelectionsRequest
object
2 properties 2 required
SelectedOptionRequest
object
2 properties 1 required
PlanPricingResponse
object
3 properties 1 required
Dependents Management Intents_ConfirmDependentsManagementIntent_Response_204
object
Empty response body
PlanCoverageOptionResponse
object
8 properties 2 required
PlanPricingType
string
RelationshipType
string
SexAtBirth
string
DependentsManagementIntentDependentStatus
string
MemberTypeCode
string
DisclosureType
string
EmployerEligibilityCriterionType
string
MembersCountDetails
object
2 properties
CurrencyCode
string
PricingTierResponse
object
5 properties 5 required
MemberTypePricingResponse
object
3 properties 3 required
IndustryExclusionsDetails
object
1 property 1 required
FamilyTierCode
string
DependentsManagementIntentActionRequiredResponse
object
4 properties 4 required
AssociatedPersonEligibilityResponse
object
9 properties 7 required
DependentsManagementIntentActionCode
string
DependentInfoResponse
object
4 properties 2 required
ProblemDetails
object
5 properties
DependentsManagementIntentResponse
object
10 properties 7 required
PlanCoverageOptionBenefitResponse
object
2 properties 1 required
DisclosureResponse
object
3 properties 3 required
SelectedOptionResponse
object
2 properties 1 required
PlanCoverageOptionSelectionResponse
object
2 properties 2 required
EligibilityStatus
string
DisclosureCategory
string
PerMemberPricingResponse
object
2 properties 2 required
AddDependentsRequest
object
2 properties 1 required
EmployerEligibilityCriterionResponse
object
5 properties 2 required
DependentsManagementIntentParentType
string
Dependents Management Intents_CancelDependentsManagementIntent_Response_204
object
Empty response body
EmployeesCountDetails
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kota-dependentsmanagementintents-api-openapi.yml Raw ↑

Other APIs Kota publishes across the network.

Kota Associated Persons API
Kota associatedPersons API
Kota Contribution Reports API
Kota contributionReports API
Kota Dependents Management Intents API
Kota Embed Sessions API
Kota embedSessions API
Kota employees API
Kota employers API
Kota Enrolment Intents API
Kota enrolmentIntents API
Kota events API