Access Documentation
FaceSearch
API Documentation
Delete Face Library
Delete Face Library

# Description

This API deletes the specified face library.

# Request URL:

https://api-sgp.yljz.com/finauth/search/group/free

Note: In production environments, please use HTTPS for communication. HTTP communication is considered insecure and poses security risks; therefore, it should not be used in production environments. Services using HTTP in production will not receive reliability guarantees.

# Calling Method

POST Note: Use form-data format for the request

# Request Parameters

Parameter Type Description
Required
sign String The client signature for calling this API. For how to generate the signature, see App - Authentication Guide.
Required sign_version String Signature algorithm version. Set to: hmac_sha1
Required group_id String Face library identifier provided by the user.
Optional check_empty
Int
Whether to check if the face library contains face data before deletion. Default: 1.
0: Do not check
1: Check
If set to 1, the library cannot be deleted when it contains face data.

# Response Fields

Field Type Description
request_id String A unique string to distinguish each request.
time_used Int Total time consumed by the request in milliseconds.
group_id string Identifier of the deleted face library.
error
String Returned only when the request fails. See the error section below for details. Otherwise this field does not exist.

Example: success response

{
    "request_id": "1769684764,35b33b50-60ef-47dd-a346-c224ec8a313b",
    "time_used": 100,
    "group_id": "YuanliStudent_01"
}

Example: error response

{
    "request_id": "1769684828,e483ae63-913b-4e32-9068-3719cce59570",
    "time_used": 15,
    "error": "INVALID_GROUP_ID"
}

# error_message Errors

ERROR_MESSAGE specific to this API

HTTP Status Code Error Description
400 INVALID_OUTER_ID Face library does not exist.
400 NOT_EMPTY The face library is not empty and cannot be deleted (when check_empty=1).