Skip to main content

ABHA address login via IRIS - send authentication request

Starts IRIS login with an ABHA address. loginId is the RSA-encrypted ABHA address. Use the returned txnId in *ABHA address login via IRIS - verify*.

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

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

Flow: ABHA Address Login - IRIS - step 1 of 5

  • Previous: none (first call of this flow)
  • Next: ABHA address login via IRIS - 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-login", "Aadhaar-iris-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).

Note: Biometric ABHA-address login uses scope ABHA-login, not ABHA-address-login (the same in Swagger and Postman).

Responses

200

Success: Send Authentication Request via Biometric (IRIS Authentication)

txnIdstring
messagestring
400

Bad Request (request validation failed).

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