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.
When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>device_offline</code>
is_device_errorBoolean
messageString
device_removed
Device has been removed
created_atDatetime
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>device_removed</code>
is_device_errorBoolean
messageString
hub_disconnected
Hub is disconnected
created_atDatetime
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>hub_disconnected</code>
is_device_errorBoolean
messageString
device_disconnected
Device is disconnected
created_atDatetime
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>device_disconnected</code>
is_device_errorBoolean
messageString
empty_backup_access_code_pool
The backup access code pool is empty.
created_atDatetime
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>empty_backup_access_code_pool</code>
is_device_errorBoolean
messageString
august_lock_not_authorized
User is not authorized to use the August Lock.
created_atDatetime
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>august_lock_not_authorized</code>
is_device_errorBoolean
messageString
august_lock_missing_bridge
Lock is not connected to the Seam Bridge.
created_atDatetime
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>august_lock_missing_bridge</code>
is_device_errorBoolean
messageString
ttlock_lock_not_paired_to_gateway
Lock is not paired with a Gateway.
created_atDatetime
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>ttlock_lock_not_paired_to_gateway</code>
is_device_errorBoolean
messageString
missing_device_credentials
Missing device credentials.
created_atDatetime
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>missing_device_credentials</code>
is_device_errorBoolean
messageString
auxiliary_heat_running
The auxiliary heat is running.
created_atDatetime
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>auxiliary_heat_running</code>
is_device_errorBoolean
messageString
subscription_required
Subscription required to connect.
created_atDatetime
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>subscription_required</code>
is_device_errorBoolean
messageString
invalid_credentials
Credentials provided were invalid.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>invalid_credentials</code>
is_bridge_errorBoolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_errorBoolean
Indicates whether the error is related specifically to the connected account.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
bridge_disconnected
Indicates that the Seam API cannot communicate with Seam Bridge, for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also Troubleshooting Your Access Control System.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
- <code>bridge_disconnected</code>
is_bridge_errorBoolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_errorBoolean
Indicates whether the error is related specifically to the connected account.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
is_managedBoolean
Indicates that Seam does not manage the access code.
nameString
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).
starts_atDatetime
Date and time at which the time-bound access code becomes active.
statusEnum
Current status of the access code within the operational lifecycle. set indicates that the code is active and operational.
Enum values
set
typeEnum
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.
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
Indicates that the Seam API cannot communicate with Seam Bridge, for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also Troubleshooting Your Access Control System.
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.