Retrieve a Biometric Validation

Endpoint

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

A Biometric Validation is an instance within Verifik's system that allows you to process and validate user identities through facial recognition and liveness detection. This endpoint retrieves a specific biometric validation record by its unique identifier, including all associated data and relationships.

Headers

Authorization

Type: String
Required: Yes

Bearer {YOUR_ACCESS_TOKEN}

Path Parameters

id

Type: String
Required: Yes

The unique identifier of the biometric validation to retrieve.

Query Parameters

populates[]

Type: Array
Required: No

Fields to populate with related data.

Example: populates[]=client&populates[]=project

sort

Type: String
Required: No

Sort order for results. Prefix with - for descending.

Example: sort=-createdAt

limit

Type: Number
Required: No

Maximum number of results to return.

Example: limit=10

where_client

Type: String
Required: No

Filter by client ID.

Example: where_client=507f1f77bcf86cd799439013

where_project

Type: String
Required: No

Filter by project ID.

Example: where_project=507f1f77bcf86cd799439011

where_projectFlow

Type: String
Required: No

Filter by project flow ID.

Example: where_projectFlow=507f1f77bcf86cd799439015

where_status

Type: String
Required: No

Filter by validation status.

Example: where_status=validated

where_type

Type: String
Required: No

Filter by validation type.

Example: where_type=login

where_livenessSession

Type: String
Required: No

Filter by liveness session ID.

Example: where_livenessSession=674de8df21c72be3cc42b8a7

Request

Request

Node.js

const axios = require("axios");

const config = {
  method: "get",
  url: "https://api.verifik.co/v2/biometric-validations/biometric_validation_123456789",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  },
  params: {
    "populates[]": ["client", "project", "projectFlow"],
    "sort": "-createdAt",
    "limit": 10
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Python

import requests

url = "https://api.verifik.co/v2/biometric-validations/biometric_validation_123456789"

params = {
  'populates[]': ['client', 'project', 'projectFlow'],
  'sort': '-createdAt',
  'limit': 10
}

headers = {
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
}

response = requests.request("GET", url, headers=headers, params=params)

print(response.text)

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.verifik.co/v2/biometric-validations/biometric_validation_123456789?populates[]=client&populates[]=project&populates[]=projectFlow&sort=-createdAt&limit=10',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer YOUR_ACCESS_TOKEN'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
?>

Go

package main

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

func main() {
  url := "https://api.verifik.co/v2/biometric-validations/biometric_validation_123456789?populates[]=client&populates[]=project&populates[]=projectFlow&sort=-createdAt&limit=10"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}

Response

{
  "success": true,
  "data": {
    "_id": "biometric_validation_123456789",
    "client": {
      "_id": "client_123456789",
      "name": "Example Client",
      "email": "client@example.com"
    },
    "project": {
      "_id": "project_123456789",
      "name": "Example Project",
      "description": "Example project description"
    },
    "projectFlow": {
      "_id": "flow_123456789",
      "name": "Example Flow",
      "type": "onboarding"
    },
    "livenessSession": "liveness_123456789",
    "appRegistration": "reg_123456789",
    "status": "completed",
    "identifier": "user@example.com",
    "type": "validation",
    "expiresAt": "2024-01-15T11:30:00Z",
    "redirectUrl": "https://example.com/success",
    "webhookUrl": "https://example.com/webhook",
    "requires2FA": false,
    "ipAddress": "192.168.1.1",
    "sendViaEmail": true,
    "email": "user@example.com",
    "language": "en",
    "biometricData": {
      "faceImage": "base64_encoded_image",
      "template": "biometric_template_data",
      "quality": "good",
      "livenessScore": 0.95
    },
    "verificationResults": {
      "livenessDetection": "passed",
      "identityMatch": "passed",
      "qualityScore": 0.95,
      "antiSpoofing": "passed"
    },
    "riskScore": 0.05,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:32:00Z",
    "completedAt": "2024-01-15T10:32:00Z"
  }
}

Error Responses

{
  "success": false,
  "error": "Biometric validation not found",
  "code": "BIOMETRIC_VALIDATION_NOT_FOUND"
}