Seam provides a universal API to connect and control many brands of smart locks. This guide provides a rapid introduction to connecting and controlling your Kwikset Halo lock using the Seam API. To learn more about other smart lock brands supported by Seam such as Yale, Schlage, and August, head over to our integration page.
Enabling MFA (Multi-Factor Authentication) on your Kwikset app can block our login flow from successfully authorizing with your account.
Please ensure your Kwikset MFA settings are disabled before attempting to connect your account with Seam. After connecting your account, you can re-enable your MFA settings.
To disable MFA, head to Account Settings in your Kwikset app:
1 — Install Seam SDK
Seam provides client libraries for many languages, such as JavaScript, Python, Ruby, PHP, and others, as well as a Postman collection and OpenAPI spec.
This guide uses a Sandbox Workspace. Only virtual devices can be connected. If you need to connect a real Kwikset Halo Lock, use a non-sandbox workspace and API key.
2 — Link Kwikset Account with Seam
To control your Kwikset Halo lock via the Seam API, you must first authorize your Seam workspace against your Kwikset account. To do so, Seam provides Connect Webviews: pre-built UX flows that walk you through authorizing your application to control your Kwikset Halo lock.
Request a Connect Webview
from seam import Seamseam =Seam()webview = seam.connect_webviews.create(accepted_providers=["kwikset"])assert webview.login_successful isFalse# Send the webview URL to your userprint(webview.url)
import { Seam } from'seam'constseam=newSeam()constconnectWebview=awaitseam.connectWebviews.create({ accepted_providers: ['kwikset'],})console.log(connectWebview.login_successful) // false// Send the webview URL to your userconsole.log(connectWebview.url)
require"seam"seam =Seam.new(api_key: "MY_API_KEY")webview = seam.connect_webviews.create( accepted_providers: ["kwikset"])puts webview.login_successful # false# Send the webview URL to your userputs webview.url
Authorize Your Workspace
Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Kwikset sandbox test accounts credentials below:
email: jane@example.com
password: 1234
Enabling MFA (Multi-Factor Authentication) on your Kwikset app can block our login flow from successfully authorizing with your account.
Please ensure your Kwikset MFA settings are disabled before attempting to connect your account with Seam. After connecting your account, you can re-enable your MFA settings.
To disable MFA, head to Account Settings in your Kwikset app:
Confirm the Connect Webview was successful by querying its status:
After a Kwikset account is linked with Seam, you can retrieve devices for this Kwikset account. The Seam API exposes most of the device's properties such as battery level or door lock status.
In the Kwikset app, you cannot see access codes that were set from an external source (such as Seam) unless you are connected through Bluetooth to the lock.
If you're connected through Wi-Fi and not Bluetooth, the Kwikset app only shows the access codes that you have set from the app itself and not the codes set from Seam.
Some Kwikset locks have a keypad paired to them to program access codes. These codes can then be entered to unlock a Kwikset lock.
The Seam API makes it easy to program both ongoing codes and timebound codes on a Kwikset lock. You can find out more about Kwikset lock access code in our core concept section on access codes.
Access Code Constraints
Kwikset locks place the following constraints on access code attributes:
Access code name must contain 2-14 characters.
You can create a Seam access code for Kwikset with a name longer than 14 characters. The full name is stored in Seam, but on the Kwikset device, the name is truncated to 14 characters.
PIN code length must be 4-8 digits.
A timebound code requires both a starts_at timestamp and an ends_at timestamp.
A timebound code's starts_at timestamp must be greater than the current time. For best results, set starts_at at least 15 minutes ahead of the current time.
# create an ongoing codeseam.access_codes.create( device=some_lock, code="123456", name="My Access Code")# create a timebound codeseam.access_codes.create( device=some_lock, code="888888", name="Scheduled Code", starts_at="2028-08-12T19:23:42+0000", ends_at="2028-08-13T19:23:42+0000")# you can use a device or a device_id as the "device" parameterseam.access_codes.list(device=some_lock)# [# AccessCode(# access_code_id='af5272b1-2a49-4eb5-9388-2447fc7b5bd1',# type='ongoing',# code='123459'# ),# AccessCode(# access_code_id='8c2db4da-b137-4c08-a2c3-d611e6ff91b3',# type='timebound',# code='888888',# starts_at='2028-08-12T19:24:00.000Z',# ends_at='2028-08-13T19:24:00.000Z',# )# ]
// create an ongoing codeawaitseam.accessCodes.create({ device_id:someLock.device_id, code:'123456', name:'My Access Code',})// create a timebound codeawaitseam.accessCodes.create({ device_id:someLock.device_id, code:'888888', name:'Scheduled Code', starts_at:'2028-11-12T19:23:42+0000', ends_at:'2028-11-13T19:23:42+0000',})// use a device_id as the "device_id" parameterawaitseam.accessCodes.list({ device_id:someLock.device_id,})/*[ { code: '1988', type: 'ongoing', status: 'setting', created_at: '2022-08-26T12:50:17.858Z', access_code_id: '26d6138c-6524-4f3c-ac96-43cc3bea0a8d' }, { type: 'timebound', code: '888888', starts_at: '2028-08-12T19:24:00.000Z', ends_at: '2028-08-13T19:24:00.000Z', access_code_id: '8c2db4da-b137-4c08-a2c3-d611e6ff91b3', }]*/
Now that you've completed this guide, you can try to connect a real Kwikset Halo device. To do so, make sure to switch to a non-sandbox workspace and API key as real devices cannot be connected to sandbox workspaces.
In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources:
