Update phone — step 1: send OTP to the new number

POST

/api/DigitalIdentity/UpdatePhone/SendPhoneOtp

Starts a phone-number change for the authenticated user by sending an OTP to the new number. Returns data.phoneNumberOtpRequestId. If the response indicates liveness re-validation is required, call POST /api/DigitalIdentity/UpdatePhone/ReValidateLiveness before validating the OTP. Step 1 of the update-phone-number flow. Not to be confused with the identically-named forgot-password endpoints.

Starts a phone-number change for the authenticated user by sending an OTP to the new number. Returns `data.phoneNumberOtpRequestId`. If the response indicates liveness re-validation is required, call `POST /api/DigitalIdentity/UpdatePhone/ReValidateLiveness` before validating the OTP. Step 1 of the update-phone-number flow. Not to be confused with the identically-named forgot-password endpoints.

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.

phoneNumberstringRequired

The new phone number to move the account to.

passwordstringRequired

The user's current password.

smsProvidersintegerRequired

SMS provider to send through. 0 uses the tenant default.

Response

dataobject

error_codeinteger or null

error_messagestring or null

error_descriptionsstring or null