All Products
Search

This Product

    ID Verification:Authentication log query API operation

    Document Center

    ID Verification:Authentication log query API operation

    Last Updated:Oct 21, 2025

    ID Verification supports end-to-end log monitoring. You can query the logs for incomplete facial recognition processes using a TransactionId. The query results can help you analyze the reasons for user churn. This API operation is free of charge.

    API description

    This API operation queries the complete log of an authentication process.

    Important

    • This API operation can query logs only for solutions that use client-side integration. It does not support solutions that use only server-side integration.

    • The client-side software development kit (SDK) for authentication must be version 1.2.6 or later. The Web SDK must also be the latest version. We recommend that you use the latest versions available.

    • Because logs are reported asynchronously during the authentication process, you must wait for the 30-minute validity period of the authentication TransactionId to expire before you query the logs.

    • By default, ID Verification service records are stored for 30 days. The system automatically deletes expired records. Therefore, you must query authentication records within 30 days after the authentication process is complete.

    • API operation name: CheckVerifyLog

    • Request method: POST

    • Transport protocol: HTTPS

    • Endpoint:

      Note

      • An internal same-region endpoint is used for communication between Alibaba Cloud products within the same region. If your business server is deployed in the same Alibaba Cloud region, you can use an internal same-region endpoint to access the ID Verification service for more secure and stable network communication.

      • Different ID Verification product solutions support different regions. Data is isolated between regions. You must select the API operation domain name that corresponds to the region where your data is located to access it.

      Singapore

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

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

      Indonesia

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

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

      China (Hong Kong)

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

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

    Online debugging and integration

    Note

    Before you start debugging and integration, review the Use OpenAPI to debug and integrate server-side APIs document to learn how to call API operations on the OpenAPI platform and obtain the SDK and sample code.

    You can run this API operation in OpenAPI Explorer to debug it, and generate an SDK code sample.

    Request parameters

    Name

    Type

    Required

    Description

    Example

    MerchantBizId

    String

    Yes

    A custom unique business identifier that you provide. It is used for subsequent troubleshooting. It can be a combination of letters and digits up to 32 characters in length. Make sure it is unique.

    Note

    Alibaba Cloud servers do not check the uniqueness of this field's value. To better track requests, we strongly recommend that you ensure the uniqueness of this field.

    e0c34a77f5ac40a5aa5e6ed20c******

    TransactionId

    String

    Yes

    The unique identifier for the entire authentication process. Obtain this value by calling the Initialize API operation.

    80414a5e6ed20c37ac40a7f55a******

    Response parameters

    Name

    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 more information about the parameters, see the Result table below.

    Result

    Name

    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

    Details of the SDK runtime logs. Format:

    [

    • Time - Started XX page

    • Time - Enabled camera permission

    • Time - Agreed to and closed camera permission

    • Time - Started liveness detection retry page

    • Time - User clicked Retry

    • Time - Color liveness detection started (only for solutions with color liveness detection enabled)

    • Time - Color liveness detection ended (only for solutions with color liveness detection enabled)

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

    • Time - Loading completed and SDK exited

    ]

    LogInfoEn

    List<String>

    No

    Details of the SDK runtime logs, in English.

    This field has the same format as LogInfo.

    Passed

    String

    No

    Note

    This parameter is returned only when VerifyStatus is 0.

    The final authentication result. Valid values:

    • Y: Passed

    • N: Failed

    SubCode

    String

    No

    Note

    This parameter is returned only when VerifyStatus is 0.

    The description of the authentication result. For information about the return values, see the SubCode description in the API documentation for the authentication solution you are using.

    Note

    For example, if you use the eKYC - Web SDK solution for authentication, see the SubCode description in the documentation for the eKYC - Web SDK - CheckResult API operation.

    InterruptPage

    String

    No

    The last page the user was on when the authentication was interrupted. Valid values:

    • Page not started

    • Loading page

    • Guide page

    • OCR certificate capture page

    • OCR result editing page

    • Liveness detection page

    • NFC information input page

    • NFC reading page

    InterruptPageEn

    String

    No

    The last page displayed when the authentication is interrupted. The valid English values are:

    The following unordered list shows the transformed values:

    • LOADING

    • GUIDE

    • FACE

    • OCR_SCAN

    • OCR_RESULT

    • NFC_INPUT

    • NFC_READ

    VerifyErrorCode

    String

    No

    The error code for the authentication interruption:

    • 1000: The user completed the facial recognition process. The suggested authentication result is Passed.

    • 1001: The user completed the facial recognition process. The suggested authentication result is Failed.

    • 1002: A system error occurred.

    • 1003: The SDK failed to initialize. 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 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 errors exceeded the upper limit.

    • 1015: The Android system version is too low.

    • 1016: Camera permission was not obtained.

    • 9999: The authentication process may have been interrupted.

    LogStatisticsInfo

    String

    No

    Details of the SDK runtime log statistics, in a JSON string format. For more information, see the LogStatisticsInfo table below.

    ExtInfo

    String

    No

    An extension field. This is reserved.

    LogStatisticsInfo

    Name

    Type

    Meaning

    Example

    pageStayTimeInfo

    Map<String,Long>

    The duration the user stayed on each page, in milliseconds. Pages:

    • LOADING: Loading page

    • GUIDE: Guide page

    • OCR_SCAN: OCR page

    • OCR_RESULT: OCR editing page

    • FACE: The page for face detection.

    Note

    The duration refers to the time from when a page is rendered and displayed until the user navigates to the next page or closes the current page.

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

    hasFaceOverTimes

    Boolean

    Indicates whether a retry pop-up appeared during the liveness detection process.

    true

    faceOverTimes

    Long

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

    2

    hasOcrOverTimes

    Boolean

    Indicates whether the OCR process was retried.

    A retry occurs if the user recaptures and submits a certificate image after the server-side verification of the previous image fails.

    false

    ocrOverTimes

    Long

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

    0

    hasOcrEdit

    Boolean

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

    true

    ocrEditTimes

    Long

    The number of OCR edits.

    An edit is counted each time the user edits information and clicks Submit for server-side verification.

    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.