1. Development Integration
  2. /
  3. SDK
  4. /
  5. Java
  6. /

  7. User authentication module

  8. /

  9. User information

  10. /
  11. Change mobile phone number

Modify mobile phone number

Update time: 2025-07-23 07:34:21
Edit

This document is automatically generated based on https://github.com/authing/authing-docs-factory and https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the document description is incorrect, please refer to V3 API.

The end user needs to provide the corresponding verification method to modify the mobile phone number on his own, see [Initiate verification request to modify mobile phone number](#tag/User information/API%20List/operation/ProfileV3Controller_updatePhoneVerification). This parameter requires a one-time temporary credential updatePhoneToken, which needs to be obtained from the Initiate verification request to modify mobile phone number interface.

Method Name

AuthenticationClient.updatePhone

Request Parameters

NameType
Is it required
Default Value
Description
Example Value
updatePhoneTokenstringYes-The token used to temporarily modify the mobile phone number can be obtained from the Initiate verification request to modify the mobile phone number interface.xxxx

Sample Code

package test.authentication;

import cn.authing.sdk.java.client.AuthenticationClient;
import cn.authing.sdk.java.dto.CommonResponseDto;
import cn.authing.sdk.java.dto.UpdatePhoneDto;
import cn.authing.sdk.java.model.AuthenticationClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

public class UpdatePhoneTest {
    // Need to be replaced with your GenAuth App ID
    private static final String APP_ID = "AUTHING_APP_ID";
    // Need to be replaced with your GenAuth App Secret
    private static final String APP_SECRET = "AUTHING_APP_SECRET";
    // Need to be replaced with your GenAuth App Host
    private static final String APP_HOST = "AUTHING_APP_HOST";
    // Need to be replaced with your GenAuth Access Token
    private static final String ACCESS_TOKEN = "AUTHING_ACCESS_TOKEN";

    public static void main(String[] args) throws Throwable {
        AuthenticationClientOptions clientOptions = new AuthenticationClientOptions();
        clientOptions.setAppId(APP_ID);
        clientOptions.setAppSecret(APP_SECRET);
        clientOptions.setAppHost(APP_HOST);
        clientOptions.setAccessToken(ACCESS_TOKEN);

        AuthenticationClient client = new AuthenticationClient(clientOptions);

        UpdatePhoneDto reqDto = new UpdatePhoneDto();
        // The token used to temporarily change the mobile phone number can be obtained from the verification request interface for initiating the change of the mobile phone number.
        reqDto.setUpdatePhoneToken("xxx");
        CommonResponseDto response = client.updatePhone(reqDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

Request Response

Type: CommonResponseDto

NameTypeDescription
statusCodenumberBusiness status code. You can use this status code to determine whether the operation is successful. 200 means success.
messagestringDescription
apiCodenumberSegmented error code, through which the specific error type can be obtained (not returned for successful requests). For a detailed list of error codes, see: API Code List (opens new window)
requestIdstringRequest ID. Returned when the request fails.

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c"
}

Data Structure