Skip to content
SupportDashboard

Verify phone number change

POST
/user/phone-number/change/verify

Complete a previously-requested phone number change by submitting the OTP that was sent via SMS. On success the staged phone number becomes the user’s verified phone number. Requires elevated permissions.

New phone number and OTP code to confirm the change

object
newPhoneNumber
required

The phone number that was previously requested via /user/phone-number/change

string
Example
+123456789
otp
required

One-time password received via SMS at the new phone number

string
Example
123456

Phone number change verified successfully

string
Allowed values: OK

An error occurred while processing the request

Standardized error response

object
status
required

HTTP status error code

integer
Example
400
message
required

Human-friendly error message

string
Example
Invalid email format
error
required

Error code identifying the specific application error

string
Allowed values: default-role-must-be-in-allowed-roles disabled-endpoint disabled-user user-already-exists email-already-verified forbidden-anonymous internal-server-error invalid-email-password invalid-request locale-not-allowed password-too-short password-in-hibp-database redirectTo-not-allowed role-not-allowed signup-disabled unverified-user user-not-anonymous invalid-pat invalid-refresh-token invalid-ticket disabled-mfa-totp no-totp-secret invalid-totp mfa-type-not-found totp-already-active invalid-state oauth-token-echange-failed oauth-profile-fetch-failed oauth-provider-error invalid-otp otp-too-many-attempts cannot-send-sms provider-account-already-linked