Skip to navigation
Vlens APIChange Phone Number SessionStart the change

Send a change-phone-number invitation

View as Markdown

Emails the user an invitation link to change their registered phone number. The user’s email must be confirmed. Requires ApiKey, an admin bearer token and the Change Phone Number Invitation permission.

Authentication

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

Admin JWT from /api/credentials/Login. Required for admin operations.

Request

This endpoint expects an object.
userPublicKeystringOptional

RSA public key generated on the device. See Iframe Integration.

userIdlongOptional
The user whose phone number is being changed.
userEmailstring or nullOptional
oldPhoneNumberstring or nullOptional
The user's current phone number.
newPhoneNumberstring or nullOptional
The new phone number. Must differ from the current one.
redirectUrlstring or nullOptional
Where to send the user when the session completes.
languagestring or nullOptional

UI language — AR or EN.

smsProviderintegerOptional

SMS provider for the OTP: 1 Infobip, 2 Vodafone, 3 Cequens, 4 Victory Link, 5 BroadNet, 6 Ezagel, 7 Orange.

Response

Invitation sent.
dataobjectOptional
error_codeinteger or nullOptional
error_messagestring or nullOptional
error_descriptionslist of objects or nullOptional