Retrieve a Document Liveness Validation

Endpoint

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

With this service, you can retrieve all document liveness validations that you have processed, or if you only want one, you can specify the document liveness record ID and the endpoint will return only the selected validation result.

Headers

Content-Type

Type: String
Required: Yes

application/json

Authorization

Type: String
Required: Yes

Bearer <token>

Query Parameters

id

Type: string
Required: Yes

ID of the Document Liveness record from which you want to retrieve the information.

Request

Node.js

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.verifik.co/v2/document-liveness/document_liveness_123456789',
  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-liveness/document_liveness_123456789", 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-liveness/document_liveness_123456789', [
  'headers' => [
    'Content-Type' => 'application/json',
    'Authorization' => 'Bearer <your_token>',
  ]
]);

echo $response->getBody();

Go

package main

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

func main() {
  url := "https://api.verifik.co/v2/document-liveness/document_liveness_123456789"

  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

{
  "success": true,
  "data": {
    "_id": "document_liveness_123456789",
    "client": "client_123456789",
    "appRegistration": "app_registration_123456789",
    "imageSaved": true,
    "imageUrl": "https://cdn.verifik.co/images/document_123456789.jpg",
    "status": "completed",
    "validationResults": {
      "screenReplay": {
        "passed": true,
        "score": 0.95,
        "details": "No screen replay detected"
      },
      "printedCopy": {
        "passed": true,
        "score": 0.90,
        "details": "No printed copy detected"
      },
      "portraitSubstitution": {
        "passed": true,
        "score": 0.88,
        "details": "No portrait substitution detected"
      },
      "digitalManipulation": {
        "passed": true,
        "score": 0.92,
        "details": "No digital manipulation detected"
      }
    },
    "calibrationSettings": {
      "screenReplayCalibration": "REGULAR",
      "printedCopyCalibration": "REGULAR",
      "portraitSubstitutionCalibration": "REGULAR"
    },
    "validationFlags": {
      "ignoreDocumentCroppedValidation": false,
      "ignoreColourLessValidation": false
    },
    "riskScore": 0.05,
    "confidence": 0.91,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:32:00Z",
    "completedAt": "2024-01-15T10:32:00Z"
  },
  "signature": {
    "dateTime": "April 11, 2023 12:25 PM",
    "message": "Certified by Verifik.co"
  }
}

404

{
  "error": "Document liveness not found",
  "message": "DOCUMENT_LIVENESS_NOT_FOUND"
}

  </TabItem>
</Tabs>

### Features

- **Retrieval by ID**: Get a specific liveness validation using its unique ID
- **Detailed Results**: Complete information of all anti-spoofing validations
- **Calibration Settings**: SOFT, REGULAR, and HARD settings used
- **Validation Flags**: Settings to ignore cropping and lack of color
- **Confidence Scores**: Detailed scores for each validation type
- **Image Storage**: Information about images saved to CDN
- **Client Data**: Client and application registration information
- **Multiple Languages**: Support for JavaScript, Python, PHP, and Swift
- **Error Handling**: Detailed error responses for different scenarios