List all document validations (Lista de documentos de validación)

Here's the documentation for the List Document Validations API endpoint, formatted in a similar structure to the screenshots you provided:

---

Listar Validaciones de Documentos

Endpoint

GET - https://api.verifik.co/v2/document-validations

Recupera una lista de registros de validación de documentos en el sistema de Verifik. Este endpoint devuelve un array de objetos de validación de documentos, cada uno conteniendo información detallada sobre el estado de validación, atributos del documento y proyectos asociados.

Encabezados Incluye los encabezados de autenticación necesarios para la autorización y el tipo de contenido, como:

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Parámetros de consulta Aquí hay un formato de tabla para los parámetros de consulta utilizados en esta llamada API. Esto mostrará claramente lo que hace cada parámetro populate al convertir referencias ObjectId en los objetos correspondientes.

Parameter	Value	Description
page	1	Specifies the page number for pagination, starting from 1.
perPage	20	Defines the number of items per page for pagination.
populates[]=project	project	Populates the project field, providing the full project details such as branding, allowed countries, and status, instead of just an ObjectId.
populates[]=projectFlow	projectFlow	Populates the projectFlow field, transforming the ObjectId into the full project flow object containing the flow setup and related details.
where_status=<status>	ONGOING	Where condition to filter by status where the options are specified here

Solicitud

bashCopiarEditar

cURL

curl --location 'https://api.verifik.co/v2/document-validations' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Node.js

const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://api.verifik.co/v2/document-validations',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
  }
};

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

Respuesta En una solicitud exitosa, recibirás un array JSON que contiene objetos de validación de documentos. Cada objeto incluye detalles como el tipo de documento, estado, proyecto asociado y metadatos de validación.

200

{
  "data": [
    {
      "requiresBackSide": true,
      "_id": "62a03c32b541ca63ff72424a",
      "documentNumber": "123456789",
      "documentType": "DLXX",
      "documentCategory": "DriverLicense",
      "country": "Brazil",
      "nationality": "Brazilian",
      "age": "29",
      "gender": "Female",
      "project": "62ae085c963a3247fda57c4",
      "projectFlow": "62ae0b3c963a3247fda57cb",
      "url": "https://cdn.verifik.co/ocr/samples/random-license.jpg",
      "status": "ACTIVE_BUT_UNVERIFIED",
      "imageValidated": false,
      "validationMethod": "OCR_SCAN",
      "inputMethod": "CAMERA",
      "namesMatch": false,
      "fullNameMatchPercentage": 0,
      "firstNameMatchPercentage": 0,
      "lastNameMatchPercentage": 0,
      "OCRExtraction": {
        "firstName": "MARIA",
        "lastName": "SILVA RODRIGUES",
        "fullName": "MARIA SILVA RODRIGUES",
        "documentNumber": "123456789",
        "CURP": "SIRB900715HBSLND03",
        "dateOfBirth": "20/JUN/1994",
        "expirationDate": "12/DEC/2026",
        "licenseType": "PERMANENTE",
        "age": 29,
        "gender": "Female",
        "country": "Brazil",
        "documentType": "DLXX"
      },
      "scoreValidated": false,
      "type": "signup",
      "appRegistration": "62b03bdfb541ca63ff7241f3",
      "client": "62a7f594e3bb7129d1d89af",
      "updatedAt": "2024-10-29T01:36:50.999Z",
      "createdAt": "2024-10-29T01:36:50.999Z",
      "__v": 0
    }
    // Additional document validations...
  ]
}