Skip to main content

PHR & ABHA Address

Send OTP for ABHA Address Login

Send OTP to login via ABHA Address.

Mandatory

Certification cases VRFY_ABHA_102, VRFY_ABHA_202

POST/phr/web/login/abha/request/otp

| scope | loginHint | Method | |-------|-----------|--------| | ["abha-address-login","mobile-verify"] | abha-address | Mobile OTP | | ["abha-address-login","aadhaar-verify"] | abha-address | Aadhaar OTP | | ["abha-login","aadhaar-bio-verify"] | abha-address | Fingerprint | | ["abha-login","aadhaar-face-verify"] | abha-address | Face | | ["abha-login","aadhaar-iris-verify"] | abha-address | Iris |

Authorizations

Authorizationbearer tokenRequired

The accessToken from POST /api/hiecm/gateway/v3/sessions. Send it as Authorization: Bearer <ACCESS_TOKEN>.

Headers

REQUEST-IDstringRequired

Unique UUID v4 per request. Used for idempotency and distributed tracing. Generate a fresh UUID for every call.

TIMESTAMPstringRequired

ISO 8601 UTC timestamp of the request.

Body

scopestring[]Required
loginHintstringRequired

One of abha-address

loginIdstringRequired

RSA-encrypted ABHA Address

otpSystemstringRequired

Which identity system the loginId is encrypted for. Example values include abdm and aadhaar.

Responses

200

OTP sent

400

Bad Request, invalid scope, loginHint, or encrypted field

Error codes for this module

401

Unauthorized, missing, invalid, or expired Bearer token

Everything returns 401

403

Forbidden, the token is valid but not permitted for this operation

Error codes for this module

500

Server error, retry

Error codes for this module

Last updated on