Search User

Performs a Facial Recognition 1:N search within the collection. Returns the matching users who meet the configured similarity threshold.

Endpoint

POST /users/search

Authentication

Type	Location	Name
API Key	Header	x-api-key

Request body

Content-Type: application/json

Parameters

Parameter	Type	Required	Description
face	string	Yes	Image of the user's face encoded in Base64 or tokenized. For open images, the supported formats are JPEG and PNG. Maximum supported size: 5MB.
threshold	number	No	Value that specifies the minimum confidence in the facial match to return a result. The default value is 80%.

Request example

{
  "face": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
  "threshold": 75.5
}

Responses

200 Success

Response parameters

Parameter	Type	Description
matches	array	Array of matching users ordered by similarity score from highest to lowest.
matches[].userId	string	Unique identifier of the matching user.
matches[].similarity	number	Similarity score between 0 and 100, indicating the confidence of the match.

Response example

{
  "matches": [
    {
      "userId": "f7eab18f-e5d3-4dac-9d4d-cfb969ef848e",
      "similarity": 99.99953
    }
  ]
}

400 Bad Request

{
  "status": 400,
  "title": "Bad Request",
  "detail": "Invalid request.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
  "errors": []
}

401 Unauthorized

{
  "message": "Unauthorized"
}

403 Forbidden

{
  "Message": "User is not authorized to access this resource with an explicit deny"
}

404 Not Found

{
  "status": 404,
  "title": "Not Found",
  "detail": "The server can't find the requested resource.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404"
}