Skip to main content

​
When to use this

A healthcare professional who has registered before signs in to your HMS with their mobile rather than Aadhaar. You send an OTP to their mobile, verify it, and check the HPR ID. This is the alternative entry for returning professionals. For a first-time registration, use Create an HPR ID with Aadhaar OTP.

​
Before you start

  • A bearer token for the Eka API. See Authorization.
  • The headers your integration sends on ABDM Connect calls. Each operation accepts X-Pt-Id, X-Partner-Pt-Id and X-Hip-Id.
  • The professional’s mobile number.
  • The professional’s HPR ID, which Check If HPR is Available takes as hprId.

​
Sequence

​
Steps

1

Send the mobile OTP

Send mobile_num to Get Mobile OTP. The body also accepts txn_id. The response carries txn_id, mobile_num and hint. Unlike the other NHPR calls, the spec does not wrap this response in data. Keep txn_id. The professional receives an OTP.
2

Verify the mobile OTP

Send txnId (the txn_id from step 1, in camel case) and the otp the professional reads out to Verify Mobile OTP. The response data carries txn_id, mobile_num and hint.
3

Check the HPR ID

Send hprId to Check If HPR is Available. Read available in the response data.

​
State you must persist

​
When it fails

Which of these codes each call returns is not yet confirmed. The codes come from the errors page, matched by meaning. Log the code you actually receive.
Errors come back as 4XX or 5XX with a body carrying code, error and source_error (code, message). Read source_error.code and look it up on the errors page.

​
Test it

The testing page has the sandbox base URL, credentials and the happy path for every journey. Run against the sandbox base URL https://api.dev.eka.care.
  • Happy path: Get Mobile OTP, Verify Mobile OTP, Check If HPR is Available returns available for the professional’s hprId
  • Wrong OTP once, then the correct OTP
  • A mobile with no HPR account