Onboarding
How to onboard an EUA or an HSPA onto the UHI network — sandbox steps, production go-live, and prerequisites.
This page describes the common onboarding path for the UHI network. Each service page adds its own service-specific notes.
Eligibility
UHI onboarding is open to End User Applications (EUAs) and Health Service Provider Applications (HSPAs). Examples of eligible applications:
- Digital health startups and consumer health app companies
- Health-tech platforms with doctor discovery and appointment management
- Enterprise platforms that integrate digital health services
- Government health portals
M2 is a hard prerequisite
Your application must complete Milestone 2 (M2) of the ABDM HIECM compliance framework. The NHA does not onboard applications without M2 onto any UHI service.
Sandbox onboarding
Fill the onboarding form
Complete the UHI onboarding form. Give your application details, your integration role (EUA or HSPA), your sandbox callback URL (HTTPS), and your public key.
Generate your key pair
Clone the NHA header generator utility. Run Generator.java with Option 1 to create an Ed25519 key pair. Submit only the public key to the NHA.
Get sandbox access
The NHA sends the sandbox credentials by email. Review the API documentation, the Gateway Swagger, and the Postman collection. Set up your sandbox environment.
Build and test the integration
Implement the full flow for your target service. Run all the test cases for your role. All test case categories must pass before sign-off.
Production go-live
Get the NHA sign-off
Record a demo video and send it to the NHA. The NHA reviews the test case results and the demo. The NHA gives the sign-off in writing.
Deploy to production
The NHA promotes your integration to the production UHI network. Update your consumer_id, consumer_uri, provider_id, and provider_uri to the production values. Real transactions are then enabled.
Technical prerequisites
For an EUA
- An ABDM-compliant application with at least M2 of HIECM complete
- A public HTTPS callback URL (
consumer_uri) for asynchronous responses - Request signatures with Ed25519 and BLAKE-512 (see Network and protocol)
- Support for the asynchronous pattern — do not block on a synchronous reply
- The UHI Postman collection for sandbox tests (available from the NHA on request)
For an HSPA
- An ABDM-compliant platform with at least M2 of HIECM complete
- Public HTTPS endpoints for the calls of your target service
- Request signatures and signature checks on inbound calls
- A service catalog with correct and current data
Resources
The NHA GitHub utility for the Ed25519 key pair and the request headers.
The full Gateway API specification for the sandbox.
The machine-readable Gateway specification.
The official NHA onboarding resource page.
Sources
- UHI Physical Consultation v2.0 — Onboarding Document (June 2026)
- UHI PM-JAY HEM Onboarding v1.4