Update email — step 1: send OTP to the new address

POST

/api/DigitalIdentity/UpdateEmailRequest

POST

/api/DigitalIdentity/UpdateEmailRequest

curl -X POST https://api.vlenseg.com/api/DigitalIdentity/UpdateEmailRequest \
     -H "ApiKey: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "email": "p.a.youssef@gmail.com"
}'

200Digital Identity - Account Management_postDigitalIdentityUpdateEmailRequest_example

{
  "data": {
    "hasPendingRequest": false,
    "isEmailConfirmationRequired": false,
    "isEmailConfirmed": true,
    "isPhoneNumberConfirmationRequired": false,
    "isPhoneNumberConfirmed": true,
    "phoneNumberOtp": "<string>",
    "phoneNumberOtpRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isDigitalIdentityVerified": true,
    "accessToken": "<string>",
    "encryptedAccessToken": "<string>",
    "expireInSeconds": 3600,
    "userName": "<string>",
    "userFullName": "<string>",
    "user": {
      "name": "<string>",
      "surname": "<string>",
      "fullName": "<string>",
      "userName": "<string>",
      "emailAddress": "<string>",
      "phoneNumber": "<string>",
      "idNumber": "<string>"
    }
  },
  "error_code": null,
  "error_message": null
}

Starts an email change for the authenticated user by sending an OTP to the new address. Returns data.emailOtpRequestId.

Authentication

ApiKeystring

Static API key issued to your tenant. Required on every request.

AuthorizationBearer

End-user JWT from registration or login. Required for verification, signing, and user-scoped operations.

Request

This endpoint expects an object.

emailstringRequired

Response

dataobject

error_codeinteger or null

error_messagestring or null