Skip to main content

Crear una Validación Biométrica

Endpoint​

POST https://api.verifik.co/v2/biometric-validations

Una Validación Biométrica es una instancia dentro del sistema de Verifik que te permite procesar y validar identidades de usuarios a través de reconocimiento facial y detección de vida. Este proceso asegura la autenticidad de los usuarios verificando sus características biométricas únicas mediante tecnología de seguridad avanzada.

Encabezados​

Content-Type​

Tipo: String
Requerido: Sí

application/json

Authorization​

Tipo: String
Requerido: Sí

Bearer {YOUR_ACCESS_TOKEN}

Parámetros​

project​

Tipo: String
Requerido: Sí

Identificador único del proyecto donde se utilizará esta validación biométrica.

projectFlow​

Tipo: String
Requerido: Sí

Identificador único de la configuración del flujo de proyecto.

identifier​

Tipo: String
Requerido: Sí

Identificador único para el usuario o sesión (ej. email, teléfono, o ID personalizado).

type​

Tipo: String
Requerido: Sí

Tipo de validación: validation, login, onboarding, o oneTimeLink.

expiresAt​

Tipo: String
Requerido: No

Fecha de expiración opcional para la sesión de validación.

redirectUrl​

Tipo: String
Requerido: No

URL opcional para redirección después de la validación.

webhookUrl​

Tipo: String
Requerido: No

URL de webhook opcional para notificaciones de validación.

requires2FA​

Tipo: Boolean
Requerido: No

Indicador opcional si se requiere autenticación de dos factores.

ipAddress​

Tipo: String
Requerido: No

Dirección IP opcional del usuario.

sendViaEmail​

Tipo: Boolean
Requerido: No

Indicador opcional para enviar enlace de validación por correo electrónico.

email​

Tipo: String
Requerido: No

Dirección de correo electrónico a la cual enviar el enlace de validación (requerido si sendViaEmail es true).

language​

Tipo: String
Requerido: No

Idioma para plantillas de correo electrónico (en/es). Por defecto "en".

Valores de type​

  • validation - Validación de identidad biométrica general.
  • login - Verificación biométrica durante autenticación de usuario.
  • onboarding - Verificación biométrica durante registro de usuario.

Solicitud​

const axios = require("axios");

const config = {
  method: "post",
  url: "https://api.verifik.co/v2/biometric-validations",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  },
  data: {
    project: "project_123456789",
    projectFlow: "flow_123456789",
    identifier: "user@example.com",
    type: "validation",
    expiresAt: "2024-01-15T11:30:00Z",
    redirectUrl: "https://example.com/success",
    webhookUrl: "https://example.com/webhook",
    requires2FA: false,
    ipAddress: "192.168.1.1",
    sendViaEmail: true,
    email: "user@example.com",
    language: "en"
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Respuesta​

{
  "success": true,
  "data": {
    "_id": "biometric_validation_123456789",
    "client": "client_123456789",
    "project": "project_123456789",
    "projectFlow": "flow_123456789",
    "status": "new",
    "identifier": "user@example.com",
    "type": "validation",
    "expiresAt": "2024-01-15T11:30:00Z",
    "redirectUrl": "https://example.com/success",
    "webhookUrl": "https://example.com/webhook",
    "requires2FA": false,
    "ipAddress": "192.168.1.1",
    "sendViaEmail": true,
    "email": "user@example.com",
    "language": "en",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

Respuestas de Error​

{
  "success": false,
  "error": "Flujo de proyecto inválido",
  "code": "INVALID_PROJECT_FLOW"
}