Introduction

The Verkada Pass SDK lets you build Verkada mobile credentials into your own iOS and Android app. Your users sign in through your app, see the doors and elevators they are permitted to open, and unlock them hands-free with Bluetooth Low Energy (BLE) or a tap in your interface, without installing a separate Verkada Pass app.

Keep your SDK up to date. The Verkada Pass SDK is updated periodically. Check the iOS and Android repositories and make sure your organization is running the most recent version. Verkada may end support for deprecated SDK versions, and apps on those versions may lose Pass functionality.

What the SDK does

CapabilityWhat it means for your app
Authenticate usersSigns a user in against your Verkada organization using a short-lived SDK token that your backend requests on their behalf.
List doors and elevatorsRetrieves the doors and elevators the signed-in user is authorized to open, grouped by building and floor.
BLE unlockAdvertises the phone as a Verkada Pass credential so a nearby reader can unlock automatically. Whether this happens, and how close the phone must be, is set in the reader's settings in Verkada Command.
Remote (mobile) unlockUnlocks a door when the user taps a button in your app. The SDK checks the user's schedule and, where enabled, geofence before asking Verkada to release the lock.

The SDK provides the credential and unlock logic. It does not include any user interface, so you design the screens.

Platform support

iOSAndroid
Minimum OSiOS 15+API 23+
LanguageSwiftKotlin
DistributionXCFramework via Swift Package ManagerARR via Maven
BLE unlockYesYes
Remote unlockYesYes
Geofence and locationYesYes
Sample appYesYes

For the base URL that matches your region, see Service Regions.

Before you start

Your organization must have Verkada Access with readers or locks installed. Bluetooth unlock only works on readers manufactured by Verkada.
The people who will use your app must exist as users in Command, with access to the doors they need.