Recuperar una validación de documento

Endpoint

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

Recupera información sobre una validación de documento específica dentro del sistema de Verifik. Este endpoint proporciona datos detallados sobre el estado de validación, asociaciones de proyectos y metadatos del documento.

Headers

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 solicitud

• Parámetro de ruta:

  • id (string, requerido): El identificador único de la DocumentValidation que deseas recuperar.

Solicitud

cURL

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

Node.js

const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://api.verifik.co/v2/document-validations/{id}',
  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 objeto JSON con los detalles de la Document Validation especificada. Los campos clave incluyen el tipo de documento, estado, proyecto asociado y flujo del proyecto, así como los metadatos de validación.

Respuesta exitosa (200)

200

{
  "data": {
    "_id": "6720ff1880ba4745a18494ba",
    "documentNumber": "1.058.843.805",
    "documentType": "CC",
    "project": "671ae085c963a3247fda57c4",
    "projectFlow": "671ae0b3c963a3247fda57cb",
    "url": "https://cdn.verifik.co/ocr/671a7f594e3bb7129d1d89af/1730216595675-image.jpeg",
    "status": "ACTIVE_BUT_UNVERIFIED",
    "imageValidated": true,
    "validationMethod": "SCAN_PROMPT",
    "inputMethod": "NOT_SET",
    "namesMatch": true,
    "firstNameMatchPercentage": 100,
    "lastNameMatchPercentage": 100,
    "OCRExtraction": {
      "dateOfBirth": "27-DIC-1988",
      "placeOfBirth": "PENSILVANIA (CALDAS)",
      "height": "1.62",
      "bloodType": "O+",
      "gender": "Female"
    },
    "scoreValidated": true,
    "scoreValidation": {}
  }
}

404

{
    "code": "NotFound",
    "message": "DocumentValidation_not_found"
}

Respuestas de error

Status Code	Description
404	DocumentValidation not found