Skip to content

Entities

Entities used in the Management API

Owner Account

A locking device or card is owned by an Owner Account which in turn is owned by a User, the owner.

Contact

A relation between a User and an owner. Represents the owner's view of a related User. E.g. a grant is always assigned to a Contact instead of a User.

Bound Lock

An owner's view of a locking device. If a lock is registered (bound) by an owner, a Bound Lock instance is created, which the lock owner can manage grants for. No more than one Bound Lock is marked active for a given Physical Lock at any single point in time.

Bound Card

An owner's view of an access media (card). When a card is registered (bound) by an Owner Account, an instance of Bound Card is created. No more than one instance of Bound Card is marked active for a given Physical Card at any single point in time.

Grant

An access permission for a Contact or a Bound Card to a Bound Lock.

Other entities

User

Represents a User who can sign in to Tapkey.

Physical Lock

The representation of a physical locking device. As a locking device could potentially be owned by multiple people over time, each having a separate view on it, there's no direct relationship between Physical Locks and Owner Accounts.

Physical Card

The representation of a physical access media. Like locking devices, cards can be owned by multiple Owner Accounts over time, so there's no direct relationship between Physical Cards and Owner Accounts.