Getting Started
Onboarding
Quoting APIs are available after signup and API key activation. Enrollment workflows are optional and require a linked HealthSherpa account plus portal approval. Manage your key and access requests from the API Access page.
Account setup
-
Sign up for a developer account.
Sign up
- Submit your email, company, contact name, and intended use case.
- Confirm your email using the verification link sent by HealthSherpa.
-
Log in to your developer account.
Log in
- Request a one-time login link with the email you registered.
- Open the link from your inbox to sign in.
- Generate and securely store your API key on the API Access page.
- Reveal the key once, confirm you have stored it securely, and activate it. Until activation completes, quoting and other API calls will fail.
Integrate with quoting API
-
Integrate with the quoting APIs.
See the
quoting API,
starting with
GET /v1/pingto confirm your key, then reference endpoints andPOST /v1/quotes.If you are building with an AI app builder or without a traditional engineering team, see Vibe coding for copy-paste prompts and integration patterns aimed at non-technical developers.
Integrate with enrollment APIs
Follow these steps only if you need enrollment beyond quoting.
- Open the API Access page. API Access page
-
Link your HealthSherpa account.
Connect your developer account to your HealthSherpa agent account.
-
If you linked before policy status was enabled and need policy status readback, use
Re-link account on the API Access page to grant the
policy_status_apiscope. Token refresh does not add new scopes to an existing link.
-
If you linked before policy status was enabled and need policy status readback, use
Re-link account on the API Access page to grant the
-
Request enrollment API access.
Submit a review request for the workflows you need:
- On-exchange enrollment and policy status (no separate policy status request in the portal): request on-exchange access
- Off-exchange enrollment: request off-exchange access
- Integrate with the enrollment APIs. After approval, use on-exchange enrollment and off-exchange enrollment.