The Phone Object

The phone Object

Represents an app user’s mobile phone.

{
  "created_at": "2025-06-14T16:54:17.946540Z",
  "custom_metadata": {
    "id": "internalId1"
  },
  "device_id": "e452f665-a635-4c65-922b-9feab0e0f84f",
  "device_type": "ios_phone",
  "display_name": "My Phone",
  "errors": [],
  "nickname": "My Phone",
  "properties": {
    "assa_abloy_credential_service_metadata": {
      "endpoints": [
        {
          "endpoint_id": "c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
          "is_active": true
        }
      ],
      "has_active_endpoint": true
    }
  },
  "warnings": [],
  "workspace_id": "da8639a4-28a2-4884-a4f9-b7691f4cf336"
}

Properties

String (ISO 8601)

Date and time at which the phone was created.

Object

Optional custom metadata for the phone.

String (UUID)

ID of the phone.

Enum (String)

Type of the phone device, such as ios_phone or android_phone.

String

Display name of the phone. Defaults to nickname (if it is set) or properties.appearance.name, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.

Array

Errors associated with the phone.

Show properties

String (ISO 8601)

Date and time at which Seam created the error.

String

Unique identifier of the type of error.

String

Detailed description of the error.

String

Optional nickname to describe the phone, settable through Seam.

Object

Properties of the phone.

Show properties

Object

ASSA ABLOY Credential Service metadata for the phone.

Show properties

Array

Endpoints associated with the phone.

Show properties

String

ID of the associated endpoint.

Boolean

Indicated whether the endpoint is active.

Boolean

Indicates whether the credential service has active endpoints associated with the phone.

Object

Salto Space credential service metadata for the phone.

Show properties

Boolean

Indicates whether the credential service has an active associated phone.

Array

Warnings associated with the phone.

Show properties

String (ISO 8601)

Date and time at which Seam created the warning.

String

Detailed description of the warning.

String

Unique identifier of the type of warning.

String (UUID)

ID of the workspace that contains the phone.

phone.properties

Object

ASSA ABLOY Credential Service metadata for the phone.

Show properties

Array

Endpoints associated with the phone.

Show properties

String

ID of the associated endpoint.

Boolean

Indicated whether the endpoint is active.

Boolean

Indicates whether the credential service has active endpoints associated with the phone.

Object

Salto Space credential service metadata for the phone.

Show properties

Boolean

Indicates whether the credential service has an active associated phone.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

The Phone Object

The phone Object

Properties

phone.properties

​The phone Object

​Properties

​phone.properties

The phone Object

Properties

phone.properties