How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HealthSherpa Enrollments API

The Enrollments API from HealthSherpa — 7 operation(s) for enrollments.

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

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

This API exposes 9 operations across 7 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

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

9 operations 7 paths 48 schemas 3 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

HealthSherpa Enrollments 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 9

Across 7 paths, the API surfaces 9 operations — 3 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Enrollments 9
GET
/v1/enrollments
List direct enrollment applications
listEnrollments 11 params → 200400401403429500502503
POST
/v1/enrollments
Create a direct enrollment application
createEnrollment 1 param body → 200201400401403409413422
POST
/v1/enrollments/{enrollment_id}/submissions
Submit a direct enrollment application
submitEnrollmentApplication 1 param body → 202400401403404422429500
POST
/v1/enrollments/{enrollment_id}/cancellations
Cancel a direct enrollment application
cancelEnrollmentApplication 1 param body → 202400401403404429500502
POST
/v1/enrollments/{enrollment_id}/terminations
Terminate an active policy
terminateEnrollmentApplication 1 param body → 202400401403404429500502
GET
/v1/enrollments/{enrollment_id}/payment_redirect
Get payment redirect data
getEnrollmentPaymentRedirect 3 params → 200401403404422429500502
POST
/v1/enrollments/{enrollment_id}/supporting_documentation
Upload supporting documentation
uploadEnrollmentSupportingDocumentation 1 param body → 200201400401403404413415
GET
/v1/enrollments/{enrollment_id}
Fetch a direct enrollment application
getEnrollment 3 params → 200400401403404429500502
PUT
/v1/enrollments/{enrollment_id}
Update a direct enrollment application
updateEnrollment 1 param body → 200400401403404409413415

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are ApplicantBase (37 properties), ApplicationResponse (23 properties), ApplicationCreateRequest (17 properties), ApplicationEvent (12 properties). Each schema is shown below with its type and property counts.

MailingAddress
Dependent
PrimaryApplicant
PaymentRedirectResponse
object
4 properties 4 required
ApplicationCreateRequest
object
Canonical application schema accepted by POST /v1/enrollments alongside the HealthSherpa ONE context object. HealthSherpa ONE derives the application planyear…
17 properties 3 required
Guardian
object
Required for primary applicants under 18.
12 properties
SubmitRequest
object
Routing context for direct enrollment submission. HealthSherpa ONE uses this context to validate the off-exchange direct-enrollment channel. planyear is not re…
1 property 1 required
SubmitResponse
object
Response returned when an application submission is accepted. The object is additive and may include carrier-specific fields.
7 properties
PaymentInstructions
object
Carrier-specific payment guidance.
4 properties
ApplicationListResponse
object
Paginated list of direct enrollment applications.
2 properties 2 required
ExistingCoverage
object
9 properties
ResponsibleParty
object
Responsible party for a minor applicant, when someone other than the guardian is financially responsible. Required by Security Health, Sanford, Oscar, and UHC.
12 properties
AlternateAddress
object
Address for a dependent living at a different address than the primary applicant.
7 properties
HRA
object
Health Reimbursement Arrangement details. Applies to the primary applicant, the employee receiving the HRA offer. If the ICHRA is affordable, all household mem…
11 properties
Translator
object
Translator assisting the applicant. Required by some carriers when the applicant requires language assistance.
4 properties
SupportingDocumentationResponse
object
5 properties
CommunicationPreferences
object
9 properties
Address
object
6 properties 4 required
SpecialEnrollmentPeriod
object
2 properties
ApplicationListItem
object
Summary application row returned by GET /v1/enrollments.
9 properties
ApplicationResponse
object
23 properties
Employer
object
5 properties
ApplicationListPagination
object
Pagination metadata for application list responses.
3 properties 3 required
SimpleAddress
object
5 properties
AgentOfRecord
object
Agent-of-record payload. HealthSherpa ONE does not accept caller-supplied agent-of-record data on POST /v1/enrollments; attribution is derived from your approv…
10 properties
ApplicantBase
object
37 properties
EnrollmentRequest
HealthSherpa ONE direct enrollment create request. Send the application payload at the request root and include the HealthSherpa ONE context object for routing…
Signatures
object
7 properties
EnrollmentErrorDetail
object
Error entry returned in a direct enrollment failure body (errors[]). code is intentionally not a closed enum; the values below are the known set and may grow o…
3 properties 2 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
EnrollmentResponse
Successful direct enrollment application response. Successful responses can contain errors[] as submission-readiness data; error responses are documented separ…
SubmissionReadinessError
object
Submission-readiness error entry. Appears in the errors[] array of a successful enrollment response to indicate what must be completed before the application c…
3 properties 2 required
ApplicationEvent
object
12 properties 2 required
EnrollmentUpdateContext
object
Routing context for direct enrollment updates. Send product = ichra, exchange = offexchange, and planyear; planyear is mapped to the application plan year.
3 properties 3 required
EnrollmentActionContext
object
2 properties 2 required
Analytics
object
Optional tracking and attribution parameters.
5 properties
EnrollmentUpdateRequest
object
HealthSherpa ONE direct enrollment update request. Treat PUT as a full replacement-style update. Send the HealthSherpa ONE context object with product = "ichra…
2 properties 1 required
EnrollmentActionContextRequest
object
Routing context for direct enrollment action endpoints.
1 property 1 required
Applicants
object
2 properties 1 required
EnrollmentErrorsResponse
object
Error body used by the direct enrollment endpoints for service failures. Each error includes a machine-readable code, a human-readable message, and may include…
1 property 1 required
PolicyDetail
object
9 properties
Attestations
object
12 properties
StatusChangeResponse
object
Response returned for an accepted application cancellation or termination status change.
4 properties 3 required
SupportingDocumentationRequest
object
Supporting document upload request for SEP verification. JSON requests send base64-encoded file bytes; multipart requests send the binary file directly. Health…
3 properties 3 required
NextAction
object
State-aware action entry returned on successful enrollment application responses.
4 properties 3 required
EnrollmentContext
object
Routing context for direct enrollment create requests. Direct enrollment currently supports only product = ichra and exchange = offexchange. Use POST /v1/enrol…
5 properties 3 required
PolicyPaymentStatus
object
Carrier-reported payment information. Fields are nullable because availability depends on carrier reporting.
7 properties
ApplicantLanguage
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

healthsherpa-enrollments-api-openapi.yml Raw ↑

Other APIs HealthSherpa publishes across the network.

HealthSherpa Enrollment Sessions API
HealthSherpa Quotes API
HealthSherpa Reference API
HealthSherpa Utility API
Where this information came from

This is an independent, third-party profile of HealthSherpa Enrollments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.