The Access Code Object

The access_code Object

Represents a smart lock access code. An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate. Seam supports programming two types of access codes: ongoing and time-bound. To differentiate between the two, refer to the type property of the access code. Ongoing codes display as ongoing, whereas time-bound codes are labeled time_bound. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both starts_at and ends_at empty. A time-bound access code will be programmed at the starts_at time and removed at the ends_at time. In addition, for certain devices, Seam also supports offline access codes. Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.

{
  "access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
  "code": "1234",
  "common_code_key": null,
  "created_at": "2025-06-14T16:54:17.946242Z",
  "device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
  "ends_at": "2025-07-04T16:54:17.946049Z",
  "errors": [],
  "pending_mutations": [],
  "is_backup": false,
  "is_backup_access_code_available": false,
  "is_external_modification_allowed": false,
  "is_managed": true,
  "is_offline_access_code": true,
  "is_one_time_use": true,
  "is_scheduled_on_device": true,
  "is_waiting_for_code_assignment": false,
  "name": "My Access Code",
  "pulled_backup_access_code_id": null,
  "starts_at": "2025-07-02T16:54:17.946049Z",
  "status": "set",
  "type": "time_bound",
  "warnings": [],
  "workspace_id": "750fc0bc-4450-4356-8d9f-18c6a3a6b2c7"
}

Properties

access_code_id

String (UUID)

Unique identifier for the access code.

code

String

Code used for access. Typically, a numeric or alphanumeric string.

common_code_key

String

Unique identifier for a group of access codes that share the same code.

created_at

String (ISO 8601)

Date and time at which the access code was created.

device_id

String (UUID)

Unique identifier for the device associated with the access code.

dormakaba_oracode_metadata

Object

Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.

Show properties

is_cancellable

Boolean

Indicates whether the stay can be cancelled via the Dormakaba Oracode API.

is_early_checkin_able

Boolean

Indicates whether early check-in is available for this stay.

is_extendable

Boolean

Indicates whether the stay can be extended via the Dormakaba Oracode API.

is_overridable

Boolean

Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached.

site_name

String

Dormakaba Oracode site name associated with this access code.

stay_id

number

Dormakaba Oracode stay ID associated with this access code.

user_level_id

String

Dormakaba Oracode user level ID associated with this access code.

user_level_name

String

Dormakaba Oracode user level name associated with this access code.

ends_at

String (ISO 8601)

Date and time after which the time-bound access code becomes inactive.

errors

Array

Errors associated with the access code.

is_backup

Boolean

Indicates whether the access code is a backup code.

is_backup_access_code_available

Boolean

Indicates whether a backup access code is available for use if the primary access code is lost or compromised.

is_external_modification_allowed

Boolean

Indicates whether changes to the access code from external sources are permitted.

is_managed

Boolean

Indicates whether Seam manages the access code.

is_offline_access_code

Boolean

Indicates whether the access code is intended for use in offline scenarios. If true, this code can be created on a device without a network connection.

is_one_time_use

Boolean

Indicates whether the access code can only be used once. If true, the code becomes invalid after the first use.

is_scheduled_on_device

Boolean

Indicates whether the code is set on the device according to a preconfigured schedule.

is_waiting_for_code_assignment

Boolean

Indicates whether the access code is waiting for a code assignment.

name

String

Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider’s app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as first_name and last_name. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider’s app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider’s app or on the device as a separate property called appearance. This is an object with a name property and, optionally, first_name and last_name properties (for providers that break down a name into components).

pending_mutations

Array

Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device.

pulled_backup_access_code_id

String (UUID)

Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.

starts_at

String (ISO 8601)

Date and time at which the time-bound access code becomes active.

status

Enum (String)

Current status of the access code within the operational lifecycle. Values are setting, a transitional phase that indicates that the code is being configured or activated; set, which indicates that the code is active and operational; unset, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; removing, which indicates a transitional period in which the code is being deleted or made inactive; and unknown, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also Lifecycle of Access Codes.

type

Enum (String)

Type of the access code. ongoing access codes are active continuously until deactivated manually. time_bound access codes have a specific duration.

warnings

Array

Warnings associated with the access code.

workspace_id

String (UUID)

Unique identifier for the Seam workspace associated with the access code.

​The access_code Object

​Properties

The access_code Object

Properties