Skip to main content

Verify OTP Aadhaar Number, mobile Number, verify via biometric

Verify a One-Time Password (OTP) for user authentication, enabling secure access to user profiles.

POST/abha/api/v3/phr/web/login/abha/verify

The OTP verification process ensures that only authorised users can log into their profiles, thereby enhancing security.

Authorizations

Authorizationbearer tokenRequired

Headers

REQUEST-IDstringRequired
TIMESTAMPstringRequired

Body

scopestring[]Required
authDataobjectRequired
authData.authMethodsstring[]

Responses

200

The 200 response code indicates a successful request. In this context, the entered OTP was verified, confirming the user’s identity and the account was accessed by verified user.<br><br> <li><strong>ABHA Address Verification via Mobile OTP:</strong> This action allows users to verify their ABHA address using an OTP sent to the mobile number registered with their Abha address. This ensures that the user’s ABHA address is securely verified.</li><br><li><strong>ABHA Address Verification via Aadhaar OTP:</strong> This action allows users to verify their ABHA address using an OTP sent to the mobile number registered with their Aadhaar. This ensures that the user’s ABHA address is securely verified.</li><br><li><strong>ABHA Address Verification via Biometric :</strong> This action allows users to verify their ABHA address using Biometric Authentication modes(Fingerprint, Face, Iris) . This ensures that the user’s ABHA address is securely verified.</li>

400

The 400 response code indicates a client error. In this context.<br><br> <strong>Types of OTP Responses:</strong> <ol> <li><strong>Invalid Scope::</strong>The scope of the OTP response is invalid .</li> </ol> <ol start ="2"> <li><strong>Invalid Auth Methods:</strong> The authentication methods used for OTP verification are invalid.</li> </ol> <ol start ="3"> <li><strong>Invalid Transaction Id:</strong> The transaction ID provided for OTP verification is invalid.</li> </ol><ol start ="4"> <li><strong>Biometric Data did not match:</strong> The Biometric data entered in the form of pid did not match with your profile.</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