> ## 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.

# GET/Faceauth

> Una API para consultar envíos específicos o la lista completa de envíos utilizando filtros como authId, startDate y endDate para una obtención eficiente de datos.

## 1. URL base

```text GET/FaceAuth theme={null}
https://rest-api.argosidentity.com/v3/faceauth
```

## 2. Autenticación

Incluya la clave API en el encabezado x-api-key:

```text x-api-key theme={null}
x-api-key: {yourAPIKey}
```

## 3. Ejemplo de solicitud

```curl GET/FaceAuth theme={null}
curl -X GET "https://rest-api.argosidentity.com/v3/faceauth" \
-H "x-api-key: {yourAPIKey}" \
```

## 4. Parámetros de solicitud

Ejemplo con parámetros

```curl GET/FaceAuth theme={null}
curl -X GET "https://rest-api.argosidentity.com/v3/faceauth?auth_id={auth_id}&startDate={startDate}" \
-H "x-api-key: {yourAPIKey}" \
```

<ResponseField name="authId" type="string">
  Se utiliza para consultar un envío específico. Si se proporciona `authId`, solo se devuelve el envío correspondiente; de lo contrario, se obtiene la lista completa.
</ResponseField>

<ResponseField name="startDate" type="string">
  Fecha de inicio de la consulta (formato `yyyy-mm-dd`). Para filtrar datos dentro de un período específico, deben proporcionarse tanto `startDate` como `endDate`.
</ResponseField>

<ResponseField name="endDate" type="string">
  Fecha de fin de la consulta (formato `yyyy-mm-dd`).
</ResponseField>

<ResponseField name="nextKey_id" type="string">
  El valor `authId` del objeto `nextPage_key` en la respuesta de la solicitud anterior.
</ResponseField>

<ResponseField name="nextKey_date" type="string">
  El valor `createTime` del objeto `nextPage_key` en la respuesta de la solicitud anterior.
</ResponseField>

<ResponseField name="count" type="string">
  Especifica el número de entradas de datos a obtener (mínimo 1, máximo 2.000). Si no se proporciona, el valor predeterminado es 2.000.
</ResponseField>

<Note>
  * **Límite máximo de consulta**: Una única solicitud puede obtener hasta 2.000 entradas.
  * **Obtención de datos adicionales**: Si hay más datos disponibles, la respuesta incluye el objeto `nextPage_key`.
    Para continuar obteniendo datos, use el `authId` de `nextPage_key` como `nextKey_id` y `createTime` como `nextKey_date` en la siguiente solicitud.
</Note>

## 5. Respuesta

### 5-1. Respuesta (delete\_check:false)

```json result.json theme={null}
[
  {
    "faceAuth_projectId": "sampleProjectId1",
    "data": [
      {
        "policy": {
          "faceSimilarity_threshold": 85,
          "occluded_threshold": false,
          "faceCover_threshold": 0,
          "headCover_threshold": 0,
          "liveness_threshold": 0,
          "activeLiveness_threshold": 0
        },
        "auth_id": "sampleId1",
        "auth_status": "rejected",
        "create_time": "2025-10-02T02:15:17.554Z",
        "submit_type": "form",
        "kyc_submission_id": "sampleKycId1",
        "delete_check": false,
        "result": {
          "active_liveness_score": 97.78668212890625,
          "face_similarity": 100,
          "detectOccluded": true
        },
        "reject_comment": [
          "face is occluded and the confidence is higher than threshold."
        ],
        "fail_code": [
          "Face_Occluded_fail"
        ],
        "signals": {
          "cameraProcessInfo": [
            {
              "processStartTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
              "processEndTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
              "type": "faceAuth-active",
              "error": null
            }
          ],
          "startButtonClickTime": "YYYY-MM-DD-HH-MM-SS-ZZZ"
        }        
      },
      {
        "policy": {
          "faceSimilarity_threshold": 85,
          "occluded_threshold": false,
          "faceCover_threshold": 0,
          "headCover_threshold": 0,
          "liveness_threshold": 0,
          "activeLiveness_threshold": 0
        },
        "auth_id": "sampleId2",
        "auth_status": "rejected",
        "create_time": "2025-10-02T02:15:17.554Z",
        "submit_type": "form",
        "kyc_submission_id": "sampleKycId1",
        "delete_check": true,
        "delete_time": "2025-10-09T03:18:18.046Z"
        "result": {
          "active_liveness_score": 97.78668212890625,
          "face_similarity": 100,
          "detectOccluded": true
        },
        "reject_comment": [
          "face is occluded and the confidence is higher than threshold."
        ],
        "fail_code": [
          "Face_Occluded_fail"
        ],
        "signals": {
          "cameraProcessInfo": [
            {
              "processStartTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
              "processEndTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
              "type": "faceAuth-active",
              "error": null
            }
          ],
          "startButtonClickTime": "YYYY-MM-DD-HH-MM-SS-ZZZ"
        }        
      }
    ],
    "nextPage_key": {
        "authId": "sampleId2",
        "createTime": "2025-10-02T02:15:17.554Z"
      }
  }
]
```

### 5-2. Respuesta (delete\_check:true)

```json result.json theme={null}
[     
  { 
    "auth_id" : "sampleId1", 
		"aurh_status" : "approved",
		"create_time" : "2023-08-18T15:00:00.000Z",
		"submit_type" : "sampleType",
		"kyc_submission_id" : "sampleKycId1",
		"policy" : {
			"faceSimilarity_threshold" : 70,
			"occluded_threshold" : false, 
			"faceCover_threshold" : 0,
			"headCover_threshold" : 50
		},
    "delete_check": true,
    "delete_time": "2023-09-04T02:19:01.399Z",
    "result": {
      "active_liveness_score": 97.78668212890625,
      "face_similarity": 100,
      "detectOccluded": true
    },
  }
]
```

### 5-2. Ejemplo de respuesta

<ResponseField name="faceAuth_projectId" type="string">
  ID del proyecto FaceAuth
</ResponseField>

<ResponseField name="data" type="array">
  Array de envíos obtenidos

  <Expandable title="Properties">
    <ResponseField name="[i]" type="object" required="false">
      Objeto de envío individual

      <Expandable title="Properties">
        <ResponseField name="policy" type="string">
          Objeto de política de umbrales aplicado para la autenticación

          <Expandable title="Properties">
            <ResponseField name="faceSimilarity_threshold" type="string">
              Umbral de similitud facial
            </ResponseField>

            <ResponseField name="faceCover_threshold" type="string">
              Umbral de detección de oclusión facial (gafas, mascarillas, equipo de protección)
            </ResponseField>

            <ResponseField name="headCover_threshold" type="string">
              Umbral de detección de equipo de protección para la cabeza
            </ResponseField>

            <ResponseField name="occluded_threshold" type="boolean">
              Si el rostro está oculto por manos u otros objetos
            </ResponseField>

            <ResponseField name="liveness_threshold" type="boolean">
              Umbral de liveness pasivo
            </ResponseField>

            <ResponseField name="activeLiveness_threshold" type="boolean">
              Umbral de liveness activo
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="auth_id" type="string">
          ID de autenticación único para cada envío
        </ResponseField>

        <ResponseField name="auth_status" type="string">
          Resultado de autenticación (por ejemplo, approved, rejected)
        </ResponseField>

        <ResponseField name="create_time" type="string">
          Fecha y hora del envío (UTC+0)
        </ResponseField>

        <ResponseField name="submit_type" type="string">
          Método de envío
        </ResponseField>

        <ResponseField name="kyc_submission_id" type="string">
          ID del envío KYC donde se realizó FaceAuth
        </ResponseField>

        <ResponseField name="delete_check" type="boolean">
          Si los datos han sido eliminados
        </ResponseField>

        <ResponseField name="delete_time" type="string">
          Fecha y hora de eliminación (UTC+0)
        </ResponseField>

        <ResponseField name="result" type="object">
          Objeto de datos del resultado de autenticación

          <Expandable title="Properties">
            <ResponseField name="faceSimilarity" type="number">
              Valor del resultado de similitud facial
            </ResponseField>

            <ResponseField name="occluded" type="boolean">
              Valor del resultado que indica si el rostro está cubierto por manos u objetos específicos
            </ResponseField>

            <ResponseField name="headCover" type="number">
              Valor del resultado de detección de oclusión facial (gafas, mascarillas, equipo de protección)
            </ResponseField>

            <ResponseField name="faceCover" type="number">
              Valor del resultado de detección de equipo de protección para la cabeza
            </ResponseField>

            <ResponseField name="livenessScore" type="number">
              Valor del resultado de liveness pasivo
            </ResponseField>

            <ResponseField name="activeLivenessScore" type="number">
              Valor del resultado de liveness activo
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="rejectComment" type="array">
          Motivo de rechazo
        </ResponseField>

        <ResponseField name="failCode" type="array">
          Código de fallo
        </ResponseField>

        <ResponseField name="signals" type="object">
          Objeto de datos adicionales generado durante el proceso

          <Expandable title="Properties">
            <ResponseField name="startButtonClickTime" type="string">
              Marca de tiempo cuando el usuario hizo clic en el botón de inicio (formato ISO 8601)
            </ResponseField>

            <ResponseField name="cameraProcessInfo" type="array">
              Array de datos de operación de la cámara

              <Expandable title="Properties">
                <ResponseField name="[i].type" type="string">
                  Tipo de proceso (por ejemplo, `faceAuth-passive` o `faceAuth-active`.)
                </ResponseField>

                <ResponseField name="[i].processStartTime" type="string">
                  Marca de tiempo cuando el proceso comenzó (formato ISO 8601)
                </ResponseField>

                <ResponseField name="[i].processEndTime" type="string">
                  Marca de tiempo cuando el proceso terminó (formato ISO 8601)
                </ResponseField>

                <ResponseField name="[i].error" type="string">
                  Error que ocurrió durante el proceso (`null` si no hay error)
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="nextPage_key" type="object">
  Objeto clave para obtener la siguiente página

  <Expandable title="Properties">
    <ResponseField name="create_time" type="string">
      create\_time de la clave para obtener la siguiente página
    </ResponseField>

    <ResponseField name="authId" type="string">
      authId de la clave para obtener la siguiente página
    </ResponseField>
  </Expandable>
</ResponseField>

### 5-3. Códigos de error

Si ocurre un error, se devuelve un código de estado 400 junto con detalles en el cuerpo de la respuesta:

```json error.json theme={null}
{
  traceId: '0199cb93-bdf1-77ef-8cd4-3d38dec61830',
  errorCode: 'NOT_FOUND',
  message: 'faceAuth_project not found'
}
```

| Código de error              | Descripción                                                                                                                      |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `faceAuth_project not found` | Este error ocurre cuando no existe un proyecto válido correspondiente a la API-Key enviada. Verifique si su API-Key es correcta. |