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

HealthSherpa Enrollment Sessions API

The Enrollment Sessions API from HealthSherpa — 1 operation(s) for enrollment sessions.

HealthSherpa Enrollment Sessions API is one of 5 APIs that HealthSherpa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.one.healthsherpa.com.

1 operations 1 paths 16 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.one.healthsherpa.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

HealthSherpa Enrollment Sessions API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 1

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

Enrollment Sessions 1
POST
/v1/enrollment-sessions
Start an enrollment session
createEnrollmentSession 1 param body → 200400401403409413415422

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are EnrollmentSessionApplicant (17 properties), EnrollmentSessionRequest (10 properties), EnrollmentSessionContext (7 properties), EnrollmentSessionCampaign (7 properties). Each schema is shown below with its type and property counts.

EnrollmentSessionResponseLinks
object
2 properties 2 required
EnrollmentSessionLocation
object
Routing geography plus optional street address. zipcode, fipscode, and state route the request; addressline1, addressline2, and city are used by the agent-assi…
6 properties
EnrollmentSessionClient
object
DEPRECATED legacy contact block. Every property here has a 1:1 replacement on household.applicants[] and is preferred when both are supplied: firstname → house…
4 properties
EnrollmentSessionEnrollment
object
Accepts hra. Other enrollment subobjects (specialenrollmentperiod, communicationpreferences) are not supported and are rejected with 400 invalidrequest.
1 property
EnrollmentSessionHousehold
object
householdsize must be at least 1. Applicants can include at most one primary and one spouse.
4 properties
EnrollmentSessionEnrollmentHra
object
When supplied, amount is required and must be greater than or equal to 0. 0 means the consumer declined available HRA funding; a positive value means funding w…
2 properties 1 required
ErrorResponse
object
Canonical error envelope returned by HealthSherpa-owned API endpoint, infrastructure filter, and backend service failures. The direct enrollment endpoints retu…
1 property 1 required
EnrollmentSessionApplicantIncomeSource
object
One income line attributed to this applicant. amount is required so the enrollment flow receives usable income information.
2 properties 1 required
EnrollmentSessionResponse
object
Response envelope. Fields may be null when the request omits optional inputs (for example, externalid). Clients must tolerate new top-level keys appearing addi…
3 properties 1 required
EnrollmentSessionContext
object
7 properties 7 required
EnrollmentSessionRequest
object
POST /v1/enrollment-sessions request body. Unsupported fields anywhere in the body are rejected with 400 invalidrequest. In selfservice, supply at least one of…
10 properties 1 required
EnrollmentSessionResponseWarning
object
One non-fatal warning about a single request field. New code values may be introduced additively over time; clients should treat unknown codes as 'log and cont…
3 properties 3 required
EnrollmentSessionCampaign
object
Marketing attribution. Only accepted when context.flow is selfservice; sending any field with flow: "agentassisted" is rejected with 400 invalidrequest.
7 properties
EnrollmentSessionApplicantIchra
object
4 properties
EnrollmentSessionApplicantPrescription
object
Medication identification used for Rx-matched plan ranking. At least one of id or rxnormidentifier must be supplied; entries with neither are rejected with 400…
3 properties
EnrollmentSessionApplicant
object
dateofbirth and age are mutually exclusive on the same applicant, and dateofbirth must not be in the future. sex accepts male and female. firstname / lastname…
17 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

healthsherpa-enrollment-sessions-api-openapi.yml Raw ↑

Other APIs HealthSherpa publishes across the network.

HealthSherpa Enrollments API
HealthSherpa Quotes API
HealthSherpa Reference API
HealthSherpa Utility API