Recuperar inicio de sesión en la app

Endpoint URL:

GET https://api.verifik.co/v2/app-logins/{id}

Descripción:

Este endpoint recupera un registro único de AppLogin mediante su ID, junto con campos opcionales poblados, como emailValidation (validación por correo electrónico), phoneValidation (validación por teléfono), biometricValidation (validación biométrica).

URL Parameters:

Parameter Name
Type
Description

id

string

The unique ID of the app login record you want to retrieve.


Query Parameters:

Parameter Name
Type
Description

populates[]

array

An array specifying which validation fields to populate (e.g., biometricValidation).


Sample Request:

GET /v2/app-logins/66e464acbad79f3a380d408f?populates[]=biometricValidation

Sample Request (Node.js - Axios):

const axios = require('axios');

let config = {
  method: 'get',
  url: 'https://api.verifik.co/v2/app-logins/66e464acbad79f3a380d408f?populates[]=biometricValidation',
  headers: { 
    'Authorization': 'Bearer YOUR_API_KEY'
  }
};

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

Responses

{
    "data": {
        "_id": "66e464acbad79f3a380d408f",
        "client": "613375a1eab2fe08527f81e2",
        "name": "",
        "status": "pending",
        "project": "6266193db77ccc8111730c90",
        "projectFlow": "658ed28b0990f300134d7b78",
        "type": "faceliveness",
        "biometricValidation": "66e464acbad79f3a380d408d",
        "accessControlLog": "66e464acbad79f3a380d4090",
        "updatedAt": "2024-09-13T16:13:32.942Z",
        "createdAt": "2024-09-13T16:13:32.942Z",
        "__v": 0
    }
}

Campos de Respuesta:

  • data: Objeto que contiene el registro de AppLogin.

  • _id: Identificador único del AppLogin.

  • client: ID del cliente asociado con este inicio de sesión.

  • name: Nombre del cliente o aplicación.

  • status: Estado del intento de inicio de sesión (pending, validated, etc.).

  • project: ID del proyecto asociado con el inicio de sesión.

  • projectFlow: ID del Project Flow para el seguimiento del proceso.

  • type: Tipo de validación realizada (email, phone, biometric).

  • emailValidation: ID de referencia para el registro de validación por correo electrónico.

  • phoneValidation: ID de referencia para el registro de validación por teléfono.

  • biometricValidation: ID de referencia para el registro de validación biométrica.

  • accessControlLog: ID de referencia para el registro de control de acceso.

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

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

  • __v: Clave de versión del documento.


Last updated