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 Policy Amendment Intents API

The Policy Amendment Intents API from Kota — 5 operation(s) for policy amendment intents.

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

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

This API exposes 6 operations across 5 paths, and defines 58 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 5 paths 58 schemas 2 GET4 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 Policy Amendment Intents 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 5 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Policy Amendment Intents 6
GET
/policies/{policy_id}/policy_amendment_intents
List all policy amendment intents for a policy
ListPolicyAmendmentIntents 4 params → 200400404
POST
/policies/{policy_id}/policy_amendment_intents
Create a new policy amendment intent
CreatePolicyAmendmentIntent 1 param body → 400200404
GET
/policies/{policy_id}/policy_amendment_intents/{policy_amendment_intent_id}
Retrieve a policy amendment intent
RetrievePolicyAmendmentIntent 2 params → 200404
POST
/policies/{policy_id}/policy_amendment_intents/{policy_amendment_intent_id}/confirm
Confirm policy amendment intent
ConfirmPolicyAmendmentIntent 2 params → 204404400
POST
/policies/{policy_id}/policy_amendment_intents/{id}/cancel
Cancel a policy amendment intent
CancelPolicyAmendmentIntent 2 params → 204400404
POST
/policies/{policy_id}/policy_amendment_intents/{id}/create_dependents_management_intent
Create a dependents management intent for a policy amendment
CreateDependentsManagementIntentForPolicyAmendment 2 params → 200400404

Schemas 58

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

PlanWithPricingResponse
object
4 properties 4 required
PlanCoverageOptionInputType
string
PolicyAmendmentDependentsResponse
object
2 properties
PlanCoverageOptionScope
string
CreatePolicyAmendmentIntentRequest
object
2 properties 2 required
PlanCoverageResponse
object
11 properties 6 required
DependentsManagementIntentStatus
string
TierBasedPricingResponse
object
2 properties 2 required
PolicyAmendmentRequestedChangeRequest
object
1 property 1 required
QualifyingLifeEventSupplementalInfo
object
3 properties 2 required
PlanPricingResponse
object
3 properties 1 required
PlanCoverageOptionResponse
object
8 properties 2 required
PlanPricingType
string
PolicyAmendmentQuoteResponse
object
3 properties 3 required
PolicyAmendmentQuoteAmountResponse
object
3 properties 3 required
PolicyAmendmentRequestedChangeResponse
object
1 property 1 required
PolicyAmendmentProcessingErrorResponse
object
3 properties 3 required
PolicyAmendmentReasonResponse
object
2 properties 1 required
DependentsManagementIntentDependentStatus
string
MemberTypeCode
string
PolicyAmendmentRequiredActionResponse
object
5 properties 5 required
PolicyAmendmentIntentResponsePagedList
object
6 properties 4 required
DisclosureType
string
EmployerEligibilityCriterionType
string
MembersCountDetails
object
2 properties
CurrencyCode
string
PricingTierResponse
object
5 properties 5 required
AmendmentReasonType
string
MemberTypePricingResponse
object
3 properties 3 required
IndustryExclusionsDetails
object
1 property 1 required
FamilyTierCode
string
DependentsManagementIntentActionRequiredResponse
object
4 properties 4 required
PolicyAmendmentIntentStatus
string
DependentsManagementIntentActionCode
string
QualifyingLifeEventType
string
PolicyAmendmentIntentResponse
object
10 properties 6 required
PolicyAmendmentReasonRequest
object
2 properties 1 required
DependentInfoResponse
object
4 properties 2 required
PolicyAmendmentQuoteContributionsResponse
object
3 properties 3 required
ProblemDetails
object
5 properties
PolicyAmendmentIntentFailureCode
string
DependentsManagementIntentResponse
object
10 properties 7 required
RequestedChangeType
string
PlanCoverageOptionBenefitResponse
object
2 properties 1 required
DisclosureResponse
object
3 properties 3 required
SelectedOptionResponse
object
2 properties 1 required
PlanCoverageOptionSelectionResponse
object
2 properties 2 required
AssociatedPersonType
string
PolicyAmendmentActionCode
string
PolicyAmendmentQualifyingLifeEventResponse
object
3 properties 2 required
PolicyAmendmentIntentConfirmationCode
string
DisclosureCategory
string
PolicyAmendmentAssociatedPersonsResponse
object
2 properties 1 required
PerMemberPricingResponse
object
2 properties 2 required
EmployerEligibilityCriterionResponse
object
5 properties 2 required
DependentsManagementIntentParentType
string
PolicyAmendmentPendingConfirmationResponse
object
6 properties 4 required
EmployeesCountDetails
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kota-policy-amendment-intents-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 dependentsManagementIntents API
Kota Embed Sessions API
Kota embedSessions API
Kota employees API
Kota employers API
Kota Enrolment Intents API
Kota enrolmentIntents API