1. URL base
2. Autenticación
Incluya la clave API del proyecto FaceAuth en el encabezadox-api-key.
x-api-key
3. Ejemplo de solicitud
Concurl, la opción --location es necesaria para seguir la redirección.
python
4. Parámetros de ruta
5. Respuesta
5-1. Éxito
Este endpoint responde con una redirección, no con un cuerpo JSON. Si tiene éxito devuelve302 Found con el encabezado siguiente, y el cuerpo está vacío.
result.http
200 OK con los datos originales de la imagen facial.
- El cuerpo de la respuesta de éxito está vacío. No procese el
302como JSON. - La URL de descarga caduca a los 5 minutos. Si ha caducado, invoque de nuevo esta API para obtener una nueva.
5-2. Fallo
Una descarga de imagen fallida devuelve un código de estado HTTP con un objeto de error.6. Política de acceso y eliminación
- Si el proyecto FaceAuth de la clave API es distinto del proyecto del envío, la respuesta es
404, igual que para unauthIdinexistente. - Los envíos ya eliminados, los envíos con
deleteTimey los envíos sin referencia de imagen original devuelven siempre404. - Una vez completada la eliminación, la imagen ya no puede descargarse con esta API.
7. 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.