Create Biometric Validation (Crear Validación Biométrica)

Endpoint

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

Este endpoint se utiliza para crear una nueva validación biométrica. La validación biométrica se usa para controlar todo el proceso de búsqueda de una persona en el proyecto (1:N) y luego autenticar o registrar (onboarding) al usuario según el flujo que esté intentando realizar. Crear una validación biométrica puede incluir el tipo de proceso, como login o onboarding.

Params

Parameter	Type	Description	Required
project	string	The unique identifier for the project.	Yes
projectFlow	string	The unique identifier for the project flow.	Yes
identifier	string	The unique identifier for the client (user) being validated.	Yes
type	string	The type of biometric validation (e.g., "login").	Yes

Request

cURL

curl --location --request POST 'https://api.verifik.co/v2/biometric-validations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "project": "66df5bf5c4d855fb0bdf5da2",
    "projectFlow": "66df5c22c4d855fb0bdf5da9",
    "identifier": "03da12fba",
    "type": "login"
}'

Node.js

const axios = require('axios');

let data = JSON.stringify({
  "project": "66df5bf5c4d855fb0bdf5da2",
  "projectFlow": "66df5c22c4d855fb0bdf5da9",
  "identifier": "03da12fba",
  "type": "login"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.verifik.co/v2/biometric-validations',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <token>'
  },
  data : data
};

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

Response

200

{
    "data": {
        "livenessSession": {
            "client": "613375a1eab2fe08527f81e2",
            "project": "66df5bf5c4d855fb0bdf5da2",
            "projectFlow": "66df5c22c4d855fb0bdf5da9",
            "identifier": "03da12fba",
            "status": "active",
            "livenessResult": [],
            "comparisonResult": [],
            "generalInformation": [],
            "documentTypeFields": [],
            "location": [],
            "proFields": [],
            "studioFields": [],
            "promptFields": [],
            "expiresAt": "2024-09-12T17:30:26.000Z",
            "_id": "66e3244269cd15b505d21063",
            "activatedAt": "2024-09-12T17:26:26.954Z",
            "updatedAt": "2024-09-12T17:26:26.964Z",
            "createdAt": "2024-09-12T17:26:26.964Z",
            "__v": 0
        },
        "biometricValidation": {
            "client": "613375a1eab2fe08527f81e2",
            "project": "66df5bf5c4d855fb0bdf5da2",
            "projectFlow": "66df5c22c4d855fb0bdf5da9",
            "livenessSession": "66e3244269cd15b505d21063",
            "status": "new",
            "type": "login",
            "url": "https://app.verifik.co/sign-in/66df5bf5c4d855fb0bdf5da2?type=liveness",
            "livenessScore": 0,
            "assignedCollection": "66df5bf5c4d855fb0bdf5da4",
            "collectionCode": "d29fe454-3ecc-4f58-8666-4021ac575d9c",
            "requires2FA": false,
            "_id": "66e3244369cd15b505d21065",
            "updatedAt": "2024-09-12T17:26:27.068Z",
            "createdAt": "2024-09-12T17:26:27.068Z",
            "__v": 0
        },
        "token": "eyJhbGciOiJIUzI1kpXVCJ9.eyJsaXZlbmVO3j1...1ewV1cNFR8je4U"
    }
}

409

{
    "code": "MissingParameter",
    "message": "type must be one of: [validation,login,onboarding,oneTimeLink]"
}

Detalles de la Respuesta

LivenessSession: Datos de la sesión de liveness creada como parte de esta validación biométrica.

• client: Identificador único del cliente.

• project: ID del proyecto asociado con la validación biométrica.

• projectFlow: ID del flujo de proyecto.

• identifier: Identificador único de la sesión.

• status: Estado de la sesión de liveness (por ejemplo, "active").

• livenessResult: Resultados de la verificación de liveness (array).

• comparisonResult: Resultados de las comparaciones biométricas (array).

• generalInformation: Información general relacionada con la sesión (array).

• expiresAt: Marca de tiempo de expiración de la sesión.

• activatedAt: Marca de tiempo de activación de la sesión.

• updatedAt: Marca de tiempo de la última actualización.

• createdAt: Marca de tiempo de la creación.

• _id: Identificador único de la sesión de liveness.

Validación Biométrica

• biometricValidation: Datos de la validación biométrica.

• client: ID del cliente asociado con esta validación.

• project: ID del proyecto asociado con esta validación.

• projectFlow: ID del flujo de proyecto asociado con esta validación.

• livenessSession: ID de la sesión de liveness asociada.

• status: Estado de la validación biométrica (por ejemplo, "new").

• type: Tipo de validación (por ejemplo, "login").

• url: URL relacionada con la validación biométrica, típicamente para la verificación de liveness.

• livenessScore: Puntaje obtenido en la verificación de liveness.

• assignedCollection: ID de la colección asignada a esta validación.

• collectionCode: Código único de la colección.

• requires2FA: Booleano que indica si la validación requiere 2FA (Autenticación de Dos Factores).

• createdAt: Marca de tiempo de la creación de la validación.

• updatedAt: Marca de tiempo de la última actualización de la validación.

• _id: Identificador único de la validación biométrica.

token: Token JWT asociado con la sesión de liveness, que contiene información de expiración y otros datos.