Saltar al contenido principal

​
QueryString para acceder a FaceAuth

FaceAuth es un subproyecto de ID Check, y los administradores pueden crear tantos proyectos como deseen. Para que los usuarios reciban autenticación adicional a través de FaceAuth, los administradores deben utilizar la URL de Face Auth dentro del proyecto Add-on.
Para hacer referencia a un submission_Id que ha sido aprobado a través de ID document o Knowledge-based donde existe una imagen selfie, se debe agregar a la URL mediante QueryString, y por motivos de seguridad, siempre debe usarse en estado cifrado.
El cifrado debe utilizar la clave API dentro del proyecto FaceAuth y utiliza AES-256.
Para métodos detallados, consulte Cifrado de Query String en la página de Cifrado y Descifrado de datos.
Face Auth URL
  https://form.argosidentity.com/face-auth?pid={faceAuth_projectId}
Face Auth QueryString básico: Solo agregar el submission_Id de referencia
  https://form.argosidentity.com/face-auth?pid={faceAuth_projectId}&encrypted={sid={submission_Id}}
Face Auth QueryString con todos los parámetros: sid, authUserId, authCf1, authCf2, authCf3, token
  https://form.argosidentity.com/face-auth?pid={faceAuth_projectId}&encrypted={sid={submission_Id}&authUserId={user Id}&authCf1={additional_info}&...&token={any tokenId}}
Cuando está cifrado
  https://form.argosidentity.com/face-auth?pid={faceAuth_projectId}&encrypted={encrypted}

​
Definición de parámetros de solicitud

​
pid
string
requerido
Número único asignado al proyecto al crear un proyecto FaceAuth (se adjunta automáticamente a la URL)
​
sid
string
requerido
submission_Id aprobado a través de ID document o Knowledge-based (se usa sid para distinguir)
​
authUserId
string
ID de usuario que el administrador asignará al usuario (puede ser el ID de usuario en el servicio del administrador o el mismo userId utilizado en ID document o Knowledge-based)
​
authCf1
string
Información adicional que el administrador asignará al usuario (por ejemplo, dirección de correo electrónico, etc.)
​
authCf2
string
Información adicional que el administrador asignará al usuario (igual que authCf1)
​
authCf3
string
Información adicional que el administrador asignará al usuario (igual que authCf1)
​
token
string
Token que el administrador agregará a la URL con fines de seguridad.
¡Nota!: Este token opera de forma independiente del token preregistrado en modo privado.
El token está diseñado para asignar una URL única a cada usuario cuando se autentican a través de FaceAuth.
Para aplicar un token, debe habilitar la opción de configuración de condición de expiración de token en el proyecto FaceAuth, y funciona de la siguiente manera:
  • Expiración basada en conteo: Cuando el token se usa una vez, el Token ID expira inmediatamente.
  • Expiración basada en tiempo: Cuando ha transcurrido el tiempo desde el momento en que el token se usó una vez, el Token ID expira.
Este token opera de forma independiente del token de modo privado del proyecto principal o del token preregistrado.
Por ejemplo, puede especificar un tokenId arbitrario establecido por el administrador en el token, e incluso si reutiliza el token usado en el proyecto principal, funciona porque se gestiona por separado. Para una guía sobre cómo habilitar la opción de configuración de condición de expiración de token en el proyecto FaceAuth, consulte Add-on - FACE AUTH en la Guía de servicio.
Para casos aprobados donde no existe imagen selfie, se utilizará en su lugar la imagen de retrato del documento de identidad.

​
Endpoints de la API de Add-on

POST/FaceAuth

Envío de FaceAuth

GET/FaceAuth

Consulta de FaceAuth

GET/FaceAuth/Image

Consulta de imagen de FaceAuth

DELETE/FaceAuth

Eliminación de FaceAuth

​
Webhook

Faceauth

Webhook de FaceAuth

​
Clave API

La clave API de Add-on sirve para verificar y autenticar las solicitudes del cliente y del servidor, y es diferente de la clave API del proyecto. Verifica la información de autenticación del solicitante, y Argos Identity proporciona la respuesta adecuada según la solicitud.

​
Cómo verificar la clave API de Add-on

1

Iniciar sesión en el dashboard

Inicie sesión en el dashboard de ID Check.
2

Acceder al menú de configuración

Haga clic en el menú Add-on en la barra de navegación superior del dashboard.
3

Crear proyecto

Haga clic en el botón Create Project en la página de Add-on para crear un proyecto.
4

Crear proyecto

Después de crear el proyecto, haga clic en el botón Edit en la página de Add-on y verifique la clave API. Encuentre la sección de clave API y haga clic en el icono derecho para copiar y usar la clave API.

​
Códigos de estado de respuesta HTTP

Los códigos de respuesta HTTP indican el estado de las solicitudes. Cada código de respuesta sigue estas reglas:
  • 2xx Solicitudes exitosas
  • 4xx Errores del cliente
  • 5xx Errores del servidor
Código de estado HTTPMensajeDescripción
200OKLa solicitud se procesó correctamente.
400Invalid Query String parametersLa solicitud no pudo procesarse. Faltan parámetros obligatorios o el formato del parámetro es incorrecto. Verifique los parámetros de la solicitud nuevamente.
403User is not authorized to access this resource with an explicit denyAcceso denegado. La solicitud se realizó desde una IP que no está en la lista blanca.
403ForbiddenAcceso denegado. Es posible que se haya utilizado una clave API incorrecta.
413Request Entity Too LargeLa solicitud es demasiado grande. La solicitud contiene datos que superan el tamaño que el servidor puede procesar. Reduzca los datos de la solicitud e intente nuevamente.
500Internal Server ErrorSe produjo un error del servidor. Puede haber un problema con el servidor de Argos. Contacte al equipo de Argos.
502Bad GatewayEl servidor recibió una respuesta no válida del servidor upstream. Intente nuevamente más tarde o contacte al equipo de Argos.