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

Yuzu Health Enrollment API

The Enrollment API from Yuzu Health — 3 operation(s) for enrollment.

Yuzu Health Enrollment API is one of 10 APIs that Yuzu Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Enrollment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 3 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 0.5.

Requests are made against the base URL https://api.yuzu.health.

3 operations 3 paths 4 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.5
Base URL
https://api.yuzu.health
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Yuzu Health Enrollment API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (public-api-auth).

Paths & Operations 3

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

Enrollment 3
POST
/v3/groups/{groupPolicyId}/enroll/add-subscriber
Add subscribers to an existing plan
PublicEnrollmentApplicationController_createAddSubscriber 1 param body → 200
POST
/v3/groups/{groupPolicyId}/enroll/{subscriberCoverageId}/add-dependent
Add a dependent to an existing subscriber
PublicEnrollmentApplicationController_createAddDependent 2 params body → 200
POST
/v3/groups/{groupPolicyId}/enroll/terminate
Terminate coverage on an existing plan
PublicEnrollmentApplicationController_createTermination 1 param body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are TerminationDto (4 properties), AddDependentDto (4 properties), EnrollmentRequestDto (3 properties), AddSubscriberDto (3 properties). Each schema is shown below with its type and property counts.

AddDependentDto
object
4 properties 4 required
TerminationDto
object
4 properties 2 required
AddSubscriberDto
object
3 properties 2 required
EnrollmentRequestDto
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yuzu-health-enrollment-api-openapi.yml Raw ↑

Other APIs Yuzu Health publishes across the network.

Yuzu Health Accumulator (Experimental) API
Yuzu Health Benefits API
Yuzu Health Coverage API
Yuzu Health EOB (Experimental) API
Yuzu Health Group Policy API
Yuzu Health Member API
Yuzu Health PublicApiV1 API
Yuzu Health PublicApiV2 API
Yuzu Health Sponsor API