Profile update

Verify the OTP for a profile change

Completes the change the OTP was raised for. Send the same scope you used when requesting it, along with the txnId and the encrypted OTP.

Optional

Certification cases PROF_ABHA_601, PROF_ABHA_603, PROF_ABHA_604, PROF_ABHA_605

POST/v3/profile/account/verify

Authorizations

Authorizationbearer tokenRequired

The accessToken from POST /api/hiecm/gateway/v3/sessions. Send it as Authorization: Bearer <ACCESS_TOKEN>.

Headers

REQUEST-IDstringRequired

Unique UUID v4 per request. Used for idempotency and distributed tracing. Generate a fresh UUID for every call.

TIMESTAMPstringRequired

ISO 8601 UTC timestamp of the request.

X-tokenstringRequired

The user scoped token returned when a person logs in or verifies an OTP. Required on this operation. See the shared XToken parameter, and note that this header takes the bare token with no prefix.

Body

scopestring[]Required

authDataobjectRequired

authData.authMethodsstring[]Required

authData.otpobject

authData.otp.txnIdstringRequired

authData.otp.otpValuestringRequired

authData.passwordobject

authData.password.newPasswordstringRequired

authData.password.oldPasswordstringRequired

reasonsstring[]

Responses

200

Whether the OTP verified, the transaction id, and the ABHA accounts the person may pick from.

400

Bad Request, invalid scope, loginHint, or encrypted field

Error codes for this module

401

Unauthorized, missing, invalid, or expired Bearer token

Everything returns 401

403

Forbidden, the token is valid but not permitted for this operation

Error codes for this module

422

Unprocessable, the request parsed but failed validation

Error codes for this module

500

Server error, retry

Error codes for this module

Verify the OTP for a profile change

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/verify \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>' \
  --header 'X-token: <X_TOKEN_FROM_LOGIN_VERIFY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": [
    "abha-profile",
    "mobile-verify"
  ],
  "authData": {
    "authMethods": [
      "otp"
    ],
    "otp": {
      "txnId": "<TXN_ID>",
      "otpValue": "<OTPVALUE>"
    }
  }
}'

{
  "txnId": "<TXN_ID>",
  "authResult": "<AUTH_RESULT>",
  "message": "<MESSAGE>",
  "accounts": [
    "<ACCOUNTS>"
  ]
}

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