Skip to main content
Unlock Doors via API
Updated over a week ago

Third-party platforms can programmatically unlock Verkada-managed doors with API unlock enabled using APIs included in Verkada’s access control API. Comprehensive documentation on the access control API is available at https://apidocs.verkada.com/.

Command Configuration

Before a door can be unlocked via API, permissions to unlock via API need to be enabled at the following levels:

Organization level configuration

  1. In Verkada Command, go to All Products > Access.

  2. On the left navigation, click Access Settings .

  3. Toggle on Enable Door Unlock via API.

Site level configuration

  1. In Verkada Command, go to All Products > Access.

  2. From the All Sites dropdown, select a site.

  3. At the top, click Access Settings .

  4. Toggle on Enable Door Unlock via API.

Door level configuration

  1. In Verkada Command, go to All Products > Access.

  2. From the All Sites dropdown, select a site.

  3. Select a door and click Settings .

  4. Under Installer Settings, toggle on Enable Door Unlock 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.

Related resource


Need more help? Contact Verkada Support.

Did this answer your question?