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:
empty_backup_access_code_pool
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
august_lock_not_authorized
Indicates that the user is not authorized to use the August lock.
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:
august_lock_not_authorized
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
august_lock_missing_bridge
Indicates that the lock is not connected to a bridge.
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:
august_lock_missing_bridge
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
ttlock_lock_not_paired_to_gateway
Indicates that the lock is not paired with a gateway.
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:
ttlock_lock_not_paired_to_gateway
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
missing_device_credentials
Indicates that device credentials are missing.
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:
missing_device_credentials
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
auxiliary_heat_running
Indicates that the auxiliary heat is running.
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:
auxiliary_heat_running
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
subscription_required
Indicates that a subscription is required to connect.
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:
subscription_required
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
lockly_missing_wifi_bridge
Indicates that the Lockly lock is not connected to a Wi-Fi bridge.
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:
lockly_missing_wifi_bridge
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
invalid_credentials
Indicates that the 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:
invalid_credentials
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 the 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:
bridge_disconnected
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
Type of the access code. ongoing access codes are active continuously until deactivated manually. time_bound access codes have a specific duration.
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_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
smartthings_failed_to_set_access_code
schlage_detected_duplicate
Duplicate access code detected.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
schlage_detected_duplicate
schlage_creation_outage
Received an error when attempting to create this code.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
schlage_creation_outage
code_modified_external_to_seam
Code was modified or removed externally after Seam successfully set it on the device.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
code_modified_external_to_seam
delay_in_setting_on_device
Delay in setting code on device.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
delay_in_setting_on_device
delay_in_removing_from_device
Delay in removing code from device.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
delay_in_removing_from_device
third_party_integration_detected
Third-party integration detected that may cause access codes to fail.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
third_party_integration_detected
august_device_programming_delay
Access code has not yet been fully moved to the device.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
august_device_programming_delay
august_lock_temporarily_offline
August lock is temporarily offline.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
august_lock_temporarily_offline
igloo_algopin_must_be_used_within_24_hours
Algopins must be used within 24 hours.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
igloo_algopin_must_be_used_within_24_hours
management_transferred
Management was transferred to another workspace.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
management_transferred
kwikset_unable_to_confirm_code
Unable to confirm that the access code is set on Kwikset device.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
kwikset_unable_to_confirm_code
Errors
account_disconnected
Indicates that the account is disconnected.
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_invalid_code_length
Invalid code length for August lock.
august_lock_missing_bridge
Indicates that the lock is not connected to a bridge.
august_lock_missing_keypad
August lock is missing a keypad.
august_lock_not_authorized
Indicates that the user is not authorized to use the August lock.
august_lock_temporarily_offline
August lock is temporarily offline.
bridge_disconnected
Indicates that the Seam API cannot communicate with Seam Bridge, for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also Troubleshooting Your Access Control System.
code_modified_external_to_seam
Code was modified or removed externally after Seam successfully set it on the device.
device_disconnected
Indicates that the device is disconnected.
device_offline
Indicates that the device is offline.
device_removed
Indicates that the device has been removed.
dormakaba_oracode_no_valid_user_level
No valid user level for Oracode.
duplicate_code_attempt_prevented
An attempt to modify this access code was prevented.