POST
/
search
Search face in collection
curl --request POST \
  --url https://idverify-api.argosidentity.com/modules/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "collectionId": "col_123456789",
  "faceImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ..."
}'
{
  "message": "Search completed successfully",
  "result": [
    {
      "face_id": "<string>",
      "user_name": "<string>",
      "similarity_score": 123
    }
  ]
}
This API endpoint allows you to search for matching faces within a collection using a submitted facial image. The system will compare the submitted image against all faces in the specified collection and return matching results.

​
Request

​
Headers

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

​
Body Parameters

​
collectionId
string
required
Unique identifier of the collection where the face will be added.
​
requestName
string
required
Name that matches the face image
​
faceImage
string
required
Base64-encoded string representation of the face image.

​
Response

​
Success Response (200)

​
message
string
A message indicating the success or error result
​
searchId
string
Identifier for the search request.
​
requestName
string
Name corresponding to the face image for the search operation.
​
option
object
Additional options and settings:option_liveness: Indicates whether the liveness option is enabled or disabled in the settings.liveNess_threshold: Threshold value for the liveness option, as configured in the Search Face threshold settings.liveNessScore: Score representing the result of the liveness check.policy_similarity: Threshold value for similarity option.
​
faceIdList
array
List of face IDs that match the search criteria. Each item in the array is a unique identifier for a face submission.

​
Error Responses

​
Bad Request (400)

​
errorCode
number
Identifies the specific error for troubleshooting:
  • 6030: CollectionId is required
  • 6031: RequestName is required
  • 6032: faceImage is missing
  • 6033: If the collection information doesn’t exist
  • 6034: The collection has already been deleted
  • 6035: When a liveness error occurs
  • 6036: Image is too large
  • 6037: Image is not formatted correctly
  • 6038: Unspecified errors
​
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

Body

application/json
​
collectionId
string
required

Unique identifier of the collection to search in

Example:

"col_123456789"

​
faceImage
string
required

Base64-encoded string representation of the face image to search for

Example:

"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ..."

Response

Face search completed successfully

​
message
string

Success message

Example:

"Search completed successfully"

​
result
object[]