GET
/
faces
Get list of faces in collection
curl --request GET \
  --url https://idverify-api.argosidentity.com/modules/faces \
  --header 'x-api-key: <api-key>'
{
  "message": "Faces retrieved successfully",
  "result": [
    {
      "collection_id": "<string>",
      "face_id": "<string>",
      "user_name": "<string>",
      "create_time": "<string>",
      "meta_face_id": "<string>"
    }
  ],
  "totalCount": "<string>"
}
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

​
x-api-key
string
The API key used for authentication and access control. This header parameter is required for authorization.

​
Query Parameters

​
collectionId
string
required
Unique identifier of the collection where the face will be added.
​
page
string
required
Page number for pagination. Returns 50 pieces of data per iteration.
​
term
string
Retrieves a list of faceIds containing a specific string. (Must be at least 5 characters long)

​
Response

​
Success Response (200)

​
message
string
A success or error message indicating the result
​
result
array
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
​
totalCount
string
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)

​
errorCode
number
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
​
message
string
Briefly describes the error. Please refer to the error code for details.

​
Forbidden (403)

​
errorCode
number
Identifies the specific error for troubleshooting:
  • 6039: API Key is required
  • 6040: Access Denied: API Key is unavailable
​
message
string
Briefly describes the error. Please refer to the error code for details.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
collectionId
string
required

Unique identifier of the collection

​
page
string
required

Page number for pagination. Returns 50 pieces of data per iteration

​
term
string

Retrieves a list of faceIds containing a specific string. (Must be at least 5 characters long)

Response

List of faces retrieved successfully

​
message
string

Success message

Example:

"Faces retrieved successfully"

​
result
object[]
​
totalCount
string

Total number of faces found that match the search criteria