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

  7. User authentication module

  8. /

  9. Login

  10. /
  11. Self-built APP scan code login: APP end modifies QR code status

Self-built APP scan code login: APP end modifies QR code status

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

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

This endpoint is used to modify the QR code status in the self-built APP scan code login, which corresponds to the process of terminal users scanning the code, confirming authorization, and canceling authorization after the browser renders the QR code. This interface requires the user's login status.

Method name

AuthenticationClient.changeQrCodeStatus

Request parameters

NameType
Required
Default value
Description
Sample value
actionstringyes-Action to change QR code status:
- SCAN: Change the QR code status to scanned status. This operation should be performed immediately after the mobile APP scans the code;
- CONFIRM: Change the QR code status to authorized. Before performing this operation, you must first perform the SCAN operation;<br>-CANCEL: Change the QR code status to canceled. Before performing this operation, you must first perform theSCAN operation Operation;
CONFIRM
qrcodeIdstringyes-QR code unique ID

Sample code

package test.authentication;

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

public class ChangeQrCodeStatusTest {
// 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"; // Needs to be replaced with your GenAuth App Host private static final String APP_HOST = "AUTHING_APP_HOST"; // Needs 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); ChangeQRCodeStatusDto reqDto = new ChangeQRCodeStatusDto(); reqDto.setQrcodeId("123"); reqDto.setAction(ChangeQRCodeStatusDto.Action.CONFIRM);
CommonResponseDto response = client.changeQrCodeStatus(reqDto);
System.out.println(JsonUtils.serialize(response));
}
}

Request response

Type: CommonResponseDto

NameTypeDescription
statusCodenumberBusiness status code, which can be used to determine whether the operation is successful. 200 means success.
messagestringDescription
apiCodenumberSegmented error code, which can be used to get the specific error type (successful request does not return). For a detailed list of error codes, see: API Code List (opens new window)
requestIdstringRequest ID. Returned when the request fails.

Sample result:

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

Data structure