Listar los inicios de sesión en la app

Endpoint URL:

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

Descripción:

Este endpoint recupera una lista de intentos de inicio de sesión de AppLogin con información detallada sobre las validaciones de correo electrónico, teléfono y biometría. La respuesta incluye un array de datos que contiene información sobre los intentos de inicio de sesión y los tipos de validación asociados (email, phone, biometric).


Query Parameters:

Parameter Name
Type
Description

page

int

Specifies the page of the results to retrieve. Default is 1.

populates[]

array

An array specifying which validations to include (e.g., emailValidation, phoneValidation, biometricValidation).

sort

string

Field by which to sort the results. Default is by creation date (-createdAt).

where-exists_emailValidation

int

Filter results where email validation exists (1 to include).

where-exists_phoneValidation

int

Filter results where phone validation exists (1 to include).

where-exists_biometricValidation

int

Filter results where biometric validation exists (1 to include).

like_name

string

Search results by name (supports partial matching).

Sample Request:

GET /v2/app-logins?page=1&populates[]=emailValidation&populates[]=phoneValidation&populates[]=biometricValidation&sort=-createdAt

Sample Request (Node.js - Axios):

const axios = require('axios');

let config = {
  method: 'get',
  url: 'https://api.verifik.co/v2/app-logins?page=1&populates[]=emailValidation&populates[]=phoneValidation&populates[]=biometricValidation&sort=-createdAt',
  headers: { 
    'Authorization': 'Bearer YOUR_API_KEY'
  }
};

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

Campos de Respuesta:

  • _id: Identificador único del intento de inicio de sesión.

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

  • name: Nombre del cliente o de la 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 o biometric).

  • emailValidation: Objeto que contiene información sobre la validación por correo electrónico (opcional).

  • phoneValidation: Objeto que contiene información sobre la validación por teléfono (opcional).

  • biometricValidation: Objeto que contiene información sobre la validación biométrica (opcional).

  • accessControlLog: Registro de los intentos de control de acceso asociados con este inicio de sesión (opcional).

  • 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.

Responses

{
    "data": [
        {
            "_id": "66e49e46dbfa9731ceb9d477",
            "client": "613375a1eab2fe08527f81e2",
            "name": "Verifik Main Account",
            "status": "validated",
            "project": "6266193db77ccc8111730c90",
            "projectFlow": "658ed28b0990f300134d7b78",
            "type": "email",
            "emailValidation": {
                "_id": "66e49e45dbfa9731ceb9d475",
                "client": "613375a1eab2fe08527f81e2",
                "project": "6266193db77ccc8111730c90",
                "projectFlow": "658ed28b0990f300134d7b78",
                "status": "validated",
                "validationMethod": "verificationCode",
                "email": "[email protected]",
                "emailData": {
                    "firstName": "Verifik Main Account",
                    "title": "Verifik Client App",
                    "projectName": "Verifik Client App",
                    "contactEmail": "[email protected]",
                    "logo": "https://cdn.verifik.co/projects/VerifikClientApp_1726146056389-image.png",
                    "authLink": "http://localhost:4400/sign-in/[email protected]&otp=",
                    "buttonColor": "#14AE5C",
                    "buttonTxtColor": "#FFF"
                },
                "otp": "$2a$10$mMYT2vE6sx3J898UOPDeFeADuXYE3Gktkx9DwVUmDr0uiAu1qdp.y",
                "expiresAt": "2024-09-13T20:29:17.000Z",
                "extraParams": [],
                "type": "login",
                "redirectUrl": "https://verifik.app",
                "requires2FA": false,
                "ipAddress": "::ffff:172.17.0.1",
                "updatedAt": "2024-09-13T20:19:47.927Z",
                "createdAt": "2024-09-13T20:19:18.660Z",
                "__v": 0
            }
        }
    ]
}

Last updated