Skip to navigation
Vlens APIDigital Identity - Account ManagementUpdate phone number

Update phone — step 3: validate OTP and apply the change

View as Markdown

Confirms the OTP sent to the new number and commits the phone-number change. Use the most recent phoneNumberOtpRequestId — the one from step 2 if liveness was re-validated, otherwise the one from step 1. Step 3 of the update-phone-number flow. Not to be confused with the identically-named forgot-password endpoints. Pass deferCommit: true to defer the actual change to an authorized admin — see Update phone number for the full deferred-commit flow.

Authentication

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

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

Request

This endpoint expects an object.
phoneNumberOtpRequestIdstringRequired
The most recent OTP request ID from step 1 or step 2.
phoneNumberOtpstringRequired
The OTP sent to the new phone number.
deferCommitbooleanOptional

If true, the phone number is not updated immediately. Instead the response returns data.isCommitPending: true, and an authorized admin must call POST /api/DigitalIdentity/UpdatePhone/CommitPhoneChange with the same phoneNumberOtpRequestId to apply the change. Omit or set false to keep the immediate-commit behavior (the phone number is updated as soon as the OTP is validated).

Response

Phone number updated.
dataobject
error_codeinteger or null
error_messagestring or null
error_descriptionsstring or null