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 (String, Boolean values)

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

Array of errors associated with the device. Each error object within the array contains two fields: error_code and message. error_code is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. message provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.

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

Array of warnings associated with the device. Each warning object within the array contains two fields: warning_code and message. warning_code is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. message provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.

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