PhoneChangeConfirm

[POST] .../v1/user/phonechangeconfirm

Confirms a user phone number change Use this identity workflow after User/PhoneChange to confirm the phone number change with the code sent to the user. The method validates id, phone and confirm_code, checks the current request user's user edit permission, confirms the pending phone-change request through the persistent layer, fires user-edited side effects on success and returns ok=true. The request body is required, id must be non-zero, phone and confirm_code must be provided and the endpoint immediately returns the configured disabled ErrorResult when identity endpoint setting is turned off. Missing fields, denied permission, disabled identity endpoints, invalid or expired confirmation code and persistent failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
confirm_code String Required Confirmation code.
id Int64 Required User ID.
phone String Required New user phone number.

Request Example

{
  "id": 17,
  "phone": "\u002B998901112233",
  "confirm_code": "123456"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Object Request result.

Response Example

{
  "ok": true
}