Access Documentation
FaceSearch
API Documentation
Get Face Info in Face Library
Get Face Info in Face Library

# Description

This API takes a single face_token and outputs user_data.

# Request URL:

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

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.
Required face_token string Unique face token.

# Response Fields

The API returns a JSON string.

Field Type Description
info
map Face information.
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": "1769743445,07c4bb36-5858-4290-83ef-97c65db691aa",
    "time_used": 48,
    "info": {
        "face_token": "9eab9fe14a402295fb78409a81abfc3c",
        "user_id": "user_01",
        "user_data": "Test user",
        "add_time": 1769739690208
    }
}

Example: error response

{
    "request_id": "1769743204,37ddf07b-c640-4199-ba17-3d13a2059e50",
    "time_used": 55,
    "error": "INVALID_FACE_TOKEN"
}

# error_message Errors

HTTP Status Code Error Description
400 INVALID_FACE_TOKEN Invalid face_token.