ABHA Profile

Send Email Verification Link

Send a one-click email verification link. The user clicks it to verify their email, no OTP required.

POST/profile/account/request/emailVerificationLink

Authorizations

Authorizationbearer tokenRequired

JWT Bearer token from POST /api/hiecm/gateway/v3/sessions. Header: Authorization: Bearer {accessToken}

X-TokenapiKeyRequired

Short-lived session token returned in login/verify responses. Required for all /profile/account/* operations. Header: X-Token: {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.

Body

scopestring[]Required

loginHintstringRequired

One of email

loginIdstringRequired

RSA-encrypted email address

otpSystemstringRequired

Which identity system the loginId is encrypted for. Example values include abdm and aadhaar.

Responses

200

Verification link sent to email

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 Email Verification Link

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/profile/account/request/emailVerificationLink \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'X-Token: <X_TOKEN>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>' \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": [
    "abha-profile",
    "email-link-verify"
  ],
  "loginHint": "email",
  "loginId": "{{RSA_encrypted_email}}",
  "otpSystem": "abdm, aadhaar"
}'

{
  "message": "<MESSAGE>"
}

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