Access Documentation
FaceSearch
API Documentation
Get Face Library List
Get Face Library List

# Description

Query the list of created face libraries.

# Request URL:

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

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

# Response Fields

Field Path Type Description
request_id String A unique string to distinguish each request. It can be used for subsequent data backtracking. This field is always returned.
model_version String Algorithm model version used for face recognition. Example: s21
group_id
String
Unique identifier of the user-defined face library. Empty if not defined.
group_name String Face library name.
group_data String Face library information.
add_time string Creation time.
error
String
Returned only when an error occurs. See the error section below for details. Otherwise this field does not exist.
time_used
Int
Total time consumed by the request in milliseconds. This field is always returned unless a 404 (API_NOT_FOUND) or 403 (AUTHORIZATION_ERROR) occurs.

Example: success response

{
    "request_id": "1772532811,965b2850-1bbb-4d87-a59a-c6cfd0cfa230",
    "time_used": 59,
    "group_infos": [
        {
            "group_id": "Finauth_test_001",
            "group_name": "TestUserSet001",
            "group_data": "",
            "model_version": "s21",
            "add_time": "2026-01-27T14:19:01+08:00"
        },
        {
            "group_id": "Finauth_test_002",
            "group_name": "TestUserSet002",
            "group_data": "",
            "model_version": "s21",
            "add_time": "2026-01-27T19:42:47+08:00"
        },
        {
            "group_id": "YuanliStudent_test_01",
            "group_name": "MegviiInternLibrary_01",
            "group_data": "Megvii intern face library for storing face information",
            "model_version": "s21",
            "add_time": "2026-02-05T11:17:45+08:00"
        }
    ]
}