In short
- Run the happy path of every journey you support against sandbox before you go live.
- Sandbox is
https://api.dev.eka.care; production ishttps://api.eka.care. - Log in with your API client to get an access token, and refresh it on a
401. - Share a webhook endpoint that sandbox can reach with Eka before you start.
- Each item links the workflow’s own Test it checklist.
Sandbox
The base URLs are the spec’s
Stage/Sandbox and Production servers.
Sandbox credentials
- Create an Eka account and a workspace. See Setting up your Eka account.
- In the Eka Developer Console, open Manage API Credentials and create an API client. Copy the
client_idandclient_secret. The secret is shown once. - Log in with Client login to get an access token and a refresh token.
- When a call returns
401, the access token has expired. Get a new one with Refresh token.
Test data
Happy paths
Register a walk-in patient and link the visit
Journey- Log in to an existing ABHA, for a patient who has one
- Create an ABHA with Aadhaar OTP, for a patient who has none
- Link a care context as a HIP
- Optional: Create an ABHA address with mobile OTP
- Optional: Create an ABHA with face authentication
- Optional: Receive a scanned profile as a HIP
- If you keep the clinical data yourself: Serve records on a fetch request
Let a patient claim their old records
Journey- Answer discovery and link old records
- If you keep the clinical data yourself: Serve records on a fetch request
Fetch a patient’s records with consent
JourneyGather every health record in a PHR app
Journey- Create an ABHA with Aadhaar OTP or Log in to an existing ABHA
- Hold the ABHA Gateway session
- Manage the ABHA profile and KYC
- Discover and link records from a facility
- List a patient’s linked records
- Approve, deny or revoke a consent in a PHR app
- Set up the patient’s health locker
- Share a profile at a facility counter
Onboard a facility and its professionals to ABDM
Journey- Create an HPR ID with Aadhaar OTP
- Register and onboard a facility
- Optional: Log in to HPR with a mobile OTP
Book an in-person doctor visit over UHI
Journey- Log in to an existing ABHA
- Book a physical consultation over UHI
- Optional: Search blood banks over UHI
Pay an open bill by scanning the counter QR
JourneyBefore go-live
- Every webhook your workflows consume arrives, its signature verifies, and your endpoint replies
200within 5 seconds. - Your error handling matches Error codes, including the By symptom section.

