Verify- mobile OTP

Verify via Mobile OTP. After verifying OTP successfully mobile will be mobile number will be updated for further communication for perticular ABHA number.

POST/abha/api/v3/enrollment/auth/byAbdm

Example of OTP Request Mobile Update - Verify OTP: When the user wants to verify the Mobile Number for communication purpose. Note: 1.OTP will be valid for 10 minute only

Authorizations

Authorizationbearer tokenRequired

Headers

REQUEST-IDstringRequired

TIMESTAMPstringRequired

Body

scopestring[]Required

authDataobjectRequired

authData.authMethodsstring[]Required

authData.otpobjectRequired

authData.otp.txnIdstringRequired

authData.otp.otpValuestringRequired

Responses

200

The 200 response code indicates a successful request. In this context, it refers to the successful generation and delivery of an OTP (One-Time Password) for various services. Types of OTP Responses: <ol> <li> Mobile Update-Verify OTP-Positive flow: Indicates a successful request. The response includes a message indicating that the OTP has been verified successfully.</li> </ol> <ol start ="2"> <li>Mobile Update-Verify OTP-OTP Expired: This error occurs when the OTP provided for verification has expired. The OTP must be used within the valid time frame to ensure secure authentication.</li> </ol>

400

The 400 response code indicates a bad request. In this context, it refers to various errors encountered during the OTP (One-Time Password) verification process. <ol> <li> Invalid OTP Value: This error occurs when the OTP value provided for verification is invalid. The OTP must be correctly formatted and match the one sent to the user’s registered mobile number </li> </ol> <ol start="2"> <li> Invalid Transaction Id: This error occurs when the transaction ID provided in the request is invalid. The transaction ID is essential for tracking the OTP request and ensuring that the correct OTP is verified. </li> </ol> <ol start="3"> <li> Invalid Scope: This error occurs when the scope provided in the OTP verification request for mobile update is invalid. The scope specifies the purpose of the OTP verification, such as abha-enrol, mobile-verify, etc. </li> </ol> <ol start="4"> <li> Invalid AuthMethod - : This error occurs when the authentication method provided in the OTP verification request for mobile update is invalid. The authMethods field must contain valid authentication methods such as otp. </li> </ol>

Error codes for this module

401

The 401 response code indicates an unauthorized request. In this context, it refers to the lack of proper authentication during the operation of the Invalid Credentials

Everything returns 401

500

The 500 response code indicates an Internal Server Error

Error codes for this module

Verify- mobile OTP

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/auth/byAbdm \
  --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-enrol",
    "mobile-verify"
  ],
  "authData": {
    "authMethods": [
      "otp"
    ],
    "otp": {
      "txnId": "{{txnId}}",
      "otpValue": "{{encrypted otp}}"
    }
  }
}'

{
  "txnId": "23acf181-339d-4771-b532-5c5df4a28d19",
  "authResult": "success",
  "message": "Mobile number is now successfully linked to your Account",
  "accounts": [
    {
      "ABHANumber": "<ABHA_NUMBER>"
    }
  ]
}

Generated from the schema. The values are placeholders, not a captured response.