Skip to main content

ABHA address login via Mobile OTP - verify

Verifies the mobile OTP for ABHA-address login. Returns the linked ABHA address(es) in users and tokens.token.

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

Send that token as the X-token header to the ABHA-address profile, PHR card and QR code APIs.

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

Flow: ABHA Address Login - Mobile OTP - step 3 of 6

  • Previous: ABHA address login via Mobile OTP - send OTP
  • Next: Get ABHA-address profile

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", "mobile-verify"] yes Scope that selects this use case. Send exactly the values listed for this API.
authData object yes Authentication payload for this use case.
authData.authMethods ["OTP"] yes Authentication method used in this step.
authData.otp object yes OTP authentication block.
authData.otp.txnId string yes Transaction ID returned by the previous step of this flow.
authData.otp.otpValue string yes OTP received by the user, RSA-encrypted.

Responses

200

Success: OTP Verification -Success Mobile Otp; OTP Verification -OTP expired

messagestring
authResultstring
usersobject[]
users.abhaAddressstring
users.fullNamestring
users.profilePhotostring
users.abhaNumberstring
users.statusstring
users.kycStatusstring
tokensobject
tokens.tokenstring
tokens.expiresIninteger
tokens.refreshTokenstring
tokens.refreshExpiresIninteger
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