Unmanaged Access Codes

PreviousReport Device Access Code Constraints NextList Unmanaged Access Codes

Last updated 2 days ago

Was this helpful?

Unmanaged Access Codes

The unmanaged_access_code Object

Represents an .

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:

{
  access_code_id: [example value],
  code: [example value],
  created_at: [example value],
  device_id: [example value],
  ends_at: [example value],
  errors: [example value],
  is_managed: [example value],
  name: [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.

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_managed Boolean

Indicates that Seam does not manage the access code.

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

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. set indicates that the code is active and operational.

Enum values

set

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.unmanaged.converted_to_managed

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.unmanaged.converted_to_managed

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

access_code.unmanaged.failed_to_convert_to_managed

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.unmanaged.failed_to_convert_to_managed

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

access_code.unmanaged.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.unmanaged.created

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

access_code.unmanaged.removed

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.unmanaged.removed

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

Endpoints

PreviousReport Device Access Code Constraints NextList Unmanaged Access Codes

Last updated 2 days ago

Was this helpful?