This document provides a step-by-step guide for configuring the integration between Suprema’s BioStation3 biometric readers and Verkada’s access control solution. The process involves both customer provided information and configuration work by Suprema.
Integration Overview
All users and access levels are added and managed within the Command platform. Using Verkada’s APIs, Suprema retrieves the user information and pulls the associated profile pictures. Suprema then generates a unique credential string mapped to each users’ face and uploads the associated credentials to Verkada Command. At the unlock time, the BioStation3 scans the user's face, translates the face to a credential string, and sends the credentials to Verkada’s ACU. If the credentials match on Verkada’s side, access is granted.
Suprema allows users to define a custom sync cycle to regularly pull the latest Command users and ensure permissions are always up to date. For more information on Suprema’s facial enrollment process and best practices, refer to their knowledge base article linked here.
Note - To deploy this integration, you will be creating an API token and providing that token to Suprema. API tokens allow access to retrieving data and making changes in Command, and are the responsibility of the customer to keep safe and secure. Verkada is not responsible for any information extracted from Command or changes made to Command by use of a customer's API token.
System Requirements
1. Verkada Hardware and Software Requirements
Verkada provides access control infrastructure and cloud-based management tools. The following items are required on the Verkada side:
Hardware
Verkada Access Control panel - either single-door or multi-door ACU.
Software
Access Control license - integration requires at least one door license.
Credential type - CLUeXfer will automatically register a 26-bit Standard Wiegand card to each user in Verkada. This same card will also be stored in CLUe, eliminating the need to manually pre-register cards in Verkada. When a user authenticates, the device outputs the 26-bit card ID to the Verkada controller, which uses it to verify and grant access.
2. Suprema Hardware and Software Requirements
The Suprema side of the integration handles facial recognition and biometric data management. The following components are required:
Hardware
BioStation 3 (BS3) - must be equipped with CLUe-compatible firmware.
Software
CLUe platform - access to Suprema platform required for integration setup.
DataXfer site (provisioned by Suprema) - a dedicated DataXfer site will be created by Suprema during integration setup. This site handles data transfer between Suprema and Verkada systems.
DataXfer site license - a valid software license is required for the DataXfer site.
3. Required API Credentials
Verkada API Key Configuration
Users will need to create a Verkada API key with the following properties:
Note - When you use an API Key, or let others use it, you are responsible for ensuring the use complies with the API Use Policy. Verkada is not responsible for any data once it leaves the Command platform.
Name - Any descriptive name (e.g., "Suprema Integration Key")
Endpoint Access
Core Command - Can be Read/Write or Read-Only
Access Control - Must be Read/Write to enable user provisioning and access level assignment
Expiration - Set according to your organization's security policy
Region Setting - Navigate to Command > Privacy & Security > Data Residency to confirm the correct region (e.g., US, EU)
Suprema API Credential
CLUe Place API Key - Provided by Suprema as part of the DataXfer setup.
Step 1: Provide Verkada Information to Suprema
Users must first provide the following Verkada details to Suprema’s integration team:
A valid API key generated from your Verkada Command account (see above API requirements for permissions).
The region setting associated with your Verkada instance (e.g., US, EU, etc.).
Command access level within Verkada that will be used for synchronizing users. Suprema will map user profiles from Suprema to this access level.
Step 2: Suprema Configuration — CLUe Setup
Once the required information is received, Suprema will configure the CLUe platform.
Suprema Responsibilities for CLUe:
Create CLUe Place and Site - Suprema will provision a dedicated “Place” and “Site” for the customer within the CLUe platform.
Add BS3 Devices - Suprema will register and associate all BioStation 3 (BS3) units to the CLUe Site.
Create CLUe API - API integration point will be created to connect the CLUe platform with Verkada, enabling user data transfer and management.
Step 3: Suprema Configuration — DataXfer Setup
After the CLUe platform is ready, Suprema will set up and validate the data transfer process using its DataXfer tool.
Suprema Responsibilities for DataXfer:
Create DataXfer Site - A DataXfer site will be created specifically for your organization, which will handle syncing data between CLUe and Verkada.
Test User Data Transfer - Suprema will perform a test transfer to confirm that user profiles are correctly moving from the Suprema system into Verkada Command.
Step 4: Hardware Installation and Wiring
The final step involves physical installation and wiring by the customer or on-site technician.
Customer Responsibilities:
Wire BS3 Device to Verkada Access Control Panel - Connect the Wiegand output of the BioStation 3 device to the appropriate input on the Verkada access control panel.
Verify Signal Communication - Ensure the Wiegand signals from BS3 are correctly interpreted by the Verkada system (e.g., badge reads or biometric scans result in access events in Verkada).