LogoLogo
Sign UpSupported Devices
  • Seam Documentation
  • 🚲Quick Start
  • 🚀Go Live!
  • Core Concepts
    • Overview
    • Seam Console
      • Seam Online CLI
    • Workspaces
    • Authentication
      • API Keys
      • Personal Access Tokens
      • Client Sessions and Client Session Tokens
        • Implementing Client Sessions for Device Management in the Backend
    • Connect Webviews
      • Connect Webview Process
      • Embedding a Connect Webview in Your App
      • Verifying Successful Account Connection
      • Retrieving Devices or Access Control Systems Connected Through a Connect Webview
      • Attaching Custom Metadata to the Connect Webview
      • Filtering Connect Webviews by Custom Metadata
      • Customizing Connect Webviews
    • Devices
      • Displaying Device Health
      • Displaying Device Power Status
      • Managed and Unmanaged Devices
      • Adding Custom Metadata to a Device
      • Filtering Devices by Custom Metadata
      • Handling Device Errors
      • Testing Your App Against Device Disconnection and Removal
    • Providers
      • Provider Metadata
    • Connected Accounts
      • Adding Custom Metadata to a Connected Account
      • Filtering Connected Accounts by Custom Metadata
      • Reconnecting an Account
    • Action Attempts
  • Capability Guides
    • 📋Device and System Capabilities
    • 🔒Smart Locks
      • Locking and Unlocking Smart Locks
      • Creating and Managing Smart Lock Access Codes
        • Creating Access Codes
          • Understanding Code Constraints
        • Retrieving Access Codes
        • Modifying Access Codes
        • Deleting Access Codes
        • Lifecycle of Access Codes
        • Access Code Requirements for Door Locks
        • Streamlining Access Code Management from the Manufacturer App
        • Troubleshooting Access Codes
        • Managing Backup Access Codes
        • Managing Offline Access Codes
        • Creating and Updating Multiple Linked Access Codes
        • Migrating Existing Unmanaged Access Codes
    • 🏢Access Control Systems
      • ACS Quick Starts
        • PIN Code Quick Start
        • Encodable Key Card Quick Start
        • Mobile Key Quick Start
      • Connect an ACS to Seam
        • Retrieving ACS System Details
        • Access Control System Resources
        • Understanding Access Control System Differences
      • Managing ACS Users
        • Suspending and Unsuspending ACS Users
        • Assigning ACS Users to Access Groups
      • Retrieving Entrance Details
      • Managing Credentials
        • Assigning Credentials to ACS Users
        • Listing Credentials and Associated Entrances
      • Working with Card Encoders and Scanners
        • Creating and Encoding Card-based Credentials
        • Scanning Encoded Cards
      • Troubleshooting Your Access Control System
    • 📱Mobile Access
      • Prepare your Workspace
      • Managing Mobile App User Accounts with User Identities
      • Managing Phones for a User Identity
      • Issuing Mobile Credentials from an Access Control System
      • Developing in a Sandbox Workspace
      • Integrating into your Mobile Application
        • Initializing the Seam Mobile SDK
        • Handling System Permissions
        • Using Unlock With Tap
    • 🌡️Thermostats
      • Understanding Thermostat Concepts
        • HVAC Mode
        • Set Points
      • Retrieving Thermostats
      • Setting and Monitoring Temperature Thresholds
      • Setting the Current HVAC and Fan Mode Settings
      • Creating and Managing Climate Presets
        • Setting the Fallback Climate Preset
        • Activating a Climate Preset
      • Creating and Managing Thermostat Schedules
      • Creating and Managing Thermostat Programs
      • Testing Your Thermostat App with Simulate Endpoints
    • 👂Noise Sensors
      • Configuring Noise Threshold Settings
    • 📡Seam Bridge
  • 💻UI Components
    • 🧱Seam Components
      • Getting Started with Seam Components
        • Get Started with React
        • Get started with Angular
        • Get started with Vue
        • Get started with Client Side Components
      • Components
        • Device Details
        • Device Table
        • Access Code Table
        • Access Code Details
        • Create Access Code Form
        • Update Access Code Form
        • Supported Devices Table
        • Seam Provider
        • Connect Account Button
      • Make a Supported Devices Page
      • Using User Identities to Scope Users' Device Access
  • 📋API Reference
    • Overview
    • Installation
    • Authentication
    • Access Codes
      • Create an Access Code
      • Create Multiple Linked Access Codes
      • List Access Codes
      • Get an Access Code
      • Update an Access Code
      • Update Multiple Linked Access Codes
      • Delete an Access Code
      • Pull a Backup Access Code
      • Report Device Access Code Constraints
      • Unmanaged Access Codes
        • List Unmanaged Access Codes
        • Get an Unmanaged Access Code
        • Convert an Unmanaged Access Code
        • Update an Unmanaged Access Code
        • Delete an Unmanaged Access Code
      • Access Code Simulations
        • Simulate Creating an Unmanaged Access Code
    • Access Control Systems (ACS)
      • Systems
        • List ACS Systems
        • Get an ACS System
        • List Compatible Credential Manager ACS Systems
      • ACS Users
        • Create an ACS User
        • List ACS Users
        • Get an ACS User
        • Update an ACS User
        • Suspend an ACS User
        • Unsuspend an ACS User
        • Delete an ACS User
        • Add an ACS User to an Access Group
        • Remove an ACS User from an Access Group
      • Entrances
        • List Entrances
        • Get an Entrance
        • List Credentials with Access to an Entrance
      • Access Groups
        • List Access Groups
        • Get an Access Group
        • Add an ACS User to an Access Group
        • Remove an ACS User from an Access Group
        • List ACS Users in an Access Group
      • Credentials
        • Create a Credential for an ACS User
        • Assign a Credential to an ACS User
        • List Credentials
        • Get a Credential
        • Update a Credential
        • Unassign a Credential from an ACS User
        • Delete a Credential
        • List Accessible Entrances
      • Encoders
        • Encode a Credential
        • List Encoders
        • Get an Encoder
        • Scan a Credential
        • Encoder Simulations
          • Simulate that the Next Credential Encoding Will Fail
          • Simulate that the Next Credential Encoding Will Succeed
          • Simulate that the Next Credential Scan Will Fail
          • Simulate that the Next Credential Scan Will Succeed
    • Action Attempts
      • Get Action Attempt
    • Client Sessions
      • Create a Client Session
      • Get or Create a Client Session
      • List Client Sessions
      • Get a Client Session
      • Grant Access to a Client Session
      • Delete a Client Session
    • Connect Webviews
      • Create a Connect Webview
      • List Connect Webviews
      • Get a Connect Webview
      • Delete a Connect Webview
    • Connected Accounts
      • Get a Connected Account
      • List Connected Accounts
      • Update a Connected Account
      • Delete a Connected Account
    • Devices
      • List Devices
      • List Device Providers
      • Get a Device
      • Update a Device
      • Unmanaged Devices
        • Update an Unmanaged Device
        • List Unmanaged Devices
        • Get an Unmanaged Device
    • Events
      • List Events
      • Get an Event
    • Locks
      • Get Lock
      • Lock a Lock
      • Unlock a Lock
      • List Locks
    • Noise Sensors
      • Noise Thresholds
        • Create Noise Thresholds
        • List Noise Thresholds
        • Update Noise Threshold
        • Delete Noise Threshold
    • Phones
      • Get a Phone
      • List Phones
      • Deactivate a Phone
      • Phone Simulations
        • Create a Sandbox Phone
    • Thermostats
      • List Thermostats
      • Set to Heat Mode
      • Set to Cool Mode
      • Set to Heat-Cool (Auto) Mode
      • Set to Off Mode
      • Set the HVAC Mode
      • Set Fan Mode
      • Activate a Climate Preset
      • Create a Climate Preset
      • Update a Climate Preset
      • Delete a Climate Preset
      • Set a Fallback Climate Preset
      • Set a Temperature Threshold
      • Thermostat Schedules
        • Get a Thermostat Schedule
        • List Thermostat Schedules
        • Create a Thermostat Schedule
        • Update a Thermostat Schedule
        • Delete a Thermostat Schedule
      • Thermostat Simulations
        • Temperature Reached
        • HVAC Mode Adjusted
    • User Identities
      • Create a User Identity
      • List User Identities
      • Get a User Identity
      • Update a User Identity
      • Add an ACS User to a User Identity
      • List ACS Users Associated with a User Identity
      • List ACS Systems Associated with a User Identity
      • Remove an ACS User from a User Identity
      • Grant a User Identity Access to a Device
      • List Accessible Devices for a User Identity
      • Revoke Access to a Device from a User Identity
      • Delete a User Identity
      • Enrollment Automations
        • Launch an Enrollment Automation
        • List Enrollment Automations
        • Get an Enrollment Automation
        • Delete an Enrollment Automation
    • Workspaces
      • Get Workspace
      • Reset Workspace
  • 🛠️Developer Tools
    • Webhooks
    • Seam CLI
    • Sandbox Devices and Systems
      • Sandbox 2N Intercoms
      • Sandbox 4SUITES Locks
      • Sandbox Akiles Locks
      • Sandbox ASSA ABLOY Credential Services
      • Sandbox ASSA ABLOY Visionline Access Control System
      • Sandbox August Locks
      • Sandbox Avigilon Alta Access System
      • Sandbox Brivo Access
      • Sandbox ControlByWeb Relays
      • Sandbox Doorking Callboxes
      • Sandbox dormakaba Oracode Locks
      • Sandbox ecobee Thermostats
      • Sandbox Genie Garage Openers
      • Sandbox Google Nest Thermostats
      • Sandbox Honeywell Resideo Thermostats
      • Sandbox igloohome Locks
      • Sandbox Kwikset Locks
      • Sandbox Latch Access Control System
      • Sandbox Linear Callboxes
      • Sandbox Lockly Locks
      • Sandbox Minut Sensors
      • Sandbox NoiseAware Sensors
      • Sandbox Nuki Locks
      • Sandbox PTI Storlogix Cloud
      • Sandbox Salto KS Access Control System
      • Sandbox Salto Locks
      • Sandbox Salto Space Access System
      • Sandbox Schlage Encode Locks
      • Sandbox Seam Bridge
      • Sandbox Sensi Thermostats
      • Sandbox SmartThings Hub
      • Sandbox Tedee Locks
      • Sandbox TTLock Locks
      • Sandbox Wyze Locks
      • Sandbox Yale Locks
    • Rate Limits and Guardrails
    • Mobile SDKs
      • Android SDK
      • iOS SDK
  • 🎛️Device and System Integration Guides
    • Overview
    • 2N Intercom Systems
      • Get started with 2N Intercoms
    • 33 Lock Devices
      • Get started with 33 Lock devices
    • 4SUITES Locks
      • Get started with 4SUITES locks
    • Akiles Locks
      • Get started with Akiles locks
    • ASSA ABLOY Credential Services
    • ASSA ABLOY Visionline Access Control System
      • Visionline ACS Setup Instructions
        • Developing and Launching Your Visionline Plastic Card Encoding App
          • Developing Your Visionline Plastic Card Encoding App Using a Real Visionline Server
            • Step 1: Install Your Visionline Application
            • Step 2: Unblock Required Ports
            • Step 3: Configure a Visionline User Account
            • Step 4: Install a Visionline Card Encoder
            • Step 5: Set up Door Locks
            • Step 6: Program Door Locks
            • Step 7: Create a Production Workspace
            • Step 8: Connect Your Visionline Development Account to Seam
            • Next Steps
          • Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace
            • Step 1: Create a Sandbox Workspace
            • Step 2: Connect the Virtual Visionline ACS to Seam
            • Next Steps
          • Launching Your Visionline Plastic Card Encoding App to a Live Site
            • Step 1: Confirm That Your Visionline Site Meets the Requirements
            • Step 2: Configure a Visionline User Account
            • Step 3: Purchase and Import the Callback Option from ASSA ABLOY
            • Step 4: Create a Production Workspace
            • Step 5: Connect Your Visionline Production Account to Seam
        • Developing and Launching Your Visionline Mobile Key App
          • Developing Your Visionline Mobile Key App
            • Step 1: Complete the ASSA ABLOY Mobile Development Course
            • Step 2: Install Your Visionline Application
            • Step 3: Unblock Required Ports
            • Step 4: Configure a Visionline User Account
            • Step 5: Set up Your Credential Services Account in Visionline
            • Step 6: Configure the Mobile Access UUID in Visionline
            • Step 7: Set up Door Locks with BLE Profiles
            • Step 8: Program Door Locks
            • Step 9: Create a Production Workspace
            • Step 10: Connect Your Visionline Development Account to Seam
            • Next Steps
          • Launching Your Visionline Mobile Key App
            • Step 1: Obtain ASSA ABLOY Certification for Your Mobile Key App
            • Step 2: Confirm That Your Visionline Site Meets the Requirements
            • Step 3: Confirm BLE Module on All Locks
            • Step 4: Set up Door Locks with BLE Profiles
            • Step 5: Program Door Locks
            • Step 6: Configure a Visionline User Account
            • Step 7: Purchase and Import the Callback and Mobile Service Options from ASSA ABLOY
            • Step 8: Create a Production Workspace
            • Step 9: Connect Your Visionline Production Account to Seam
      • Configuring Visionline Mobile Credentials
        • Issuing Various Types of Guest Mobile Credentials
        • Issuing Various Types of Guest Joiner Mobile Credentials
        • Retrieving Guest and Common Entrances
        • Checking if a User Identity Has a Phone That Is Set up for a Credential Manager
        • Updating Guest Mobile Credentials
        • Revoking Mobile Credentials
      • Mobile Credential-Related Properties
      • Common Use Cases
      • Special Requirements for Android Mobile Access SDK Development
      • Special Requirements for iOS Mobile Access SDK Development
      • Creating Visionline Card-based Credentials
    • August Locks
      • Get started with August locks
    • Avigilon Alta Access System
    • Brivo Access
    • Get started with ControlByWeb Devices
    • dormakaba Oracode Locks
      • Get started with dormakaba Oracode Locks
      • Creating dormakaba Oracode Offline Access Codes
    • ecobee Thermostats
      • Get Started with ecobee Thermostats
    • Google Nest Thermostats
      • Get Started with Nest Thermostats
      • Obtain Google Nest Device Access and Commercial Development
    • Honeywell Resideo Thermostats
      • Get Started with Honeywell Resideo Thermostats
    • igloohome Locks
      • Get started with igloohome Locks
      • Creating igloohome Offline Access Codes
    • Kwikset Locks
      • Get started with Kwikset Wi-Fi Locks
    • Latch Access Control System
      • Latch ACS Setup Instructions
      • Programming Code-Based Latch Credentials
      • Programming Latch ACS Mobile Credentials
    • Lockly Locks
      • Creating Lockly Offline Access Codes
    • Minut Sensors
      • Get started with Minut Sensors
    • NoiseAware Sensors
      • Get started with NoiseAware Sensors
    • Nuki Locks
      • Get Started with Nuki Locks
    • PTI Storlogix Cloud
    • Salto KS Access Control System
      • Salto KS Setup Instructions
      • Programming Salto KS PIN Code Credentials
      • Programming Salto KS Mobile Credentials
      • Special Requirements for Android Mobile Access SDK Development
    • Salto KS Locks
      • Get started with Salto KS Locks
    • Salto ProAccess Space Access System
      • Salto Space Setup Instructions
      • Programming Salto Space Card-based Credentials
      • Programming Salto Space Mobile Credentials
    • Schlage Locks
      • Schlage Locks Setup Instructions
      • Get started with Schlage Locks
    • Sensi Thermostats
      • Get Started with Sensi Thermostats
    • Get started with SmartThings Hubs + Smart Locks
    • Tedee Locks
      • Get Started with Tedee Locks
    • TTLock Locks
      • Get started with TTLock Locks
    • Wyze Locks
      • Get started with Wyze Locks
    • Yale Locks
      • Get started with Yale Locks
    • Get started with Smart Locks
  • Device Manufacturer Guidance
    • Creating a Seam-Compatible Intercom API
      • Creating OAuth Endpoints
      • Creating Intercom CRUD Endpoints
      • Creating Access Code CRUD Endpoints
      • Creating the Health Endpoint
    • Creating a Seam-Compatible Door Locks API
      • Creating OAuth Endpoints
      • Creating Door Lock CRUD Endpoints
      • Creating Access Code CRUD Endpoints
      • Creating the Health Endpoint
Powered by GitBook
LogoLogo

Get Started

  • Sign Up
  • Supported Devices

News

  • Changelog
  • Blog

Company

  • About
  • Privacy Notice

© Seam Labs, Inc. All rights reserved.

On this page
  • The access_code Object
  • Properties
  • Errors
  • Warnings
  • Events
  • Endpoints

Was this helpful?

Edit on GitHub
  1. API Reference

Access Codes

PreviousAuthenticationNextCreate an Access Code

Last updated 2 days ago

Was this helpful?

The access_code Object

Represents a smart lock .

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: and . 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 (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: [example value],
  code: [example value],
  common_code_key: [example value],
  created_at: [example value],
  device_id: [example value],
  ends_at: [example value],
  errors: [example value],
  is_backup: [example value],
  is_backup_access_code_available: [example value],
  is_external_modification_allowed: [example value],
  is_managed: [example value],
  is_offline_access_code: [example value],
  is_one_time_use: [example value],
  is_scheduled_on_device: [example value],
  is_waiting_for_code_assignment: [example value],
  name: [example value],
  pulled_backup_access_code_id: [example value],
  starts_at: [example value],
  status: [example value],
  type: [example value],
  warnings: [example value]
}

Properties

access_code_id 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 Datetime

Date and time at which the access code was created.


device_id UUID

Unique identifier for the device associated with the access code.


ends_at Datetime

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


The specific structure of each object in this list depends on the value of its error_code field.

Variants:

smartthings_failed_to_set_access_code

Failed to set code on SmartThings device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

smartthings_failed_to_set_after_multiple_retries

Failed to set code after multiple retries.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

smartthings_no_free_slots_available

No free slots available on the device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

failed_to_set_on_device

Failed to set code on device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

failed_to_remove_from_device

Failed to remove code from device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

duplicate_code_on_device

Duplicate access code detected on device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

duplicate_code_attempt_prevented

An attempt to modify this access code was prevented.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

no_space_for_access_code_on_device

No space for access code on device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

igloohome_bridge_too_many_pending_jobs

Igloohome bridge has too many pending jobs in the queue.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

igloohome_bridge_offline

Igloohome bridge is offline.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

igloohome_offline_access_code_no_variance_available

Lock has reached maximum amount of codes.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

kwikset_unable_to_confirm_code

Unable to confirm that the access code is set on Kwikset device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

kwikset_unable_to_confirm_deletion

Unable to confirm the deletion of the access code on Kwikset device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

code_modified_external_to_seam

Code was modified or removed externally after Seam successfully set it on the device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

august_lock_invalid_code_length

Invalid code length for August lock.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

august_device_programming_delay

Access code has not yet been fully moved to the device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

august_device_slots_full

All access code slots on the device are full.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

august_lock_missing_keypad

August lock is missing a keypad.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

august_lock_temporarily_offline

August lock is temporarily offline.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

salto_ks_user_not_subscribed

Salto site user is not subscribed.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

hubitat_device_programming_delay

Access code has not yet been fully moved to the device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

hubitat_no_free_positions_available

No free positions available on the device.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

wyze_duplicate_code_name

Duplicate access code name detected.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

wyze_potential_duplicate_code

Potential duplicate access code detected.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

dormakaba_oracode_no_valid_user_level

No valid user level for Oracode.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_access_code_error Boolean

Indicates that this is an access code error.


message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

account_disconnected

Account is disconnected

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_connected_account_error Boolean


is_device_error Boolean


message String

salto_ks_subscription_limit_exceeded

Salto site user limit reached.

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_connected_account_error Boolean


is_device_error Boolean


message String

device_offline

Device is offline

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_device_error Boolean


message String

device_removed

Device has been removed

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_device_error Boolean


message String

hub_disconnected

Hub is disconnected

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_device_error Boolean


message String

device_disconnected

Device is disconnected

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_device_error Boolean


message String

empty_backup_access_code_pool

The backup access code pool is empty.

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_device_error Boolean


message String

august_lock_not_authorized

User is not authorized to use the August Lock.

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_device_error Boolean


message String

august_lock_missing_bridge

Lock is not connected to the Seam Bridge.

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_device_error Boolean


message String

ttlock_lock_not_paired_to_gateway

Lock is not paired with a Gateway.

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_device_error Boolean


message String

missing_device_credentials

Missing device credentials.

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_device_error Boolean


message String

auxiliary_heat_running

The auxiliary heat is running.

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_device_error Boolean


message String

subscription_required

Subscription required to connect.

created_at Datetime


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_device_error Boolean


message String

invalid_credentials

Credentials provided were invalid.

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_bridge_error Boolean


is_connected_account_error Boolean


message String

bridge_disconnected

created_at Datetime

Date and time at which Seam created the error.


error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.


is_bridge_error Boolean


is_connected_account_error Boolean


message String


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).

pulled_backup_access_code_id UUID

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


starts_at Datetime

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


status Enum

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.

Enum values
  • setting

  • set

  • unset

  • removing

  • unknown


type Enum

Nature of the access code. Values are ongoing for access codes that are active continuously until deactivated manually or time_bound for access codes that have a specific duration.

Enum values
  • time_bound

  • ongoing


The specific structure of each object in this list depends on the value of its warning_code field.

Variants:

smartthings_failed_to_set_access_code

Failed to set code on SmartThings device.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

schlage_detected_duplicate

Duplicate access code detected.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

schlage_creation_outage

Received an error when attempting to create this code.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

code_modified_external_to_seam

Code was modified or removed externally after Seam successfully set it on the device.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

delay_in_setting_on_device

Delay in setting code on device.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

delay_in_removing_from_device

Delay in removing code from device.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

third_party_integration_detected

Third-party integration detected that may cause access codes to fail.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

august_device_programming_delay

Access code has not yet been fully moved to the device.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

august_lock_temporarily_offline

August lock is temporarily offline.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

igloo_algopin_must_be_used_within_24_hours

Algopins must be used within 24 hours.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

management_transferred

Management was transferred to another workspace.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

kwikset_unable_to_confirm_code

Unable to confirm that the access code is set on Kwikset device.

created_at Datetime

Date and time at which Seam created the warning.


message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.


warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.


Errors

smartthings_failed_to_set_access_code

Failed to set code on SmartThings device.


smartthings_failed_to_set_after_multiple_retries

Failed to set code after multiple retries.


smartthings_no_free_slots_available

No free slots available on the device.


failed_to_set_on_device

Failed to set code on device.


failed_to_remove_from_device

Failed to remove code from device.


duplicate_code_on_device

Duplicate access code detected on device.


duplicate_code_attempt_prevented

An attempt to modify this access code was prevented.


no_space_for_access_code_on_device

No space for access code on device.


igloohome_bridge_too_many_pending_jobs

Igloohome bridge has too many pending jobs in the queue.


igloohome_bridge_offline

Igloohome bridge is offline.


igloohome_offline_access_code_no_variance_available

Lock has reached maximum amount of codes.


kwikset_unable_to_confirm_code

Unable to confirm that the access code is set on Kwikset device.


kwikset_unable_to_confirm_deletion

Unable to confirm the deletion of the access code on Kwikset device.


code_modified_external_to_seam

Code was modified or removed externally after Seam successfully set it on the device.


august_lock_invalid_code_length

Invalid code length for August lock.


august_device_programming_delay

Access code has not yet been fully moved to the device.


august_device_slots_full

All access code slots on the device are full.


august_lock_missing_keypad

August lock is missing a keypad.


august_lock_temporarily_offline

August lock is temporarily offline.


salto_ks_user_not_subscribed

Salto site user is not subscribed.


hubitat_device_programming_delay

Access code has not yet been fully moved to the device.


hubitat_no_free_positions_available

No free positions available on the device.


wyze_duplicate_code_name

Duplicate access code name detected.


wyze_potential_duplicate_code

Potential duplicate access code detected.


dormakaba_oracode_no_valid_user_level

No valid user level for Oracode.


account_disconnected

Account is disconnected


salto_ks_subscription_limit_exceeded

Salto site user limit reached.


device_offline

Device is offline


device_removed

Device has been removed


hub_disconnected

Hub is disconnected


device_disconnected

Device is disconnected


empty_backup_access_code_pool

The backup access code pool is empty.


august_lock_not_authorized

User is not authorized to use the August Lock.


august_lock_missing_bridge

Lock is not connected to the Seam Bridge.


ttlock_lock_not_paired_to_gateway

Lock is not paired with a Gateway.


missing_device_credentials

Missing device credentials.


auxiliary_heat_running

The auxiliary heat is running.


subscription_required

Subscription required to connect.


invalid_credentials

Credentials provided were invalid.


bridge_disconnected


Warnings

smartthings_failed_to_set_access_code

Failed to set code on SmartThings device.


schlage_detected_duplicate

Duplicate access code detected.


schlage_creation_outage

Received an error when attempting to create this code.


code_modified_external_to_seam

Code was modified or removed externally after Seam successfully set it on the device.


delay_in_setting_on_device

Delay in setting code on device.


delay_in_removing_from_device

Delay in removing code from device.


third_party_integration_detected

Third-party integration detected that may cause access codes to fail.


august_device_programming_delay

Access code has not yet been fully moved to the device.


august_lock_temporarily_offline

August lock is temporarily offline.


igloo_algopin_must_be_used_within_24_hours

Algopins must be used within 24 hours.


management_transferred

Management was transferred to another workspace.


kwikset_unable_to_confirm_code

Unable to confirm that the access code is set on Kwikset device.


Events

access_code.created

Properties

access_code_id UUID

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.created

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.changed

Properties

access_code_id UUID

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.changed

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.scheduled_on_device

Properties

access_code_id UUID

code String

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.scheduled_on_device

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.set_on_device

Properties

access_code_id UUID

code String

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.set_on_device

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.removed_from_device

Properties

access_code_id UUID

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.removed_from_device

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.delay_in_setting_on_device

Properties

access_code_id UUID

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.delay_in_setting_on_device

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.failed_to_set_on_device

Properties

access_code_id UUID

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.failed_to_set_on_device

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.deleted

Properties

access_code_id UUID

code String

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.deleted

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.delay_in_removing_from_device

Properties

access_code_id UUID

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.delay_in_removing_from_device

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.failed_to_remove_from_device

Properties

access_code_id UUID

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.failed_to_remove_from_device

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.modified_external_to_seam

Properties

access_code_id UUID

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.modified_external_to_seam

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.deleted_external_to_seam

Properties

access_code_id UUID

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.deleted_external_to_seam

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


access_code.backup_access_code_pulled

Properties

access_code_id UUID

backup_access_code_id String

connected_account_id UUID

created_at Datetime

Date and time at which the event was created.

device_id UUID

event_id UUID

ID of the event.

event_type Enum

Value: access_code.backup_access_code_pulled

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID


Endpoints

Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.

List of Objects

Errors associated with the .

Indicates that the Seam API cannot communicate with , for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also .

List of Objects

Warnings associated with the .

Indicates that the Seam API cannot communicate with , for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also .

An was created.

ID of the .

ID of the .

ID of the .

ID of the .

An was changed.

ID of the .

ID of the .

ID of the .

ID of the .

An was on a device.

ID of the .

Code for the .

ID of the .

ID of the .

ID of the .

An was set on a device.

ID of the .

Code for the .

ID of the .

ID of the .

ID of the .

An was removed from a device.

ID of the .

ID of the .

ID of the .

ID of the .

There was an unusually long delay in setting an on a device.

ID of the .

ID of the .

ID of the .

ID of the .

An failed to be set on a device.

ID of the .

ID of the .

ID of the .

ID of the .

An was deleted.

ID of the .

Code for the .

ID of the .

ID of the .

ID of the .

There was an unusually long delay in removing an from a device.

ID of the .

ID of the .

ID of the .

ID of the .

An failed to be removed from a device.

ID of the .

ID of the .

ID of the .

ID of the .

An was modified outside of Seam.

ID of the .

ID of the .

ID of the .

ID of the .

An was deleted outside of Seam.

ID of the .

ID of the .

ID of the .

ID of the .

A was pulled from the backup access code pool and set on a device.

ID of the .

ID of the .

ID of the .

ID of the .

Creates a new .

Creates new that share a common code across multiple devices.

Deletes an .

Generates a code for an , given a device ID.

Returns a specified .

Returns a list of all .

Retrieves a backup access code for an . See also .

Updates a specified active or upcoming .

Updates that share a common code across multiple devices.

📋
access code
access code
access code
access code
connected account
device
workspace
access code
access code
connected account
device
workspace
access code
scheduled natively
access code
access code
connected account
device
workspace
access code
access code
access code
connected account
device
workspace
access code
access code
connected account
device
workspace
access code
access code
connected account
device
workspace
access code
access code
connected account
device
workspace
access code
access code
access code
connected account
device
workspace
access code
access code
connected account
device
workspace
access code
access code
connected account
device
workspace
access code
access code
connected account
device
workspace
access code
access code
connected account
device
workspace
backup access code
access code
connected account
device
workspace
/access_codes/create
access code
/access_codes/create_multiple
access codes
/access_codes/delete
access code
/access_codes/generate_code
access code
/access_codes/get
access code
/access_codes/list
access codes
/access_codes/pull_backup_access_code
access code
Managing Backup Access Codes
/access_codes/report_device_constraints
/access_codes/update
access code
/access_codes/update_multiple
access codes
access code
ongoing
time-bound
offline access codes
Properties
Errors
Warnings
Events
Endpoints
errors
warnings
Seam Bridge
Seam Bridge
Troubleshooting Your Access Control System
Troubleshooting Your Access Control System