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.1.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.
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
POST
/v1/enrollments
Create a direct enrollment application
POST
/v1/enrollments/{enrollment_id}/submissions
Submit a direct enrollment application
POST
/v1/enrollments/{enrollment_id}/cancellations
Cancel a direct enrollment application
POST
/v1/enrollments/{enrollment_id}/terminations
Terminate an active policy
GET
/v1/enrollments/{enrollment_id}/payment_redirect
Get payment redirect data
POST
/v1/enrollments/{enrollment_id}/supporting_documentation
Upload supporting documentation
GET
/v1/enrollments/{enrollment_id}
Fetch a direct enrollment application
PUT
/v1/enrollments/{enrollment_id}
Update a direct enrollment application
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.
Signatures
object
7 properties
EnrollmentResponse
Successful direct enrollment application response. Successful responses can contain errors[] as submission-readiness data; error responses are documented separ…
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
Applicants
object
2 properties
1 required
PaymentInstructions
object
Carrier-specific payment guidance.
4 properties
ApplicantBase
object
37 properties
Guardian
object
Required for primary applicants under 18.
12 properties
Analytics
object
Optional tracking and attribution parameters.
5 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…
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
SpecialEnrollmentPeriod
object
2 properties
SubmitResponse
object
Response returned when an application submission is accepted. The object is additive and may include carrier-specific fields.
7 properties
PaymentRedirectResponse
object
4 properties
4 required
Attestations
object
12 properties
NextAction
object
State-aware action entry returned on successful enrollment application responses.
4 properties
3 required
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
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
ApplicantLanguage
string
Employer
object
5 properties
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
CommunicationPreferences
object
9 properties
Dependent
PolicyPaymentStatus
object
Carrier-reported payment information. Fields are nullable because availability depends on carrier reporting.
7 properties
MailingAddress
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
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
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
EnrollmentActionContext
object
2 properties
2 required
AlternateAddress
object
Address for a dependent living at a different address than the primary applicant.
7 properties
Translator
object
Translator assisting the applicant. Required by some carriers when the applicant requires language assistance.
4 properties
SimpleAddress
object
5 properties
PrimaryApplicant
ApplicationListResponse
object
Paginated list of direct enrollment applications.
2 properties
2 required
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
ApplicationResponse
object
23 properties
EnrollmentActionContextRequest
object
Routing context for direct enrollment action endpoints.
1 property
1 required
StatusChangeResponse
object
Response returned for an accepted application cancellation or termination status change.
4 properties
3 required
Address
object
6 properties
4 required
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
ApplicationEvent
object
12 properties
2 required
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
SupportingDocumentationResponse
object
5 properties
ExistingCoverage
object
9 properties
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
ApplicationListPagination
object
Pagination metadata for application list responses.
3 properties
3 required
PolicyDetail
object
9 properties
ApplicationListItem
object
Summary application row returned by GET /v1/enrollments.
9 properties
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
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HealthSherpa 4
Other APIs HealthSherpa publishes across the network.
HealthSherpa Enrollment Sessions API
HealthSherpa Quotes API
HealthSherpa Reference API
HealthSherpa Utility API
#Enrollments