Connected Accounts

An external third-party account that your user has authorized Seam to get access to, i.e. an August account with a list of door locks.

The Connected Account object
Attributes
Type
Description
connected_account_id
string
ID of the Connected Account.
created_at
ISO8601
timestamp
Timestamp of the date when the Connected Account was created.
user_identifier
JSON object
The unique identifier for the Connected Account. Could be an email or phone number.
account_type
string
Type of manufacturer the Connected Account belongs to.
Options include: august, schlage, yale, salto, smartthings
account_type_display_name
string
A version of account_type that can go into a user interface
custom_metadata
JSON object
The custom_metadata set on the webview that connected the account.
List of Methods
​Get Connected Account​
Get a Connected Account.
​List Connected Accounts​
Get a list of Connected Accounts.
Connected Account Error Types
Errors are returned in a list:
"errors": [
  {
    "is_connected_account_error": true,
    "error_code": "account_disconnected",
    "message": "Account Disconnected, you may need to reconnect the account with a new webview.",
    "created_at": "2023-06-27T22:50:19.440Z
  }
]
Generic Errors
Seam recommends adding error handling logic to you application for each generic error below. Seam may add more generic errors in the future, so your application should include a fallback case if it encounters an unknown generic error code.
Error Type
Description
account_disconnected
Seam has lost connection to a connected account. This may happen if the third-party provider triggered an access token to be revoked (e.g., after a password change). The account owner needs to reconnect the connected account with a new connect webview.
Connected Account Warning Types
Warnings are returned in a list:
"warnings": [
  {
    "warning_code": "devices_connected_to_other_account",
    "message": "Some devices on this account are already connected to another account.",
    "device_ids": [
      '8e9f2768-18d9-4ac2-845a-2£6fb507ea1f',
      '554acc7a-3cc8-4690-9a5e-b5c863295ee1',
      '06bfa00f-50c5-46ba-853-6£855c11632'
    ],
    "created_at": "2023-06-27T22:50:19.440Z
  }
]
Warning Type
Description
devices_connected_to_other_account
This warning indicates that there are devices linked to the current account that are already associated with a different account. It is important to note that these devices cannot be concurrently connected to multiple accounts. To resolve this issue, you may need to disassociate the devices from the other account before connecting them to the current account. Please ensure that the device IDs mentioned on device_ids are properly managed and linked to the intended account to avoid any connectivity conflicts.

Attributes	Type	Description
`connected_account_id`	string	ID of the Connected Account.
`created_at`	ISO8601 timestamp	Timestamp of the date when the Connected Account was created.
`user_identifier`	JSON object	The unique identifier for the Connected Account. Could be an email or phone number.
`account_type`	string	Type of manufacturer the Connected Account belongs to. Options include: `august`, `schlage`, `yale`, `salto`, `smartthings`
`account_type_display_name`	string	A version of `account_type` that can go into a user interface
`custom_metadata`	JSON object	The `custom_metadata` set on the webview that connected the account.

Error Type	Description
`account_disconnected`	Seam has lost connection to a connected account. This may happen if the third-party provider triggered an access token to be revoked (e.g., after a password change). The account owner needs to reconnect the connected account with a new connect webview.

Warning Type	Description
`devices_connected_to_other_account`	This warning indicates that there are devices linked to the current account that are already associated with a different account. It is important to note that these devices cannot be concurrently connected to multiple accounts. To resolve this issue, you may need to disassociate the devices from the other account before connecting them to the current account. Please ensure that the device IDs mentioned on `device_ids` are properly managed and linked to the intended account to avoid any connectivity conflicts.

Embedding a Connect Webview

Get a Connected Account

Last modified 18d ago

Get Connected Account	Get a Connected Account.
List Connected Accounts	Get a list of Connected Accounts.