Listar todas las Validaciones de Documentos

Endpoint

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

Este endpoint te permite obtener un listado de todas las Validaciones de Documentos dentro de la API de Verifik. Úsalo para obtener una vista detallada de múltiples validaciones, incluyendo su estado, proyecto asociado, métodos de validación y más.

Encabezados

Content-Type

Tipo: String
Requerido: Sí

application/json

Authorization

Tipo: String
Requerido: Sí

Bearer <token>

Parámetros de Consulta

page

Tipo: number
Requerido: No

Especifica el número de página para la paginación, comenzando desde 1.

perPage

Tipo: number
Requerido: No

Define la cantidad de elementos por página para la paginación.

populates[]

Tipo: string
Requerido: No

Realiza populate del campo especificado, transformando referencias por id en objetos completos. Opciones disponibles: appRegistration, projectFlow

where_status

Tipo: string
Requerido: No

Condición para filtrar por estado. Opciones: ASSESSING, ACTIVE, FAILED, NEEDS_MANUAL_VERIFICATION, NOT_FOUND, EXPIRED, ACTIVE_BUT_UNVERIFIED

where_documentType

Tipo: string
Requerido: No

Filtra por tipo de documento (por ejemplo, "driver_license", "passport", "national_id")

where_validationMethod

Tipo: string
Requerido: No

Filtra por método de validación. Opciones: MANUAL, OCR, SCAN_PROMPT, SCAN_STUDIO

where_type

Tipo: string
Requerido: No

Filtra por tipo de validación. Opciones: validation, login, signup, ocr, demo

where_inputMethod

Tipo: string
Requerido: No

Filtra por método de ingreso. Opciones: CAMERA, FILE_UPLOAD, NOT_SET

Solicitud

Node.js

import axios from "axios";

const options = {
    method: "GET",
    url: "https://api.verifik.co/v2/document-validations",
    params: {
        page: 1,
        perPage: 10,
        "populates[]": ["appRegistration", "projectFlow"],
        where_status: "ACTIVE",
        where_documentType: "driver_license",
        where_validationMethod: "OCR",
    },
    headers: {
        "Content-Type": "application/json",
        Authorization: "Bearer <your_token>",
    },
};

try {
    const { data } = await axios.request(options);
    console.log(data);
} catch (error) {
    console.error(error);
}

Python

import http.client

conn = http.client.HTTPSConnection("api.verifik.co")

headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <your_token>'
}

conn.request("GET", "/v2/document-validations?page=1&perPage=10&populates[]=appRegistration&populates[]=projectFlow&where_status=ACTIVE&where_documentType=driver_license&where_validationMethod=OCR", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.verifik.co/v2/document-validations', [
  'headers' => [
    'Content-Type' => 'application/json',
    'Authorization' => 'Bearer <your_token>',
  ],
  'query' => [
    'page' => 1,
    'perPage' => 10,
    'populates[]' => ['appRegistration', 'projectFlow'],
    'where_status' => 'ACTIVE',
    'where_documentType' => 'driver_license',
    'where_validationMethod' => 'OCR'
  ]
]);

echo $response->getBody();

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.verifik.co/v2/document-validations?page=1&perPage=10&populates[]=appRegistration&populates[]=projectFlow&where_status=ACTIVE&where_documentType=driver_license&where_validationMethod=OCR"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer <your_token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}

Respuesta

200

{
    "data": [
        {
            "_id": "document_validation_123456789",
            "age": "25",
            "appRegistration": {
                "_id": "reg_123456789",
                "email": "user@example.com",
                "status": "completed"
            },
            "backUrl": "https://example.com/back",
            "client": "client_123456789",
            "country": "US",
            "createdAt": "2024-01-15T10:30:00Z",
            "documentData": {
                "firstName": "John",
                "lastName": "Doe",
                "documentNumber": "123456789",
                "birthDate": "1999-01-15"
            },
            "documentType": "driver_license",
            "frontUrl": "https://example.com/front",
            "project": "project_123456789",
            "projectFlow": {
                "_id": "flow_123456789",
                "name": "Example Flow",
                "type": "onboarding"
            },
            "status": "ACTIVE",
            "updatedAt": "2024-01-15T10:32:00Z",
            "validationResults": {
                "documentAuthenticity": "passed",
                "dataConsistency": "passed"
            }
        }
    ],
    "pagination": {
        "page": 1,
        "perPage": 10,
        "total": 1,
        "pages": 1
    },
    "signature": {
        "dateTime": "April 11, 2023 12:25 PM",
        "message": "Certified by Verifik.co"
    }
}

400

{
    "error": "Invalid query parameters",
    "message": "INVALID_PARAMETERS"
}

Características

• Listado completo: Recupera todas las validaciones de documentos de tu cuenta
• Paginación avanzada: Controla la página y los elementos por página
• Filtrado completo: Filtra por estado, tipo de documento, método de validación y más
• Población de datos: Incluye información relacionada como registros de aplicación y flujos de proyecto
• Múltiples estados: Filtra por diferentes estados de validación
• Tipos de documento: Soporte para licencias de conducir, pasaportes y cédulas nacionales
• Métodos de validación: OCR, manual, escaneo y más
• Múltiples lenguajes: Soporte para JavaScript, Python, PHP y Go
• Información detallada: Incluye datos del documento, resultados de validación y marcas de tiempo
• Validation Methods: OCR, manual, scanning, and more
• Multiple Languages: Support for JavaScript, Python, PHP, and Swift
• Detailed Information: Includes document data, validation results, and timestamps