API Docs

Introduction

An API (Application Programming Interface) is a set of rules that allows different software applications to communicate and share data with each other. It acts as a bridge, translating requests and delivering responses between systems.

How VisoID works

Before starting the integration with our API, create a project in PROJECTS > NEW PROJECT after logging in.

In each project, there is a bucket or collection where the vectors of the faces will be stored. We do not store the submitted images; only the biometric vectors will be recorded.

The API-KEY is unique and exclusive to project.

The EXTERNAL_ID field is unique per project, but controlling vector duplication is your responsibility.

If you need a web interface for facial detection, check The MediaPipe Face Detector at the link: https://ai.google.dev/edge/mediapipe/solutions/vision/face_detector/web_js

Counted Requests

METHOD	ENDPOINT	DESCRIPTION
POST	/api/face/detect	Check the faces count in the image.
POST	/api/face	Use this to record face data and vectors.
POST	/api/face/search	Search for registered faces by imagem.

URL

Use the URL https://visoid.pro in your API requests.

Authentication

The API uses authentication based on a simple API-KEY on header. All requests must include the API-KEY and Accept application/json header.

API-KEY: {project_api_key}

Accept: application/json

Success / Error

HTTP Status Code Summary

CODE	MESSAGE	DESCRIPTION	METHOD
200	OK	Everything worked as expected on lists and searches	GET PUT
201	CREATED	The request was successful and a new resource was created as a result	POST
202	ACCEPTED	The request was received and the resource was deleted	DELETE
400	BAD REQUEST	The server cannot or will not process the request due to what is perceived as a client error	POST PUT GET DELETE
401	UNAUTHORIZED	Authentication error or missing API KEY	POST PUT GET DELETE
403	FORBIDDEN	Restricted exclusion or insertion	POST PUT GET DELETE
404	NOT FOUND	The server cannot find the requested resource	POST PUT GET DELETE
422	UNPROCESSABLE CONTENT	Required fields validation error.	POST PUT GET DELETE
500	INTERNAL SERVER ERROR	The server hit an unexpected problem that prevented it from completing the request	POST PUT GET DELETE

ATTENTION: The responses are in JSON format and most often include a message property.

{
    "message":"Description of the error or success"
}

Common Errors

Errors that can occur in any API request.

401 Response - The API-KEY header was not included in the request.

{
    "message": "API KEY expected in the header"
}

403 Response - The API-KEY does not correspond to any project.

{
    "message": "Project not found"
}