nextCursor de la respuesta en una solicitud posterior con las mismas condiciones.
1. URL base
2. Autenticación
Incluya la clave API del proyecto FaceAuth en el encabezadox-api-key.
x-api-key
Es una clave API distinta de la de Liveform. Consulte Comenzar con complementos.
3. Ejemplo de solicitud
startDate y endDate deben enviarse juntos.
4. Parámetros de solicitud
Número máximo de registros que se devuelven. El valor predeterminado es
100, el mínimo 10 y el máximo 200.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.Inicio del rango de consulta, en formato RFC 3339 UTC
yyyy-MM-dd'T'HH:mm:ss.SSSZ. Debe enviarse junto con endDate.Fin del rango de consulta, en formato RFC 3339 UTC. No puede ser anterior a
startDate. Ambos extremos se incluyen en el rango.5. Respuesta
result.json
5-1. Éxito
Una consulta de lista correcta devuelve200 OK con el cuerpo siguiente.
Arreglo de resultados. Cada elemento es un objeto FaceAuthSubmission. Es un arreglo vacío cuando no hay coincidencias.
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:
itemsynextCursor. - 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.
Documentos relacionados
Comenzar con FaceAuth
FaceAuth verifica la identidad un paso más comparando la selfie de un usuario aprobado en el proceso de ID check con la selfie capturada durante FaceAuth. Esta página cubre los dos modos de entrega (URL / API), la estructura de query string de la URL de FaceAuth y las definiciones de los parámetros de solicitud.
Resultado de FaceAuth
Después de que se completa la verificación de FaceAuth, el resultado final (aprobado o rechazado) se envía automáticamente a la URL de webhook registrada en el proyecto ID check existente, proporcionando notificaciones en tiempo real.