Vectors

Description

The method compares biometric (photo) vectors with vectors of persons from the specified lists. A JWT token must be provided in the request header.

Request format

HTTP method: POST
URL: /vector/search
Content-Type: application/json
Authorization: required

Request parameters

Parameter	Type	Where passed	Required	Description
token	string	Header	✅	User JWT token

Request body (JSON)

Field	Type	Required	Description
token	string	✅	User JWT token
embeddings	string	✅	Biometric vector (or vector string)
list_ids	string	✅	Identifier(s) of the person lists to search in
threshold	string	❌	Match threshold
person_data	boolean	❌	Whether to return found person data
results	string	❌	Result format (e.g., «all», «top»)

Example request (cURL)

curl -X POST "https://api.enface.ai/vector/search" 
  -H "Content-Type: application/json" 
  -H "Authorization: Bearer jwt.temporary.token" 
  -d '{
    "token": "jwt.temporary.token",
    "embeddings": "0.123,0.456,0.789",
    "list_ids": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "threshold": "0.7",
    "person_data": true,
    "results": "top"
  }'

Response examples

Success (200 OK)

{
  "results": [
    {
      "additionalProp1": {}
    }
  ],
  "status": "ok"
}

Error (400 Invalid input)

{
  "message": "invalid input",
  "status": "error"
}