Virtual Keys

This guide is designed to get you up and running quickly through creating a universal access credential that can be used by the visitors or a temporary tenants. In this guide we’ll cover the basics of integrating the most convenient way to grant access to a property, by outlining and walking through the necessary steps, to create a virtual key.

Key Concepts

To gain access to a property a valid access credential should be created. We use two entities to define access credentials:

• Keychain
• Virtual Key

Keychain

Keychain contains parameters that defines access credentials:

• tenant or unit
• kind
• periods of activity
• virtual keys

Here are some rules to keep in mind:

1. The keychain must have a tenant or unit specified upon creation
2. Only a building admin account can create a keychain on behalf of a tenant or for the specific unit
3. Tenants using their own credentials can only create a keychain associated with a tenant

📘

Tenant vs unit relation

If you have a large tenant turnover we recommend using the unit relationship.

Virtual Key

Virtual key identifies an entity that can use an access credential stored in a Keychain to gain access to a property.

An entity is defined by parameters:

• email or SMS capable phone number
• link to a QR-code image
• PIN-code

Keychain kinds

Custom duration

The most common scenario is when a guest or a short term tenant should be granted an access to a property during a period of time, up to 1 year.

Recurring

When a guest or short term tenant should have an access to a property on specific days and specific time. The credential can be valid up to 1 year.

One time

Credential can be limited to one time use and will be invalidated immediately after successfully granted access. The credential can be valid up to 1 year.