Skip to main content

ABHA address login via Aadhaar OTP - send OTP

Starts login with an ABHA address. UIDAI sends an OTP to the Aadhaar-linked mobile. loginId is the RSA-encrypted ABHA address.

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

Use Search ABHA address (auth methods) first to check that Aadhaar_OTP is allowed.

Endpoint: POST /abha/api/v3/phr/web/login/abha/request/otp

Flow: ABHA Address Login - Aadhaar OTP - step 2 of 6

  • Previous: Search ABHA address (auth methods)
  • Next: ABHA address login via Aadhaar OTP - verify

Headers (plus Authorization: Bearer <gateway token>):

Header Required Description
REQUEST-ID yes Unique UUID for every request.
TIMESTAMP yes Current UTC timestamp in ISO-8601 format.

Request body for this use case:

Field Value / Type Required Description
scope ["ABHA-address-login", "Aadhaar-verify"] yes Scope that selects this use case. Send exactly the values listed for this API.
loginHint "ABHA-address" yes Type of identifier sent in loginId.
loginId string yes Identifier value, RSA-encrypted with the ABHA public certificate.
otpSystem "Aadhaar" yes System that generates and delivers the OTP (Aadhaar = UIDAI, ABDM = ABDM).

Responses

200

Success: OTP send-Success - Aadhaar

txnIdstring
messagestring
400

Bad Request (request validation failed): ABHA Address Verification via Aadhaar OTP-User Not found; ABHA Address Verification via Aadhaar OTP-Invaild abha address; ABHA Address Verification via Aadhaar OTP-Invaild Otp System

Error codes for this module

401

Unauthorized (invalid / expired gateway token, X-token or benefit access): Missing Credentials (generic)

Everything returns 401

codestring
messagestring
descriptionstring
500

Internal Server Error.

Error codes for this module