Skip to content
Biometry

API Calls

API Calls Overview

The Biometry API is a RESTful API—which means it allows your application to communicate with Biometry’s services over the internet. It processes data that you send and returns the results in JSON format (a standard format that computers use to share information).

Base URL

All API calls will be made to the following base URL: https://api.biometrysolutions.com/api-gateway

Authorization

To use the Biometry API, you must first authenticate your request. This ensures that only authorised users and applications can access the API. You will need an API Token for this, which must be included with every request.

Requests

You can send data to Biometry’s services using standard HTTP requests in UTF-8 format. Each request is made to a specific endpoint, which represents the action you want to perform (e.g., processing a video or verifying biometric data).

Responses

When you send a request to Biometry, the API will send back a response in JSON format, which contains the results of your request. This response will include data on whether the request was successful and any additional information you need.

Response Codes

The API will also return response codes to let you know the status of your request. Here are the most common ones:

  • 200 OK: The request was successful, and the response contains the requested data.
  • 400 Bad Request: There was something wrong with the request (e.g., incorrect data format).
  • 401 Unauthorized: The request was not authorized. This usually happens if the API token is missing or invalid.
  • 404 Not Found: The requested resource could not be found.
  • 500 Internal Server Error: There was an issue on Biometry’s end, and the request could not be completed.

Handling Response Errors

If something goes wrong with your request, the API will return an error object with more information.

Error Object Structure

{
  "error": "error message here"
}

Example Error

If you send a request with an invalid API token, for example, the response will look something like this:

Terminal window
curl --location 'https://api.biometrysolutions.com/api-gateway/process-video' \
     --header 'Authorization: Bearer eyJh...9JuAXxxJAxkkzk'

Response:

{
  "error": "malformed token"
}