Skip to main content

Login via Aadhaar number - send Aadhaar OTP

Starts login with an Aadhaar number. UIDAI sends an OTP to the Aadhaar-linked mobile.

POST/abha/api/v3/profile/login/request/otp

Endpoint: POST /abha/api/v3/profile/login/request/otp

Flow: Login - Aadhaar Number - step 1 of 2

  • Previous: none (first call of this flow)
  • Next: Login via Aadhaar number - verify Aadhaar OTP

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-verify"] yes Scope that selects this use case. Send exactly the values listed for this API.
loginHint "Aadhaar" 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: Login Via Aadhaar Number - Using Aadhaar OTP - Send OTP

txnIdstring
messagestring
400

Bad Request (request validation failed): Login via Aadhaar - Invalid Login Hint; Login via Aadhaar OTP - Invalid Scope; Login via Aadhaar OTP - Invalid LoginId

Error codes for this module

txnIdstring
timestampstring
401

Unauthorized (invalid / expired gateway token, X-token or benefit access): Login via Aadhaar - Invalid access token

Everything returns 401

codestring
messagestring
descriptionstring
404

Not Found: Resource not found

Error codes for this module

timestampstring
pathstring
descriptionstring
errorstring
requestIdstring
500

Internal Server Error.

Error codes for this module