Access codes are codes for keypad devices. These are used when you want to provide access to a lock using a PIN code.
An Access Code is a code used for a keypad or pinpad device. Unlike physical keys, which can be easily lost or duplicated, PIN codes can be customized, tracked, and altered on-the-fly. Using Seam's Access Code API, you can easily generate access codes on the hundreds of door lock models that we integrate with.
Seam supports programming two types of access codes, ongoing and time-bound. To differentiate between the two, refer to the
typeproperty of the access code. Ongoing codes display as
ongoing, whereas time-bound codes are labeled
Ongoing Access Codes: Ideal for residents or long-term users. Ongoing codes remain active on a device until removed. They can start right away or at a later date if you provide a
Timeline of an ongoing access code. The code will remain active until you ask Seam to remove it.
Time Bound: Suitable for temporary access like guest visits or service appointments. These codes operate between a designated
ends_attime window, granting access only during that period.
Timeline of an time-bound access code. The code will remain active until the ends_at timestamp you provide Seam.
Seam ensures access reliability by initiating the programming of access codes onto the lock ahead of its
starts_attime. This approach minimizes the risks of delays or disruptions during the programming process.
For locks that support setting codes with a schedule, Seam will preload access codes onto the device a full 72 hours before the
starts_attimestamp of a Time Bound code. When the
starts_attime arrives, the code automatically activates and will remain active until its
ends_attime. We enable this "Native scheduling" functionality by default for all providers that support this (see the table below for a list of supported providers). You can choose to override this default behavior, and have Seam perform "Just-in-time scheduling" by setting
falsewhen creating a code.
72 hours before the
starts_attimestamp, Seam inserts the code into the device's internal memory. When the
starts_attime arrives, the device automatically activates the code. It is then automatically deactivated at the
For those locks that lack native scheduling functionality, Seam will use its own scheduling infrastructure to program the code 30 minutes before the
starts_attime, and remove it at the
starts_attime arrives, Seam adds the code to the device and activates it. It is then automatically deactivated at the
Occasionally, Seam may encounter issues when programming codes onto locks. Such hiccups can arise from device connectivity issues, manual interventions from the lock or its accompanying app, or service disruptions from the lock providers. Given these issues, we strongly advise preprogramming a set of backup codes onto the door lock. Should you detect a failure in access code programming, these backup codes can be promptly shared.
Seam offers a Backup Access Code service. When activated, this service automatically maintain a pool of pre-programmed access codes on a device. These codes are programmed in addition to the regular access codes on Seam, acting as a safety net in case of any issues with the primary codes. Please read about how to enable and request a back up code here.