All Products
Search

This Product

    ID Verification:Query end-to-end authentication logs

    Document Center

    ID Verification:Query end-to-end authentication logs

    Last Updated:Sep 09, 2026

    ID Verification provides end-to-end log monitoring. You can query the logs of an incomplete authentication process using its TransactionId. The results help you analyze the reasons for user churn. This API is not billable.

    API

    This API queries the complete log of an authentication process.

    Important

    • This API queries logs for client-side solutions only. It does not support server-side-only solutions.

    • The client-side SDK for authentication must be version 1.2.6 or later, and the Web SDK must be the latest version. We recommend using the latest SDK versions.

    • Logs are reported and uploaded asynchronously during the authentication process. For complete results, query the logs after the 30-minute validity period of the TransactionId expires.

    • ID Verification stores logs for 30 days by default, after which they are automatically deleted. Ensure you query authentication records within 30 days of the process completion.

    • API name: CheckVerifyLog

    • Request method: POST

    • Transport protocol: HTTPS

    • Endpoints:

      Note

      • An internal network is a private communication network connecting Alibaba Cloud products within the same region. If your application server is deployed in the same region, use the internal endpoint to access the ID Verification service for enhanced security and stability.

      • Different ID Verification product plans support different regions, and data is isolated between them. You must use the endpoint for your data's region to access it.

      Asia Pacific SE 1 (Singapore)

      • Public endpoint: cloudauth-intl.ap-southeast-1.aliyuncs.com

      • Internal endpoint: cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com

      Asia Pacific SE 5 (Jakarta)

      • Public endpoint: cloudauth-intl.ap-southeast-5.aliyuncs.com

      • Internal endpoint: cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com

      China (Hong Kong)

      • Public endpoint: cloudauth-intl.cn-hongkong.aliyuncs.com

      • Internal endpoint: cloudauth-intl-vpc.cn-hongkong.aliyuncs.com

    Online debugging and integration

    Note

    Before debugging and integration, read the Use OpenAPI document to learn how to call APIs on the OpenAPI platform and obtain the SDK.

    You can run this API in OpenAPI Explorer to perform debugging and generate sample SDK code.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    MerchantBizId

    String

    Yes

    A customizable, unique business identifier used for troubleshooting. It can be a combination of letters and digits up to 32 characters long. Ensure this identifier is unique.

    Note

    Alibaba Cloud servers do not enforce the uniqueness of this field. For improved tracking, we strongly recommend that you ensure it is unique.

    e0c34a77f5ac40a5aa5e6ed20c******

    TransactionId

    String

    Yes

    The unique identifier for the entire authentication process. This value is returned by the Initialize API.

    80414a5e6ed20c37ac40a7f55a******

    Response parameters

    Parameter

    Type

    Description

    Example

    RequestId

    String

    The request ID.

    {
  "RequestId": "A180B706-587F-3F53-9861-8A2E70F802D7",
  "Message": "success",
  "Code": "Success",
  "Result": {
    "Passed": "Y",
    "VerifyStatus": "0",
    "LogStatisticsInfo": "{\"faceOverTimes\":0,\"hasFaceOverTimes\":false,\"hasFacePermissionRefuse\":false,\"hasOcrEdit\":false,\"hasOcrEditOverTimes\":false,\"hasOcrOverTimes\":false,\"hasOcrPermissionRefuse\":false,\"ocrEditOverTimes\":0,\"ocrEditTimes\":0,\"ocrOverTimes\":0,\"pageStayTimeInfo\":{\"LOADING\":\"322\",\"OCR_SCAN\":\"8237\",\"OCR_RESULT\":\"2257\",\"FACE\":\"14687\"}}",
    "InterruptPage": "OCR result editing page",
    "InterruptPageEn": "OCR_RESULT",
    "LogInfo": [
      "2025-04-09 17:27:08 Entered the Loading page",
      "2025-04-09 17:27:08 Loading phase ended",
      "2025-04-09 17:27:08 User entered the OCR page",
      "2025-04-09 17:27:16 OCR authentication phase ended",
      "2025-04-09 17:27:16 User entered the OCR editing page",
      "2025-04-09 17:27:19 OCR editing phase ended",
      "2025-04-09 17:27:19 User entered the liveness detection page",
      "2025-04-09 17:27:33 Liveness detection phase ended"
    ],
    "LogInfoEn": [
      "2025-08-13 18:33:44 LOADING_ENTER",
      "2025-08-13 18:33:45 LOADING_EXIT",
      "2025-08-13 18:33:45 GUIDE_PAGE_SHOW",
      "2025-08-13 18:33:46 GUIDE_PAGE_LEAVE",
      "2025-08-13 18:33:46 OCR_ENTER",
      "2025-08-13 18:33:51 TIME_OUT_ALERT_APPEAR",
      "2025-08-13 18:33:54 TIME_OUT_ALERT_CLOSE",
      "2025-08-13 18:33:54 TIME_OUT_RETRY_BTN",
      "2025-08-13 18:33:59 TIME_OUT_ALERT_APPEAR",
      "2025-08-13 18:34:11 TIME_OUT_ALERT_CLOSE",
      "2025-08-13 18:34:11 TIME_OUT_RETRY_BTN",
      "2025-08-13 18:34:16 TIME_OUT_ALERT_APPEAR",
      "2025-08-13 18:34:17 TIME_OUT_ALERT_CLOSE",
      "2025-08-13 18:34:17 TIME_OUT_EXIT_BTN",
      "2025-08-13 18:34:17 OCR_EXIT"
    ],
    "SubCode": "200",
    "VerifyErrorCode": "1000"
  }
}

    Code

    String

    The return code.

    Message

    String

    A detailed description of the return code.

    Result

    Object

    The log content. For parameter details, see the Result table below.

    Result

    Parameter

    Type

    Required

    Description

    VerifyStatus

    String

    Yes

    The authentication status. Valid values:

    • 0: Authentication completed

    • 1: Authentication interrupted

    • 2: Authentication not started

    LogInfo

    List<String>

    No

    The SDK runtime log details, recording user interactions and system events chronologically. Example entries include:

    [

    • Timestamp - Entered a specific page

    • Timestamp - Requested camera permission

    • Timestamp - Agreed to and then closed camera permission

    • Timestamp - Entered the liveness detection retry page

    • Timestamp - User clicked Retry

    • Timestamp - Started colorful liveness detection (only if enabled)

    • Timestamp - Finished colorful liveness detection (only if enabled)

    • Timestamp - User completed client-side facial recognition and entered the loading page

    • Timestamp - Loading completed and the SDK exited

    ]

    LogInfoEn

    List<String>

    No

    The SDK runtime log details in English.

    The format of this field is the same as LogInfo.

    Passed

    String

    No

    Note

    This parameter is returned only when VerifyStatus is 0.

    The final authentication result. Valid values:

    • Y: Pass

    • N: Fail

    SubCode

    String

    No

    Note

    This parameter is returned only when VerifyStatus is 0.

    A detailed code for the authentication result. For a list of possible values, see the SubCode descriptions in the API reference for your specific authentication solution.

    Note

    For example, if you use the eKYC - Web SDK solution, see the SubCode descriptions in the eKYC - Web SDK - CheckResult API reference.

    InterruptPage

    String

    No

    The last page the user visited before the process was interrupted. Valid values:

    • Page not started

    • Loading page

    • Guide page

    • OCR certificate capture page

    • OCR results edit page

    • Liveness detection page

    • NFC information input page

    • NFC reading page

    InterruptPageEn

    String

    No

    The English code for the page where the authentication process was interrupted. Valid values:

    • LOADING

    • GUIDE

    • FACE

    • OCR_SCAN

    • OCR_RESULT

    • NFC_INPUT

    • NFC_READ

    VerifyErrorCode

    String

    No

    The error code for the authentication interruption. Valid values:

    • 1000: The user completed the facial recognition process. The recommended authentication result is Pass.

    • 1001: The user completed the facial recognition process. The recommended authentication result is Fail.

    • 1002: A system error occurred.

    • 1003: SDK initialization failed. Check whether the client time is correct.

    • 1004: A camera permission error occurred.

    • 1005: A network error occurred.

    • 1006: The user exited the process.

    • 1007: The TransactionId is invalid.

    • 1009: The client-side timestamp is incorrect.

    • 1011: The submitted certificate type is incorrect.

    • 1012: Key information is missing from the recognized certificate, or the format verification failed.

    • 1013: The image quality is poor.

    • 1014: The number of attempts exceeded the limit.

    • 1015: The Android OS version is too low.

    • 1016: Camera permission was not granted.

    • 9999: The authentication process was likely interrupted.

    LogStatisticsInfo

    String

    No

    Statistics from the SDK runtime log, as a JSON-formatted string. For field details, see the LogStatisticsInfo table below.

    ExtInfo

    String

    No

    Reserved for extensions.

    LogStatisticsInfo

    Parameter

    Type

    Description

    Example

    pageStayTimeInfo

    Map<String,Long>

    The time spent on each page, in milliseconds. The keys in the map represent the following pages:

    • LOADING: Loading page

    • GUIDE: Guide page

    • OCR_SCAN: OCR page

    • OCR_RESULT: OCR editing page

    • FACE: Facial recognition page

    Note

    The duration is measured from when a page is rendered until the user navigates to another page or closes it.

    {
 "LOADING": "2051",
 "OCR_SCAN": "127238",
 "OCR_RESULT": "1897",
 "FACE": "12371"
}

    hasFaceOverTimes

    Boolean

    Indicates whether a retry pop-up was displayed during liveness detection.

    true

    faceOverTimes

    Long

    The number of times the user clicked Retry during liveness detection.

    2

    hasOcrOverTimes

    Boolean

    Indicates whether the OCR process was retried.

    This flag is true if a server-side verification failure prompted the user to recapture and resubmit the certificate image.

    false

    ocrOverTimes

    Long

    The number of times the user clicked Retry during OCR certificate capture.

    0

    hasOcrEdit

    Boolean

    Indicates whether the user clicked to edit field information on the OCR page.

    true

    ocrEditTimes

    Long

    The number of OCR edits.

    Each time the user edits and submits the information for server-side verification, the count increases by one.

    1

    hasOcrEditOverTimes

    Boolean

    Indicates whether the OCR editing process was retried.

    false

    ocrEditOverTimes

    Long

    The number of OCR editing retries.

    0

    hasOcrPermissionRefuse

    Boolean

    Indicates whether camera permission was denied for OCR.

    false

    hasFacePermissionRefuse

    Boolean

    Indicates whether camera permission was denied for liveness detection.

    false

    Return codes

    HTTP status code

    Code

    Message description

    200

    Success

    Request successful.

    400

    MissingParameter

    Parameter cannot be empty.

    InvalidParameter

    Invalid parameter.

    TransactionIdInvalid

    Invalid Transaction ID.

    403

    Forbidden.RAMUserAccessDenied

    You need to grant the RAM user the AliyunAntCloudAuthFullAccess permission. For more information, see Authorize RAM users to access the service.

    Forbidden.AccountAccessDenied

    Ensure that you have activated ID verification and your account has no overdue payment.

    Throttling.Api

    API request is blocked due to throttling.

    404

    ProcessNotCompleted

    The entire authentication process is not completed.

    500

    InternalError

    Internal system error. Provide feedback to engineers for troubleshooting.

    503

    ServiceUnavailable

    The service is unavailable. Contact engineers for troubleshooting.