¶ Initiate a request to cancel an account

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

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

When a user wants to cancel an account, he needs to provide the corresponding credentials. Currently, three verification methods are supported: Use email verification code, Use mobile verification code, and Use password.

¶ Method Name

AuthenticationClient.verifyDeleteAccountRequest

¶ Request Parameters

Name	Type	Is it required	Default Value	Description	Example Value
verifyMethod	string	Yes	-	Account deregistration verification method: - `PHONE_PASSCODE`: Use the phone number verification code method for verification. - `EMAIL_PASSCODE`: Use the email verification code method for verification. - `PASSWORD`: If the user has neither a phone number nor an email bound, the password can be used as a verification method.	`PHONE_PASSCODE`
phonePassCodePayload	DeleteAccountByPhonePassCodeDto	No	-	Data verified by phone number verification code
emailPassCodePayload	DeleteAccountByEmailPassCodeDto	No	-	Data verified by email verification code
passwordPayload	DeleteAccountByPasswordDto	No	-	Data verified by password

¶ Sample Code

package test.authentication;

import cn.authing.sdk.java.client.AuthenticationClient;
import cn.authing.sdk.java.dto.DeleteAccountByEmailPassCodeDto;
import cn.authing.sdk.java.dto.VerifyDeleteAccountRequestDto;
import cn.authing.sdk.java.dto.VerifyDeleteAccountRequestRespDto;
import cn.authing.sdk.java.model.AuthenticationClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

public class VerifyDeleteAccountRequestTest {
    // 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);

        VerifyDeleteAccountRequestDto reqDto = new VerifyDeleteAccountRequestDto();
        reqDto.setVerifyMethod(VerifyDeleteAccountRequestDto.VerifyMethod.EMAIL_PASSCODE);
        DeleteAccountByEmailPassCodeDto passCodeDto = new DeleteAccountByEmailPassCodeDto();
        passCodeDto.setEmail("123@qq.com");
        // Email verification code, a SMS verification code can only be used once, and the default validity period is 5 minutes. You need to obtain it through the send email interface.
        passCodeDto.setPassCode("xxx");
        reqDto.setEmailPassCodePayload(passCodeDto);
        VerifyDeleteAccountRequestRespDto response = client.verifyDeleteAccountRequest(reqDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

¶ Request Response

Type: VerifyDeleteAccountRequestRespDto

Name	Type	Description
statusCode	number	Business status code. You can use this status code to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segment error code, through which you can get the specific error type (successful request does not return). For a detailed list of error codes, see: API Code List (opens new window)
requestId	string	Request ID. Returned when the request fails.
data	VerifyDeleteAccountRequestDataDto	Response Data

Example Results：

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

¶ Data Structure

¶ DeleteAccountByPhonePassCodeDto

Name	Type	Is it required	Description	Example Value
phoneNumber	string	Yes	The phone number bound to this account, without the area code. If it is a foreign phone number, please specify the area code in the phoneCountryCode parameter.	`188xxxx8888`
passCode	string	Yes	SMS verification code. An SMS verification code can only be used once and is valid for one minute. You need to obtain it through the Send SMS interface.	`123456`
phoneCountryCode	string	No	Mobile area code	`+86`

¶ DeleteAccountByEmailPassCodeDto

Name	Type	Is it required	Description	Example Value
email	string	No	Email address bound to this account, not case sensitive.
passCode	string	Yes	Email verification code. A SMS verification code can only be used once, and the default validity period is 5 minutes. You need to obtain it through the Send Email interface.

¶ DeleteAccountByPasswordDto

Name	Type	Is it required	Description	Example Value
password	string	Yes	User password
passwordEncryptType	string	No	Password encryption type, supports RSA256 and SM2 algorithms. The default is `none`, no encryption. - `none`: Do not encrypt the password, use plain text for transmission. - `rsa`: Use RSA256 algorithm to encrypt the password, and need to use the RSA public key of GenAuth service for encryption. Please read the Introduction section to learn how to obtain the RSA256 public key of GenAuth service. - `sm2`: Use SM2 algorithm of national secret (opens new window) to encrypt the password, and need to use the SM2 public key of GenAuth service for encryption. Please read the Introduction section to learn how to obtain the SM2 public key of GenAuth service.	sm2

¶ VerifyDeleteAccountRequestDataDto

Name	Type	Is it required	Description	Example Value
deleteAccountToken	string	Yes	Temporary Token used to cancel an account. You need to call the CancelAccount interface to perform the actual account cancellation operation.	`xxxx`
tokenExpiresIn	number	Yes	Token validity period, the default is 60 seconds.	`60`

Previous article: Forgot password Next article: Cancel account