Access Documentation
FaceSearch
API Documentation
Get Face Library Details
Get Face Library Details

# Description

Query detailed information about a face library.

# Request URL:

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

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 ID.

# Response Fields

Field Path Type Description
request_id String A unique string to distinguish each request. It can be used for subsequent data lookup. 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": "1772530321,13109482-5119-4ac5-981e-ef4b06aa10bd",
    "time_used": 159,
    "info": {
        "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"
    }
}

Example: error response

{
    "request_id": "1769684042,e043ea9c-92c9-4c1e-8af4-8198da8ac6c1",
    "time_used": 17,
    "error": "GROUP_EXIST"
}

# error_message Errors

ERROR_MESSAGE specific to this API

HTTP Status Code Error Description
400 INVALID_OUTER_ID Face library does not exist.