All Products
Search

This Product

    ID Verification:Delete face images from a face library

    Document Center

    ID Verification:Delete face images from a face library

    Last Updated:Jul 06, 2026

    FACE_IDU supports the face retrieval mode and provides face library management features. You can delete specific face images by using a user ID in the ID Verification console or by calling this operation.

    Operation details

    • Operation: DeleteFaceRecordV2

    • Request method: POST

    • Protocol: HTTPS

    • QPS limit: The maximum request rate for a single tenant is 50 QPS.

    • Endpoint:

      Note

      • Different ID Verification solutions support different regions, and data is isolated between them. To access your data, you must use the API domain name for the region where your data is stored.

      Singapore

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

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

      Indonesia (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

      Malaysia (Kuala Lumpur)

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

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

    Online debugging and integration

    Note

    Before you debug or integrate, read the Use OpenAPI guide to understand how to call APIs on the OpenAPI platform and how to obtain the SDK.

    You can use OpenAPI Explorer to directly run this API for debugging, and generateSDK code examples.

    Request parameters

    Name

    Type

    Description

    Required

    MerchantUserId

    String

    The unique user identifier. This value must be consistent with the one used when the face record was added by calling AddFaceRecord. If no value was provided during registration, you can use the default image name.

    Yes

    FaceGroupCode

    String

    The code of the target face library. If this parameter is not specified, the face data of the user is deleted from all face libraries.

    No

    Response parameters

    Name

    Type

    Description

    Example

    HTTP Status Code

    integer

    The HTTP status code.

    200

    HTTP Body

    RequestId

    String

    The unique ID of the request, used for troubleshooting.

    130A2C10-B9EE-4D84-88E3-5384FF03****

    Code

    String

    The returned code. For more information, see Server-side HTTP status codes.

    Success

    Message

    String

    The detailed description of the returned code.

    The request is successful.

    Result.Deleted

    String

    The deletion result.

    • Y: The face image is deleted.

    • N: The face image failed to be deleted.

    Y

    Result.DeletedGroupCodes

    String

    The list of face library codes from which the deletion was actually performed, separated by commas. If FaceGroupCode is not specified, all deleted libraries are returned.

    10001