Saltar al contenido principal
POST
/
search
Search face in collection
curl --request POST \
  --url https://face.argosidentity.com/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "collectionId": "col_123456789",
  "requestName": "John Doe",
  "faceImage": "9j/4AAQSkZJRgABAQAAAQ..."
}
'
{
  "message": "Search completed successfully",
  "result": [
    {
      "face_id": "<string>",
      "user_name": "<string>",
      "similarity_score": 123
    }
  ]
}
Este endpoint de API le permite buscar rostros coincidentes dentro de una colección usando una imagen facial enviada. El sistema comparará la imagen enviada contra todos los rostros en la colección especificada y devolverá los resultados coincidentes.

​
Solicitud

​
Headers

​
x-api-key
string
La clave API utilizada para autenticación y control de acceso. Este parámetro de encabezado es requerido para autorización.

​
Parámetros del Body

​
collectionId
string
requerido
Identificador único de la colección donde se buscará el rostro.
​
requestName
string
requerido
Nombre que corresponde a la imagen facial.
​
faceImage
string
requerido
Representación en cadena codificada en Base64 de la imagen facial.

​
Respuesta

​
Respuesta Exitosa (200)

​
message
string
Un mensaje que indica el resultado exitoso o de error.
​
searchId
string
Identificador para la solicitud de búsqueda.
​
requestName
string
Nombre correspondiente a la imagen facial para la operación de búsqueda.
​
option
object
Opciones y configuraciones adicionales:option_liveness: Indica si la opción de liveness está habilitada o deshabilitada en la configuración.liveNess_threshold: Valor de umbral para la opción de liveness, según lo configurado en los ajustes de umbral de Search Face.liveNessScore: Puntuación que representa el resultado de la verificación de liveness.policy_similarity: Valor de umbral para la opción de similitud.
​
faceIdList
array
Lista de IDs de rostros que coinciden con los criterios de búsqueda. Cada elemento en el array es un identificador único para un envío de rostro.

​
Respuestas de Error

​
Bad Request (400)

​
errorCode
number
Identifica el error específico para resolución de problemas:
  • 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
Describe brevemente el error. Consulte el código de error para más detalles.

​
Forbidden (403)

​
errorCode
number
Identifica el error específico para resolución de problemas:
  • 6039: API Key is required
  • 6040: Access Denied: API Key is unavailable
​
message
string
Describe brevemente el error. Consulte el código de error para más detalles.

Autorizaciones

​
x-api-key
string
header
requerido

Cuerpo

application/json
​
collectionId
string
requerido

Unique identifier of the collection to search in

Ejemplo:

"col_123456789"

​
requestName
string
requerido

Name that matches the face image

Ejemplo:

"John Doe"

​
faceImage
string
requerido

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

Ejemplo:

"9j/4AAQSkZJRgABAQAAAQ..."

Respuesta

Face search completed successfully

​
message
string

Success message

Ejemplo:

"Search completed successfully"

​
result
object[]