Get your app connected in four steps
This onboarding flow is designed for public developers integrating with Healix APIs. Follow the process below to request credentials and begin testing.
Onboarding sequence
- Submit application onboarding request and required metadata.
- Receive sandbox client configuration and approved scopes.
- Implement Authorization Code + PKCE and call sandbox APIs.
- Complete validation checklist and move to production review.
Required onboarding details
- Application name, owner, and business use case.
- Redirect URIs by environment and client type.
- Requested scopes and rationale for each scope.
- Support and incident contact information.
Sandbox validation checklist
- Authorization redirect and code exchange succeed.
- Token includes approved scopes and expected audience.
- FHIR metadata and target resources return valid JSON.
- Error handling is implemented for auth and API failures.
Example token request context
scope=user_impersonation launch launch.patient patient.*.read
Exact endpoint hosts are provided in your onboarding package.