> ## Documentation Index
> Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Buscar rostro

> Busque rostros coincidentes dentro de una colección usando una imagen enviada

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

<ParamField header="x-api-key" type="string">
  La clave API utilizada para autenticación y control de acceso. Este parámetro de encabezado es requerido para autorización.
</ParamField>

### Parámetros del Body

<ParamField header="collectionId" type="string" required>
  Identificador único de la colección donde se buscará el rostro.
</ParamField>

<ParamField header="requestName" type="string" required>
  Nombre que corresponde a la imagen facial.
</ParamField>

<ParamField header="faceImage" type="string" required>
  Representación en cadena codificada en Base64 de la imagen facial.
</ParamField>

## Respuesta

### Respuesta Exitosa (200)

<ResponseField name="message" type="string">
  Un mensaje que indica el resultado exitoso o de error.
</ResponseField>

<ResponseField name="searchId" type="string">
  Identificador para la solicitud de búsqueda.
</ResponseField>

<ResponseField name="requestName" type="string">
  Nombre correspondiente a la imagen facial para la operación de búsqueda.
</ResponseField>

<ResponseField name="option" type="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.
</ResponseField>

<ResponseField name="faceIdList" type="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.
</ResponseField>

### Respuestas de Error

#### Bad Request (400)

<ResponseField name="errorCode" type="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
</ResponseField>

<ResponseField name="message" type="string">
  Describe brevemente el error. Consulte el código de error para más detalles.
</ResponseField>

#### Forbidden (403)

<ResponseField name="errorCode" type="number">
  Identifica el error específico para resolución de problemas:

  * 6039: API Key is required
  * 6040: Access Denied: API Key is unavailable
</ResponseField>

<ResponseField name="message" type="string">
  Describe brevemente el error. Consulte el código de error para más detalles.
</ResponseField>


## OpenAPI

````yaml POST /search
openapi: 3.1.0
info:
  title: Face ID API
  description: >-
    API for facial recognition and identity verification using Face ID
    technology
  version: 1.0.0
servers:
  - url: https://face.argosidentity.com
    description: Production server
security: []
paths:
  /search:
    post:
      tags:
        - Face ID
      summary: Search face in collection
      description: Search for matching faces within a collection using a submitted image
      operationId: searchFace
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - collectionId
                - requestName
                - faceImage
              properties:
                collectionId:
                  type: string
                  description: Unique identifier of the collection to search in
                  example: col_123456789
                requestName:
                  type: string
                  description: Name that matches the face image
                  example: John Doe
                faceImage:
                  type: string
                  description: >-
                    Base64-encoded string representation of the face image to
                    search for
                  example: 9j/4AAQSkZJRgABAQAAAQ...
      responses:
        '200':
          description: Face search completed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Success message
                    example: Search completed successfully
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        face_id:
                          type: string
                          description: Unique identifier for the matching face
                        user_name:
                          type: string
                          description: Name of the user associated with the matching face
                        similarity_score:
                          type: number
                          description: >-
                            Similarity score between the searched face and the
                            matching face
        '400':
          description: Bad request - Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: number
                    description: Error code
                    enum:
                      - 6035
                      - 6036
                      - 6037
                      - 6038
                  message:
                    type: string
                    description: Error message
        '403':
          description: Forbidden - Authentication required
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: number
                    description: Error code
                    enum:
                      - 6039
                      - 6040
                  message:
                    type: string
                    description: Error message
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````