Access Documentation
FaceSearch
API Documentation
Query Face Info by user_id
Query Face Info by user_id

# Query Face Info by user_id

# Description

This API takes a single user_id and returns the corresponding query list.

# Request URL

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

# 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.
Required sign_version String Signature algorithm version. Pass: hmac_sha1
Required group_id String User-defined face library identifier.
Required user_id string User ID.

# Response Fields

The API returns a JSON string.

Field Type Description
request_id String A unique string to distinguish each request.
time_used Int Total time consumed by the request in milliseconds.
infos Array 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.
error string Returned only when an error occurs; otherwise this field is not returned.

# Example: success response

{
 "request_id": "1783655431,7bfa8dd7-fe1f-44c8-99df-59b22c4e9434",
 "time_used": 185,
 "infos": [
 {
 "face_token": "75932a4a4b090b7c0a87b9452de2e0ff",
 "user_id": "user_01",
 "user_data": "Test user",
 "add_time": 1783653968086
 },
 {
 "face_token": "6e1f617325fef1c5ca1e538beba3c59a",
 "user_id": "user_01",
 "user_data": "Test user",
 "add_time": 1783654676716
 },
 {
 "face_token": "bfff09553f3700a1aadeea91d1d92ac5",
 "user_id": "user_01",
 "user_data": "Test user",
 "add_time": 1783654692663
 },
 {
 "face_token": "d424506e339748c7f23b15d75cfe3de1",
 "user_id": "user_01",
 "user_data": "Test user",
 "add_time": 1783654696705
 },
 {
 "face_token": "1e172d662d97cfb2672ec186cd213b66",
 "user_id": "user_01",
 "user_data": "Test user",
 "add_time": 1783654715062
 }
 ]
}

# Example: error response

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

# error Errors

HTTP Status Code Error Description
400 INVALID_FACE_TOKEN Invalid face_token.