API Tokens

Mint API Key

Mint a new API key for your project. Only API keys created on the dashboard with minting rights can mint new keys.

Authorization

This endpoint requires an API token as Bearer in the Authorization header. Go to Authorization guide for details.

Request

POST https://api.biometrysolutions.com/api-projects/public/apikeys

Headers

• Authorization* - Your API Token.

Parameters

No body parameters required.

Responses

200

Returns the newly minted API key as a string.

Response sample:

{
  "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "message": "api key created"
}

400

Bad Request error object.

Response sample:

{
  "message": "bad request"
}

401

Unauthorized error object.

Response sample:

{
  "message": "missing or invalid token"
}

---

Revoke API Key

Revoke an existing API key for your project. Only API keys created on the dashboard with minting rights can revoke keys.

Authorization

This endpoint requires an API token as Bearer in the Authorization header.

Request

DELETE https://api.biometrysolutions.com/api-projects/public/apikeys/{keyid}

Headers

• Authorization* - Your API Token.

Path Parameters

• keyid* (string) - The ID of the API key to revoke. Can be aquired from the Get API Key Info endpoint.

Responses

200

Success message.

Response sample:

{
  "message": "api key revoked"
}

400

Bad Request error object.

Response sample:

{
  "message": "bad request"
}

401

Unauthorized error object.

Response sample:

{
  "message": "missing or invalid token"
}

---

Get API Key Info

Retrieve information about the current API key.

Authorization

This endpoint requires an API token as Bearer in the Authorization header.

Request

GET https://api.biometrysolutions.com/api-projects/public/apikeys

Headers

• Authorization* - Your API Token.

Responses

200

Returns information about the API key.

Response sample:

  {
    "message": "api key found",
    "data": {
      "id": "b81a636a-2dac-488f-a25c-7545493625fc",
      "name": "minted_2025-04-29_16:26:40",
      "state": "active",
      "selected_services": [
          "Active Speaker Detection",
          "Visual Speech Recognition",
          "Face Liveness Detection",
          "Voice Recognition",
          "Face Recognition"
      ],
      "can_mint": false,
      "created_at": "2025-04-29T16:26:40.612Z",
      "updated_at": "2025-04-29T16:26:40.612Z",
    }
  }

401

Unauthorized error object.

Response sample:

{
  "message": "missing or invalid token"
}