GET/Face-auth (lista) - ARGOS Identity

El endpoint se ha trasladado a /v3/face-auth.La ruta, la estructura de la respuesta y los nombres de los campos difieren del endpoint anterior /v3/faceauth. Para migrar una integración existente, consulte Referencia común de FaceAuth — Migrar desde la API anterior.Para consultar un envío concreto, use GET/Face-auth/{authId}. La consulta de lista y la individual son endpoints separados.

Consulta la lista de envíos de FaceAuth por orden de creación más reciente. Si hay una página siguiente, reenvíe el nextCursor de la respuesta en una solicitud posterior con las mismas condiciones.

1. URL base

GET/Face-auth

GET https://rest-api.argosidentity.com/v3/face-auth

2. Autenticación

Incluya la clave API del proyecto FaceAuth en el encabezado x-api-key.

x-api-key

x-api-key: {yourAPIKey}

Es una clave API distinta de la de Liveform. Consulte Comenzar con complementos.

3. Ejemplo de solicitud

GET/Face-auth

curl -X GET "https://rest-api.argosidentity.com/v3/face-auth?limit=10" \
  -H "x-api-key: {yourAPIKey}"

También puede consultar un rango de fechas. startDate y endDate deben enviarse juntos.

Rango de fechas

curl -X GET "https://rest-api.argosidentity.com/v3/face-auth?startDate=2026-08-01T00%3A00%3A00.000Z&endDate=2026-08-31T23%3A59%3A59.999Z&limit=100" \
  -H "x-api-key: {yourAPIKey}"

4. Parámetros de solicitud

integer

Número máximo de registros que se devuelven. El valor predeterminado es 100, el mínimo 10 y el máximo 200.

string

Valor de nextCursor de la respuesta de lista anterior. Reenvíe tal cual el valor emitido por el servidor. Incluye una firma, por lo que modificar cualquier parte devuelve 400 REQUEST_INVALID. No puede construirse a mano ni reutilizarse con otras condiciones de consulta.

string

Inicio del rango de consulta, en formato RFC 3339 UTC yyyy-MM-dd'T'HH:mm:ss.SSSZ. Debe enviarse junto con endDate.

string

Fin del rango de consulta, en formato RFC 3339 UTC. No puede ser anterior a startDate. Ambos extremos se incluyen en el rango.

Enviar cualquier parámetro de consulta distinto de los cuatro anteriores devuelve 400 REQUEST_INVALID. Para consultar un envío concreto, use la ruta de consulta individual.
Una solicitud posterior con cursor debe usar los mismos limit, startDate y endDate que la primera.

5. Respuesta

result.json

{
  "items": [
    {
      "authId": "sampleAuthId1",
      "authStatus": "approved",
      "createTime": "2026-08-11T10:09:14.028Z",
      "submitType": "form",
      "kycSubmissionId": "sampleKycSubmissionId1",
      "deleteTime": null,
      "policy": {
        "faceSimilarity": { "enabled": true, "threshold": 85 },
        "occluded": { "enabled": false, "threshold": null },
        "faceCover": { "enabled": false, "threshold": null },
        "headCover": { "enabled": false, "threshold": null },
        "liveness": { "enabled": false, "threshold": null },
        "activeLiveness": { "enabled": true, "threshold": 75 }
      },
      "result": {
        "faceSimilarity": 100,
        "livenessScore": null,
        "activeLivenessScore": 90.60411071777344,
        "occluded": null,
        "faceCover": null,
        "headCover": null
      },
      "signals": {
        "startButtonClickTime": "2026-08-11T10:08:54.742Z",
        "cameraProcessInfo": [
          {
            "processStartTime": "2026-08-11T10:08:57.300Z",
            "processEndTime": "2026-08-11T10:09:12.278Z",
            "type": "faceAuth-active",
            "error": null
          }
        ]
      },
      "rejectComment": null,
      "failCode": null
    },
    {
      "authId": "sampleAuthId2",
      "authStatus": "rejected",
      "createTime": "2026-08-11T09:10:00.000Z",
      "submitType": "api",
      "kycSubmissionId": "sampleKycSubmissionId2",
      "deleteTime": null,
      "policy": {
        "faceSimilarity": { "enabled": true, "threshold": 85 },
        "occluded": { "enabled": true, "threshold": null },
        "faceCover": { "enabled": false, "threshold": null },
        "headCover": { "enabled": false, "threshold": null },
        "liveness": { "enabled": false, "threshold": null },
        "activeLiveness": { "enabled": false, "threshold": null }
      },
      "result": {
        "faceSimilarity": 72.4,
        "livenessScore": null,
        "activeLivenessScore": null,
        "occluded": {
          "value": false,
          "confidence": 99.2
        },
        "faceCover": null,
        "headCover": null
      },
      "signals": null,
      "rejectComment": [
        "face compare similarity score is lower than threshold"
      ],
      "failCode": [
        "face_compare_underscore"
      ]
    }
  ],
  "nextCursor": "v1.eyJ2IjoxLCJjcmVhdGVUaW1l..."
}

5-1. Éxito

Una consulta de lista correcta devuelve 200 OK con el cuerpo siguiente.

array

Arreglo de resultados. Cada elemento es un objeto FaceAuthSubmission. Es un arreglo vacío cuando no hay coincidencias.

nullable · string

Valor que se envía en el parámetro cursor de la solicitud de la página siguiente. Es null cuando no hay página siguiente.Es un token firmado con el formato v1.{payload}.{signature}. El payload contiene la posición del último elemento y las condiciones de consulta, y está codificado en base64, por lo que puede decodificarse; pero la firma está ligada a las condiciones de consulta, así que modificar el valor o reutilizarlo con otras condiciones hace fallar la validación. No dependa de su estructura: reenvíe exactamente lo que recibió. El formato puede cambiar sin previo aviso.

El cuerpo de la respuesta tiene exactamente dos campos de nivel superior: items y nextCursor.
La lista puede incluir envíos eliminados. Una eliminación completada tiene valor en deleteTime.

5-2. Fallo

Una consulta de lista fallida devuelve un código de estado HTTP con un objeto de error.

6. Respuestas de error

Los errores que devuelve la aplicación de ARGOS usan el formato { code, message }. El 401 y algunos 403 se bloquean en la capa de autenticación y no siguen ese formato: consulte Referencia común de FaceAuth — Respuestas de error.

Estado HTTP	code	Condición
`400`	`REQUEST_INVALID`	Un `limit`, rango de fechas o cursor no válidos, o un parámetro de consulta no definido
`403`	`AUTH_FORBIDDEN`	La clave API es válida pero no está vinculada a un proyecto FaceAuth
`503`	`UPSTREAM_UNAVAILABLE`	Un servicio interno necesario para la consulta no está disponible temporalmente. Reintente la misma solicitud en unos instantes
`503`	`UPSTREAM_INVALID_RESPONSE`	El resultado interno de la consulta no puede convertirse al contrato público
`500`	`INTERNAL_UNEXPECTED`	Error inesperado del servidor

​1. URL base

​2. Autenticación

​3. Ejemplo de solicitud

​4. Parámetros de solicitud

​5. Respuesta

​5-1. Éxito

​5-2. Fallo

​6. Respuestas de error

1. URL base

2. Autenticación

3. Ejemplo de solicitud

4. Parámetros de solicitud

5. Respuesta

5-1. Éxito

5-2. Fallo

6. Respuestas de error