Forgot ABHA via Mobile - verify OTP

Verifies the mobile OTP. Returns the ABHA accounts linked to the mobile number, and a short-lived token.

POST/abha/api/v3/profile/login/verify

Endpoint: POST /abha/api/v3/profile/login/verify

Flow: Forgot ABHA - Mobile OTP - step 2 of 2

Previous: Forgot ABHA via Mobile - send OTP
Next: none (last call of this flow)

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", "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: Forgot ABHA via Mobile OTP- Positive Flow

authResultstring

messagestring

tokenstring

expiresIninteger

refreshTokenstring

refreshExpiresIninteger

accountsobject[]

accounts.ABHANumberstring

accounts.preferredAbhaAddressstring

accounts.namestring

accounts.statusstring

accounts.profilePhotostring

400

Bad Request (request validation failed): Forgot ABHA via Mobile OTP-Invalid OTP Value; Forgot ABHA via Mobile OTP-Invalid Transaction Id; Forgot ABHA via Mobile OTP-Invalid scope; Forgot ABHA via Mobile OTP-Invalid authMethod

Error codes for this module

401

Unauthorized (invalid / expired gateway token, X-token or benefit access): Invalid Credentials (generic)

Everything returns 401

codestring

descriptionstring

messagestring

404

Not Found: User Not Found; Resource Not Found

Error codes for this module

errorobject

error.codestring

error.messagestring

500

Internal Server Error.

Error codes for this module

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/verify \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: 18235d89-cb13-479d-ad71-7a57d5f669a8' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z' \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": [
    "abha-login",
    "mobile-verify"
  ],
  "authData": {
    "authMethods": [
      "otp"
    ],
    "otp": {
      "txnId": "{{txnId}}",
      "otpValue": "{{encrypted OTP}}"
    }
  }
}'

{
  "txnId": "c837a1bd-7694-4c06-a42c-7eb36e445d1d",
  "authResult": "success",
  "message": "OTP verified successfully",
  "token": "<TOKEN>",
  "expiresIn": 300,
  "accounts": [
    {
      "ABHANumber": "<ABHA_NUMBER>",
      "preferredAbhaAddress": "<ABHA_ADDRESS>",
      "name": "<NAME>",
      "gender": "M",
      "dob": "<DOB>",
      "verifiedStatus": "VERIFIED",
      "verificationType": "AADHAAR",
      "status": "ACTIVE",
      "profilePhoto": "<BASE64_PHOTO>"
    },
    {
      "ABHANumber": "<ABHA_NUMBER>",
      "preferredAbhaAddress": "<ABHA_ADDRESS>",
      "name": "<NAME>",
      "gender": "M",
      "dob": "<DOB>",
      "verifiedStatus": "VERIFIED",
      "verificationType": "AADHAAR",
      "status": "ACTIVE",
      "profilePhoto": "<BASE64_PHOTO>"
    },
    {
      "ABHANumber": "<ABHA_NUMBER>",
      "preferredAbhaAddress": "<ABHA_ADDRESS>",
      "name": "<NAME>",
      "gender": "M",
      "dob": "<DOB>",
      "verifiedStatus": "VERIFIED",
      "verificationType": "AADHAAR",
      "status": "ACTIVE",
      "profilePhoto": "<BASE64_PHOTO>"
    },
    {
      "ABHANumber": "<ABHA_NUMBER>",
      "preferredAbhaAddress": "<ABHA_ADDRESS>",
      "name": "<NAME>",
      "gender": "M",
      "dob": "<DOB>",
      "verifiedStatus": "VERIFIED",
      "verificationType": "AADHAAR",
      "status": "ACTIVE",
      "profilePhoto": "<BASE64_PHOTO>"
    }
  ]
}