List All Document Validations

Endpoint

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

This endpoint allows you to retrieve a list of all Document Validations within the Verifik API. You can use this to get a detailed overview of multiple document validations, including their status, associated project, validation methods, and more.

Headers

Content-Type

Type: String
Required: Yes

application/json

Authorization

Type: String
Required: Yes

Bearer <token>

Query Parameters

page

Type: number
Required: No

Specifies the page number for pagination, starting from 1.

perPage

Type: number
Required: No

Defines the number of items per page for pagination.

populates[]

Type: string
Required: No

Populates the specified field, transforming ObjectId references into full objects. Available options: appRegistration, projectFlow

where_status

Type: string
Required: No

Where condition to filter by status. Options: ASSESSING, ACTIVE, FAILED, NEEDS_MANUAL_VERIFICATION, NOT_FOUND, EXPIRED, ACTIVE_BUT_UNVERIFIED

where_documentType

Type: string
Required: No

Filter by document type (e.g., "driver_license", "passport", "national_id")

where_validationMethod

Type: string
Required: No

Filter by validation method. Options: MANUAL, OCR, SCAN_PROMPT, SCAN_STUDIO

where_type

Type: string
Required: No

Filter by validation type. Options: validation, login, signup, ocr, demo

where_inputMethod

Type: string
Required: No

Filter by input method. Options: CAMERA, FILE_UPLOAD, NOT_SET

Request

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

Response

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"
}

  </TabItem>
</Tabs>

### Features

- **Complete Listing**: Retrieve all document validations from your account
- **Advanced Pagination**: Control page and items per page
- **Complete Filtering**: Filter by status, document type, validation method, and more
- **Data Population**: Include related information like application registrations and project flows
- **Multiple States**: Filter by different validation states
- **Document Types**: Support for driver's licenses, passports, national IDs
- **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