API Token

API Token Overview

The Biometry API token is a key that allows your applications to communicate securely with Biometry’s services. This token includes important information about your project, such as which Biometry services (e.g., biometric authentication, liveness detection) your application is allowed to use.

When the token is created, it “remembers” the specific services that are required for your application. This means that if you have different applications, each can use a unique token to access only the services it needs. This helps keep everything organised and secure.

How to Create an API Token

To create an API token:

1. Go to the API Management page.
2. Generate a new token for your project.

When generating the token, you will be asked to specify which services your application will need. For example, if your app requires biometric authentication or fraud detection, this information will be embedded in the token. This ensures that the application can only use the services it’s authorised for.

Using the API Token

Once your API token is created, you will need to add it to your application so it can communicate with Biometry’s services. Think of the API token as a password—without it, your application won’t be allowed to use the services.

Here’s how it works: the token is included in all requests your application sends to Biometry. This lets Biometry know which services your application is allowed to use.

Token Expiration

Note

The API token is valid for 1 month. After that, you’ll need to create a new token through the Project Dashboard to keep using Biometry services.

Example Request (For Developers)

If you’re working with a developer, they’ll use the token like this when making requests to Biometry services. Here’s an example using cURL (a tool that developers use to send requests):

curl --location 'https://api.biometrysolutions.com/api-gateway/process-video' \
     --header 'Authorization: Bearer YOUR_API_TOKEN'