Access Grants
Learn how to grant users access to entrances using intuitive and efficient Access Grants.
Seam Access Grants provide a unified, intuitive, and streamlined way to grant and manage user access across multiple access system providers. With a single command you can define the "who, where, when, and how" for assigning a user access to entrances and other access points. Access Grants support plastic cards, PIN codes, and mobile keys, including Instant Keys. You can even create multiple access methods using a single command.
An Access Grant includes the following characteristics:
Who
user_identity_id or user_identity
The user to whom to grant access. You can either create a user identity separately and specify the ID to the Access Grant or create a new user identity as part of the Access Grant creation action.
Where
acs_entrance_ids or space_ids
The entrances to which to grant access. You can specify one or more entrances by ID. Alternately, you can define spaces (currently in Alpha and available as an early access preview) that contain groups of related entrances and then specify one or more spaces by ID.
When
starts_at and ends_at
The access schedule.
How
requested_access_methods and mode
The access methods that you want to grant for the user. In each requested_access_method, specify the desired mode of access, such as a PIN code, key card, or mobile key (with an Instant Key).
Access Grant Process
The Access Grant process consists of the following steps:
Set up your site for Access Grants.
This step includes confirming hardware capabilities and making sure that you have the required licenses. For example, if you plan to use mobile keys or Instant Keys, your lock hardware must support Bluetooth Low Energy (BLE) keys. Also, to use mobile keys with your access system, you may need to purchase licenses or subscriptions to activate certain software features. These requirements vary by access system. For details, see Setting Up Your Site for Instant Keys and the system integration guide for your access system.
Connect your access system to Seam.
To connect your access system to Seam, we recommend embedding a Connect Webview in your application. The Connect Webview flow guides the property manager through each step of the connection process. For on-premises access systems, use Seam Bridge to connect the access system securely to Seam. For details, see Connect an Access System to Seam.
(Optional) Set up spaces to organize entrances into logical groups.
You can use spaces to create groups of entrances for efficiency. For example, a user staying in Room 101 may need access to both the Room 101 door, the main entrance door, and the nearest elevator. You could create a space that includes these three access points and then use this space when creating an Access Grant. For details, see spaces. Note: Spaces are currently in Alpha. We're actively developing this feature and seeking early feedback at [email protected]. Expect breaking changes as we refine the design.
(Optional) Create a user identity.
User identities represent your users—the people to whom you want to grant access. You can create a user identity before creating an Access Grant, or you can create a user identity as part of creating the Access Grant. See Managing Mobile App User Accounts with User Identities.
Create an Access Grant.
When you create an Access Grant, you specify the user identity to whom you want to grant access, the access schedule, the set of entrances or spaces, and one or more access methods that you want to request. See Creating an Access Grant Using Entrances and Creating an Access Grant Using Spaces. You can poll for access method status changes or watch for Access Grant and access method lifecycle events that alert you to next steps, such as how and when to deliver each created access method to your user.
Deliver the access method to the user.
Once Seam alerts you that your access methods are ready, deliver them to your user. Delivery steps depend on the mode of access, such as plastic key card, PIN code, or mobile key.
If you have created an access grant that includes a card access method, you may need to encode the card using the Seam encoders API.
If you have created an Access Grant that includes a mobile key, you can use the Seam mobile SDKs to develop your mobile app that delivers these mobile keys to your users.
Each mobile key also includes an Instant Key URL. To share this Instant Key with your user, send it through text or email or embed it in your own app.
Get Started
To create your first Access Grant, see the Access Grant Quick Start. Then, learn more in the following topics:
Last updated
Was this helpful?