Third-party platforms can programmatically control Verkada-managed doors with the Enable Door Management via API setting enabled using Verkada’s access control API.
Applicable Door Management APIs
The following Access Control API categories include APIs that require all doors controlled with the API to have Enable Door Management via API enabled.
See Verkada API Docs for details on specific API endpoints that require this setting.
Command Configuration
Before a door can be controlled via API, permissions to control the door via API need to be enabled at the following levels:
Organization level configuration
In Verkada Command, go to All Products > Access
.On the left navigation, click Access Settings
.Toggle on Enable Door Management via API.
Site level configuration
In Verkada Command, go to All Products > Access
.From the All Sites dropdown, select a site.
At the top, click Access Settings
.Toggle on Enable Door Management via API.
Door level configuration
In Verkada Command, go to All Products > Access
.From the All Sites dropdown, select a site.
Select a door and click Settings
.Under Installer Settings, toggle on Enable Door Management via API.
Reviewing API Unlock Events
When a door unlock API call is used, an event is logged in Command indicating that a request to unlock a door via API was made. The event will indicate whether access was granted, what API was used, and (if applicable) an access user associated with the request.
Events associated with a door unlock API request can be viewed on the access control Reports page or on the door page for a relevant door.
Events associated with door unlock API requests include the following information:
Event Name: Access Granted or Access Denied
Method: User Unlock API or Admin Unlock API
User (if method is User Unlock API): Access user associated with the unlock request.
Credential: Name of the Verkada API Key used to make the API unlock request.
Need more help? Contact Verkada Support.