Skip to main content

Login request OTP

Facilitate secure user authentication by sending a One-Time Password (OTP) to the user’s mobile number. This ensures that only authorised users can access their accounts

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

<br><br> ABHA ADDRESS Verification via Mobile OTP: Sends an OTP to the mobile number used for ABHA enrolment.<br><br> ABHA ADDRESS Verification via Aadhaar OTP: Sends an OTP to the mobile number linked to the user’s Aadhaar number.<br><br> ABHA ADDRESS Verification via Biometric (Fingerprint Authentication): Sends Fingerprint Authentication request.<br><br> ABHA ADDRESS Verification via Biometric (Face Authentication): Sends Face Authentication request.<br><br> ABHA ADDRESS Verification via Biometric (Iris Authentication): Sends an Iris Authentication request.<br>

Authorizations

Authorizationbearer tokenRequired

Headers

REQUEST-IDstringRequired
TIMESTAMPstringRequired

Body

scopestring[]Required
loginHintstringRequired
loginIdstringRequired
otpSystemstringRequired

Responses

200

The 200 response code indicates that the OTP has been successfully sent to the mobile number. This response confirms that the authentication process has been initiated, ensuring that only authorized users can access their accounts. The OTP must be entered correctly to proceed with the authentication.

400

The 400 response code indicates a client error. In this context.<br><br> <strong>Types of OTP Responses:</strong> <ol> <li><strong>User not found:</strong>failure to find user .</li> </ol> <ol start ="2"> <li><strong>Invalid abha number:</strong> The provided abha address is Invalid.</li> </ol>

Error codes for this module

401

The 401 response code indicates a access denial.

Everything returns 401

500

<b>Internal Server Error</b><br><br> An Internal Server Error (500) indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

Error codes for this module