Sign UpSupported Devices

Create an Access Code

Creates a new access code.

Creates a new ongoing online access code.

Code

await seam.accessCodes.create({
  device_id: "a5036385-adcb-41b5-88c2-dd8a702a0730",
  name: "My Ongoing Online Access Code",
  code: "1234",
});

Output

{
  "access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
  "code": "1234",
  "common_code_key": null,
  "created_at": "2025-06-14T16:54:17.946242Z",
  "device_id": "a5036385-adcb-41b5-88c2-dd8a702a0730",
  "errors": [],
  "is_backup": false,
  "is_backup_access_code_available": false,
  "is_external_modification_allowed": false,
  "is_managed": true,
  "is_offline_access_code": false,
  "is_one_time_use": false,
  "is_scheduled_on_device": true,
  "is_waiting_for_code_assignment": false,
  "name": "My Ongoing Online Access Code",
  "pulled_backup_access_code_id": null,
  "status": "set",
  "type": "ongoing",
  "warnings": []
}
Authentication Methods

  • API key

  • Client session token

  • Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

device_id String (Required)

ID of the device for which you want to create the new access code.

allow_external_modification Boolean

Indicates whether external modification of the code is allowed. Default: false.

attempt_for_offline_device Boolean

code String

Code to be used for access.

common_code_key String

Key to identify access codes that should have the same code. Any two access codes with the same common_code_key are guaranteed to have the same code. See also Creating and Updating Multiple Linked Access Codes.

ends_at String

Date and time at which the validity of the new access code ends, in ISO 8601 format. Must be a time in the future and after starts_at.

is_external_modification_allowed Boolean

Indicates whether external modification of the code is allowed. Default: false.

is_offline_access_code Boolean

Indicates whether the access code is an offline access code.

is_one_time_use Boolean

Indicates whether the offline access code is a single-use access code.

max_time_rounding String

Maximum rounding adjustment. To create a daily-bound offline access code for devices that support this feature, set this parameter to 1d.

name String

Name of the new 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).

prefer_native_scheduling Boolean

Indicates whether native scheduling should be used for time-bound codes when supported by the provider. Default: true.

preferred_code_length Number

Preferred code length. Only applicable if you do not specify a code. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.

starts_at String

Date and time at which the validity of the new access code starts, in ISO 8601 format.

use_backup_access_code_pool Boolean

Indicates whether to use a backup access code pool provided by Seam. If true, you can use /access_codes/pull_backup_access_code.

use_offline_access_code Boolean

Response

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": [],
  "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": []
}

Examples

Create a time-bound online access code

Creates a new time-bound online access code.

Code

await seam.accessCodes.create({
  device_id: "a5036385-adcb-41b5-88c2-dd8a702a0730",
  name: "My Time-Bound Online Access Code",
  starts_at: "2025-06-20T06:49:21.000Z",
  ends_at: "2025-06-22T12:08:26.000Z",
  code: "1234",
});

Output

{
  "access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
  "code": "1234",
  "common_code_key": null,
  "created_at": "2025-06-14T16:54:17.946242Z",
  "device_id": "a5036385-adcb-41b5-88c2-dd8a702a0730",
  "ends_at": "2025-06-22T12:08:26.000Z",
  "errors": [],
  "is_backup": false,
  "is_backup_access_code_available": false,
  "is_external_modification_allowed": false,
  "is_managed": true,
  "is_offline_access_code": false,
  "is_one_time_use": false,
  "is_scheduled_on_device": true,
  "is_waiting_for_code_assignment": false,
  "name": "My Time-Bound Online Access Code",
  "pulled_backup_access_code_id": null,
  "starts_at": "2025-06-20T06:49:21.000Z",
  "status": "set",
  "type": "time_bound",
  "warnings": []
}

Create a time-bound offline access code

Creates a new time-bound offline access code.

Code

await seam.accessCodes.create({
  device_id: "a5036385-adcb-41b5-88c2-dd8a702a0730",
  name: "My Time-Bound Offline Access Code",
  starts_at: "2025-06-20T06:49:21.000Z",
  ends_at: "2025-06-22T12:08:26.000Z",
  attempt_for_offline_device: true,
  preferred_code_length: 4,
  use_offline_access_code: true,
  is_offline_access_code: true,
  max_time_rounding: "1h",
});

Output

{
  "access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
  "code": "1234",
  "common_code_key": null,
  "created_at": "2025-06-14T16:54:17.946242Z",
  "device_id": "a5036385-adcb-41b5-88c2-dd8a702a0730",
  "ends_at": "2025-06-22T12:08:26.000Z",
  "errors": [],
  "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": false,
  "is_scheduled_on_device": true,
  "is_waiting_for_code_assignment": false,
  "name": "My Time-Bound Offline Access Code",
  "pulled_backup_access_code_id": null,
  "starts_at": "2025-06-20T06:49:21.000Z",
  "status": "set",
  "type": "time_bound",
  "warnings": []
}

Create a one-time-use offline access code

Creates a new one-time-use offline access code.

Code

await seam.accessCodes.create({
  device_id: "a5036385-adcb-41b5-88c2-dd8a702a0730",
  name: "My One-Time-Use Offline Access Code",
  starts_at: "2025-06-20T06:49:21.000Z",
  ends_at: "2025-06-22T12:08:26.000Z",
  attempt_for_offline_device: true,
  preferred_code_length: 4,
  use_offline_access_code: true,
  is_offline_access_code: true,
  is_one_time_use: true,
});

Output

{
  "access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
  "code": "1234",
  "common_code_key": null,
  "created_at": "2025-06-14T16:54:17.946242Z",
  "device_id": "a5036385-adcb-41b5-88c2-dd8a702a0730",
  "ends_at": "2025-06-22T12:08:26.000Z",
  "errors": [],
  "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 One-Time-Use Offline Access Code",
  "pulled_backup_access_code_id": null,
  "starts_at": "2025-06-20T06:49:21.000Z",
  "status": "set",
  "type": "time_bound",
  "warnings": []
}

Create a time-bound online access code with a backup access code pool

Creates a new time-bound online access code with a backup access code pool.

Code

await seam.accessCodes.create({
  device_id: "a5036385-adcb-41b5-88c2-dd8a702a0730",
  name: "My Time-Bound Access Code",
  starts_at: "2025-06-20T06:49:21.000Z",
  ends_at: "2025-06-22T12:08:26.000Z",
  code: "1234",
  use_backup_access_code_pool: true,
});

Output

{
  "access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
  "code": "1234",
  "common_code_key": null,
  "created_at": "2025-06-14T16:54:17.946242Z",
  "device_id": "a5036385-adcb-41b5-88c2-dd8a702a0730",
  "ends_at": "2025-06-22T12:08:26.000Z",
  "errors": [],
  "is_backup": false,
  "is_backup_access_code_available": true,
  "is_external_modification_allowed": false,
  "is_managed": true,
  "is_offline_access_code": false,
  "is_one_time_use": false,
  "is_scheduled_on_device": true,
  "is_waiting_for_code_assignment": false,
  "name": "My Time-Bound Access Code",
  "pulled_backup_access_code_id": null,
  "starts_at": "2025-06-20T06:49:21.000Z",
  "status": "set",
  "type": "time_bound",
  "warnings": []
}
PreviousAccess CodesNextCreate Multiple Linked Access Codes

Last updated

Was this helpful?