Retrieve a document validation

Endpoint

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

Retrieve information about a specific Document Validation within Verifik’s system. This endpoint provides detailed data regarding the validation status, project associations, and document metadata.

Headers

Include the necessary authentication headers for authorization and content-type, such as:

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

Request Parameters

• Path Parameter:

  • id (string, required): The unique identifier for the DocumentValidation you want to retrieve.

Request

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);
  });

Response

On a successful request, you will receive a JSON object with the details of the specified Document Validation. Key fields include the document type, status, associated project and project flow, and validation metadata.

Success Response (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"
}

Error Responses

Status Code	Description
404	DocumentValidation not found