List all document validations

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

---

List Document Validations

Endpoint

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

Retrieve a list of Document Validation records in Verifik’s system. This endpoint returns an array of document validation objects, each containing detailed information about the validation status, document attributes, and associated projects.

Headers

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

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

Query Params

Here’s a table format for the query parameters used in this API call. This will clearly show what each populate parameter does by converting ObjectId references into the corresponding objects.

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

Request

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

Response

On a successful request, you will receive a JSON array containing document validation objects. Each object includes details such as document type, status, associated project, and validation metadata.

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...
  ]
}