Session and tokens

Log the person out and invalidate their user token

Invalidates the X-token. Call it when the person signs out, and when your session ends, so a token cannot outlive the session that produced it.

GET/v3/profile/account/request/logout

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.

Responses

200

Confirmation that the session ended.

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

Log the person out and invalidate their user token

curl --request GET \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/request/logout \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>' \
  --header 'X-token: <X_TOKEN_FROM_LOGIN_VERIFY>'

{
  "message": "You have been logged out",
  "timestamp": "2025-01-31 20:03:49"
}

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