API Reference
Get list of faces
Retrieve a list of all faces contained within a specific collection
GET
Get list of faces in collection
This API endpoint allows you to retrieve a list of all faces contained within a specific collection. You can use pagination and search functionality to efficiently manage large collections of facial data.
Request
Headers
The API key used for authentication and access control. This header parameter is required for authorization.
Query Parameters
Retrieves a list of faceIds containing a specific string. (Must be at least 5 characters long)
Response
Success Response (200)
Array of face objects containing:collection_id: Unique identifier of the face collectionface_id: Unique identifier for the face in the collectionuser_name: Name of the user associated with the facecreate_time: Timestamp when the face was addedmeta_face_id: A metadata identifier for the face
Represents the total number of faces found that match the search criteria. In this example, only one face is found, but this value could be higher if more matches are detected.
Error Responses
Bad Request (400)
Identifies the specific error for troubleshooting:
- 6024: CollectionId is required
- 6025: Term string is less than 5 characters long
- 6026: Page is missing
- 6027: Collection information does not exist
- 6028: This collection is unavailable
- 6029: Fail to get Face list
Forbidden (403)
Identifies the specific error for troubleshooting:
- 6039: API Key is required
- 6040: Access Denied: API Key is unavailable
Related documents
Face ID Overview
Learn about Face ID API for facial recognition and identity verification
Face ID: How It Works
Understanding the Face ID workflow and integration process
Face ID Best Practices
Best practices for implementing Face ID in your application