# Description

This API queries the list of all existing face name entries.

# Request URL:

https://api-sgp.yljz.com/finauth/search/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

Required	Field	Type	Description
Required	sign	String	The client signature for calling this API. For how to generate the signature, see the "Authentication Guide" document.
Required	sign_version	String	Signature algorithm version. Set to: hmac_sha1
Required	group_id	String	User-defined face library identifier.
Optional	start	Int	A number n indicating the index of the first face_token to return in this FaceSet. n is an integer in [1,1000]. By passing n, you can control this API to return results starting from the n-th face_token. Returned face_token values are sorted by creation time, and each request returns 100 face_token values. Default: 1. You can pass the next value returned by the previous request to obtain the next 100 face_token values.
Optional	limit	Int	Limit on the number of items returned. Default: 100. Maximum: 1000.

# Response Fields

The API returns a JSON string.

Field	Type	Description
face_tokens	Array	Array of face_token entries. Note: If there is no face_token in the face library, an empty array is returned.
face_token	string	Unique face token.
user_id	string	User ID.
user_data	string	User information.
add_time	string	Add time in milliseconds timestamp.
time_used	Int	Total time consumed by the request in milliseconds.
request_id	String	A unique string to distinguish each request.
error	String	Returned only when the request fails. See the error section below for details. Otherwise this field does not exist.

Response Example

Example: success response

{
    "request_id": "1769742249,b0513d34-fcf4-490b-b9c7-634db3cbc590",
    "time_used": 74,
    "face_tokens": [
        {
            "face_token": "9eab9fe14a402295fb78409a81abfc3c",
            "user_id": "user_01",
            "user_data": "Test user",
            "add_time": 1769739690208
        },
        {
            "face_token": "dfe27a204b48e06e8f1ae712d39515d6",
            "user_id": "user_01",
            "user_data": "Test user",
            "add_time": 1769741642666
        },
        {
            "face_token": "ced18ec4ff9c37a7d159cda466224047",
            "user_id": "user_01",
            "user_data": "Test user",
            "add_time": 1769741643344
        }
    ]
}

Example: error response

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