Profile update

Send an OTP to change something on the profile

Raise this before updating a mobile number, an email address or a password. scope names both the area and the action, for example ["abha-profile", "mobile-verify"].

Optional

Certification cases PROF_ABHA_601, PROF_ABHA_603, PROF_ABHA_604, PROF_ABHA_605

POST/v3/profile/account/request/otp

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

loginHintstringRequired

loginIdstringRequired

otpSystemstringRequired

Responses

200

The transaction id to carry into the next step, with a message.

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

500

Server error, retry

Error codes for this module

Send an OTP to change something on the profile

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/request/otp \
  --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"
  ],
  "loginHint": "mobile",
  "loginId": "<MOBILE_ENCRYPTION>",
  "otpSystem": "abdm"
}'

{
  "txnId": "<TXN_ID>",
  "message": "<MESSAGE>"
}

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