Verify OTP ReKyc, update Mobile, CHILD ABHA KYC

Verify an OTP (One-Time Password) for various purposes such as ReKyc, Update Mobile,Update Email,Set Password etc.

POST/abha/api/v3/profile/account/verify

Example of OTP Request Example1: Verify Password: This scenario involves verifying an OTP sent to the user’s registered contact method to verify their password. Example2: Re-KYC: This scenario involves verifying an OTP sent to the user’s registered contact method to perform re-KYC (Know Your Customer) verification. Example3: Update Mobile-Verify OTP: This scenario involves verifying an OTP sent to the user’s new mobile number to update their mobile number in the ABHA profile. Example8: Update Email-Verify OTP: This scenario involves verifying an OTP sent to the user’s new email address to update their email address in the ABHA profile. Example9: Set Password: This scenario involves setting a new password for the user’s ABHA account. Example10: Update Old Password: This scenario involves updating the user’s password using their old password. Example11: CHILD ABHA KYC - Verify OTP: This action allows users to complete the KYC verification for a Child ABHA by verifying the OTP sent to the Aadhaar-linked mobile number of the child/guardian. Successful verification completes the Re-KYC process for the Child ABHA account. Note: 1. OTP will be valid for 10 minute only

Authorizations

Authorizationbearer tokenRequired

Headers

X-tokenstringRequired

REQUEST-IDstringRequired

TIMESTAMPstringRequired

Body

scopestring[]Required

authDataobjectRequired

authData.authMethodsstring[]Required

authData.otpobject

authData.otp.txnIdstringRequired

authData.otp.otpValuestringRequired

reasonsstring[]

Responses

200

The 200 response code indicates a successful request. In this context, it refers to the successful verification of an OTP (One-Time Password) for various services. Types of OTP Verifications: <ol> <li>PASSWORD_VERIFY_OTP- Positive Flow : The 200 response code indicates a successful request. In this context, it refers to the successful verification of the OTP (One-Time Password) for password verification purposes.</li> </ol> <ol start="2"> <li>Re-KYC- Positive Flow : The 200 response code indicates a successful request. In this context, it refers to the successful completion of the Re-KYC process.</li> </ol> <ol start ="3"> <li>Update Mobile- Positive Flow: The 200 OK response code indicates a successful request. In this context, it refers to the successful update of the mobile number.</li> </ol> <ol start ="4"> <li>Update Email- Positive Flow: The 200 OK response code indicates a successful request. In this context, it refers to the successful update of the email address.</li> </ol> <ol start="5"> <li>PASSWORD UPDATE-OLD PASSWORD- Positive Flow:The 200 OK response code indicates a successful request. In this context, it refers to the successful update of the password when the old password is verified.</li> </ol> <ol start="6"> <li>CHILD ABHA KYC - Verify OTP- Positive Flow:This action allows users to complete the KYC verification for a Child ABHA by verifying the OTP sent to the Aadhaar-linked mobile number of the child/guardian. Successful verification completes the Re-KYC process for the Child ABHA account.</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) generation or validation process. Types of OTP Response Errors: <ol> <li>Update Email - Invalid Scope: The scope of the OTP response is invalid.</li> </ol> <ol start="2"> <li>Update Email- Invalid Auth Methods: The authentication method provided is invalid.</li> </ol> <ol start="3"> <li>Update Email -Invalid X-token: The X-token provided is invalid or expired.</li> </ol> <ol start="4"> <li>Update Email -Invalid OTP Value: The OTP value provided is invalid.</li> </ol> <ol start="5"> <li>Update Mobile -Invalid Transaction Id: The transaction ID provided is invalid.</li> </ol> <ol start="6"> <li>Update Mobile - Invalid Scope: The scope of the OTP response is invalid.</li> </ol> <ol start="7"> <li>Update Mobile - Invalid Auth Methods:: The authentication method provided is invalid..</li> </ol> <ol start="8"> <li>Update Mobile - Invalid X-token:: The X-token provided is invalid or expired.</li> </ol> <ol start="9"> <li>Update Mobile-Invalid OTP Value: The OTP value provided is invalid.</li> </ol> <ol start="10"> <li>Re-KYC- Invalid Transaction Id: The transaction ID provided is invalid.</li> </ol> <ol start="11"> <li>Re-KYC - Invalid Transaction Id: The transaction ID provided is invalid.</li> </ol> <ol start="12"> <li>Re-KYC- Invalid Auth Method: The authentication method provided is invalid..</li> </ol> <ol start="13"> <li>Re-KYC - Invalid X-token: The X-token provided is invalid or expired.</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. Types of OTP Response Errors: <ol> <li>Update Email-X-token expired: The X-token provided for updating the email address has expired.</li> </ol> <ol start="2"> <li>Update Mobile-Invalid access token: The access token provided for updating the mobile number is invalid.</li> </ol> <ol start="3"> <li>Update Mobile-X-token expired: The X-token provided for updating the mobile number has expired.</li> </ol> <ol start="4"> <li>Re-KYC - Invalid access token:: The access token provided for Re-KYC is invalid.</li> </ol> <ol start="5"> <li>Re-KYC-X-token expired: The X-token provided for Re-KYC has expired..</li> </ol> <ol start="6"> <li>Password_Set-Invalid access token: The access token provided for setting the password is invalid.</li> </ol> <ol start="7"> <li>Password_Set-X-token expired: The ABHA number provided for ABHA OTP is invalid.</li> </ol> <ol start="8"> <li>PASSWORD_UPDATE-OLD PASSWORD-Invalid access token: The access token provided for updating the password using the old password is invalid.</li> </ol> <ol start="9"> <li>PASSWORD_UPDATE-OLD PASSWORD-X-token expired: The X-token provided for updating the password using the old password has expired.</li> </ol>

Everything returns 401

422

The 422 Unprocessable Entity response for this endpoint indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. Types of OTP Response Errors: <ol> <li>Re-KYC-Invalid OTP: The OTP provided for Re-KYC is invalid.</li> </ol> <ol start="2"> <li>PASSWORD VERIFY OTP-Invalid OTP-AADHAAR: The OTP provided for Aadhaar verification during password verification is invalid.</li> </ol>

Error codes for this module

500

Internal Server Error

Error codes for this module

Verify OTP ReKyc, update Mobile, CHILD ABHA KYC

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

{
  "txnId": "6e3c1761-8e4c-44a3-929e-32b2c16083d5",
  "authResult": "success",
  "message": "Password updated successfully",
  "accounts": [
    {
      "ABHANumber": "<ABHA_NUMBER>"
    }
  ]
}

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