Access Code Requirements for Door Locks

Learn about the specific requirements and constraints for setting access codes on door locks.

Some models of door locks have specific requirements and constraints when it comes to setting PIN codes. It's essential to be aware of these to ensure seamless functionality and security. The requirements can be fetched by making a Get Device or List Devices (or List Locks) request.

Sample set of access code requirements:

{
  "device": {
    "device_id": "00000000-0000-0000-0000-000000000000",
    "capabilities_supported": [
      "access_code",
      "lock"
    ],
    "properties": {
      "supported_code_lengths": [
        4,
        5,
        6,
        7,
        8
      ],
      "max_active_codes_supported": 250,
      "code_constraints": [
        {
          "constraint_type": "no_zeros"
        },
        {
          "constraint_type": "name_length",
          "min_length": 1,
          "max_length": 12
        }
      ],
      "supports_backup_access_code_pool": true
      ...
    },
    ...
  },
  ...
}

Request:

pprint(seam.locks.get(device="ed4bb795-f29f-43e5-bc0f-35f69f9141b5"))

Response:

Device(device_id='ed4bb795-f29f-43e5-bc0f-35f69f9141b5',
       device_type='nuki_lock',
       location=None,
       properties={'battery': {'level': 0.86, 'status': 'full'},
                   'battery_level': 0.86,
                   'code_constraints': [{'constraint_type': 'cannot_start_with_12'},
                                        {'constraint_type': 'no_zeros'},
                                        {'constraint_type': 'name_length',
                                         'max_length': 20}],
                   'has_native_entry_events': True,
                   'image_alt_text': 'Nuki Smart Lock 3.0 Pro Black, Front',
                   'image_url': 'https://connect.getseam.com/assets/images/devices/nuki_smart_lock_3_pro_black.png',
                   'keypad_battery': {'level': 1},
                   'locked': False,
                   'manufacturer': 'nuki',
                   'model': {'display_name': 'Lock',
                             'manufacturer_display_name': 'Nuki'},
                   'name': 'Office Lock',
                   'nuki_metadata': {'device_id': '3',
                                     'device_name': 'Office Lock',
                                     'keypad_battery_critical': False},
                   'online': True,
                   'supported_code_lengths': [6],
                   'supports_backup_access_code_pool': True},
       capabilities_supported=['access_code', 'lock'],
       errors=[],
       warnings=[],
       connected_account_id='cac74c00-443b-440f-820e-e2907277fd9f',
       workspace_id='398d80b7-3f96-47c2-b85a-6f8ba21d07be',
       created_at='2023-10-19T04:43:40.852Z',
       is_managed=True)

Supported Code Lengths

This property is denoted as supported_code_lengths and contains an array of numbers. These numbers represent the various lengths (in terms of digits) allowed for a PIN code. For example, if the array contains [4, 6], it means the door lock can accept 4-digit or 6-digit PIN codes.

Example Payload:

"supported_code_lengths": [
    4,
    5,
    6,
    7,
    8
]

Maximum Set Codes

The property max_active_codes_supported indicates the total number of codes that can be simultaneously set on a door lock. For the door locks that accommodate native scheduling, this count will includes future scheduled codes that are set on the lock.

Example Payload:

"max_active_codes_supported": 250

PIN Code Constraints

The code_constraints property gives insight into various conditions or limitations that apply to PIN codes. Each constraint in the code_constraints array is an object with at least the constraint_type property.

Example Payload:

"code_constraints": [
    {
        "constraint_type": "no_zeros"
    },
    {
        "constraint_type": "name_length",
        "min_length": 1,
        "max_length": 12
    }
]

The constraint_type property can be one of the following:

Last updated

Logo

© Seam Labs, Inc. All rights reserved.