OTP Request - AADHAR OTP

Starts a login by sending an OTP. loginHint names what the person is identifying with, and loginId is that value encrypted.

POST/login/phr/request/otp

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Body

scopestring[]Required

loginHintstringRequired

loginIdstringRequired

otpSystemstringRequired

Responses

200

Example values, scrubbed.

400

Example values, scrubbed.

Error codes for this module

401

Example values, scrubbed.

Everything returns 401

OTP Request - AADHAR OTP

curl --request POST \
  --url https://phrsbx.abdm.gov.in/login/phr/request/otp \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": [
    "<SCOPE>"
  ],
  "loginHint": "<LOGIN_HINT>",
  "loginId": "<LOGIN_ID>",
  "otpSystem": "<OTP_SYSTEM>"
}'

{
  "txnId": "<TXN_ID>",
  "message": "<MESSAGE>"
}

Generated from the schema. The values are placeholders, not a captured response.