Face Search (1:N)

Endpoint

https://api.verifik.co/v2/face-recognition/search

Searches one or more images against a face collection and returns potential matches ranked by similarity.

Headers

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

Params

Name	Type	Required	Description
images	string[]	Yes	Array of base64 images (max suggested: 3) of the same person.
collection_id	string	No	Restrict search to this collection.
max_results	number	No	Maximum results to return.
min_score	number	Yes	Match threshold (0.2–1.0).
search_mode	string	Yes	One of FAST or ACCURATE.

Request

Node.js

const fetch = require("node-fetch");

async function run() {
  const res = await fetch("https://api.verifik.co/v2/face-recognition/search", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${process.env.VERIFIK_TOKEN}`,
    },
    body: JSON.stringify({
      images: ["<base64>"],
      collection_id: "<collection_id>",
      min_score: 0.7,
      search_mode: "FAST",
      max_results: 10
    }),
  });
  console.log(await res.json());
}

run();

PHP

<?php
$ch = curl_init("https://api.verifik.co/v2/face-recognition/search");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: Bearer " . getenv("VERIFIK_TOKEN")
]);
$body = json_encode([
    "images" => ["<base64>"],
    "collection_id" => "<collection_id>",
    "min_score" => 0.7,
    "search_mode" => "ACCURATE",
    "max_results" => 10
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Python

import os, requests

url = "https://api.verifik.co/v2/face-recognition/search"
headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {os.getenv('VERIFIK_TOKEN')}"
}
payload = {
    "images": ["<base64>"],
    "collection_id": "<collection_id>",
    "min_score": 0.7,
    "search_mode": "FAST",
    "max_results": 10
}
r = requests.post(url, json=payload, headers=headers)
print(r.json())

Go

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
    "os"
)

func main() {
    payload := map[string]interface{}{
        "images": []string{"<base64>"},
        "collection_id": "<collection_id>",
        "min_score": 0.7,
        "search_mode": "ACCURATE",
        "max_results": 10,
    }
    b, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST", "https://api.verifik.co/v2/face-recognition/search", bytes.NewBuffer(b))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer "+os.Getenv("VERIFIK_TOKEN"))
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    var out map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&out)
    fmt.Println(out)
}

Response

200

{
  "id": "SRCH1",
  "data": [
    {
      "id": "person_id",
      "name": "John Doe",
      "score": 0.93,
      "thumbnails": [{ "id": "thumb_id", "thumbnail": "<base64>" }]
    }
  ],
  "signature": {
    "message": "Certified by Verifik.co",
    "dateTime": "January 16, 2024 3:44 PM"
  }
}

401

{
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

403

{
  "message": "token_expired",
  "code": "FORBIDDEN"
}

409

{
  "message": "\"min_score\" is required",
  "code": "MissingParameter"
}

500

{
  "message": "internal_error",
  "code": "ERROR"
}

Notes

• Provide 1–3 images of the same person in images for better recall.
• Use ACCURATE for higher precision at the cost of latency; use FAST for speed.