> ## Documentation Index
> Fetch the complete documentation index at: https://docs.seam.co/llms.txt
> Use this file to discover all available pages before exploring further.

# The Phone Object

> Learn how the phone object represents an app user mobile phone that holds mobile credentials, including its properties and lifecycle events.

## The phone Object

Represents an app user's mobile phone.

<ResponseExample>
  ```json Phone theme={null}
  {
    "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"
  }
  ```
</ResponseExample>

***

## Properties

<ResponseField name="created_at" type="String (ISO 8601)">
  Date and time at which the phone was created.
</ResponseField>

<ResponseField name="custom_metadata" type="object">
  Optional [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
</ResponseField>

<ResponseField name="device_id" type="String (UUID)">
  ID of the phone.
</ResponseField>

<ResponseField name="device_type" type="Enum (String)">
  Device type for phones.
</ResponseField>

<ResponseField name="display_name" type="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.
</ResponseField>

<ResponseField name="errors" type="Array">
  Errors associated with the phone.
</ResponseField>

<ResponseField name="nickname" type="String">
  Optional nickname to describe the phone, settable through Seam.
</ResponseField>

<ResponseField name="properties" type="Object">
  Properties of the phone.

  <Expandable title="properties">
    <ResponseField name="assa_abloy_credential_service_metadata" type="Object">
      ASSA ABLOY Credential Service metadata for the phone.

      <Expandable title="properties">
        <ResponseField name="endpoints" type="Array">
          Endpoints associated with the phone.
        </ResponseField>

        <ResponseField name="has_active_endpoint" type="Boolean">
          Indicates whether the credential service has active endpoints associated with the phone.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="salto_space_credential_service_metadata" type="Object">
      Salto Space credential service metadata for the phone.

      <Expandable title="properties">
        <ResponseField name="has_active_phone" type="Boolean">
          Indicates whether the credential service has an active associated phone.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="warnings" type="Array">
  Warnings associated with the phone.
</ResponseField>

<ResponseField name="workspace_id" type="String (UUID)">
  ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the phone.
</ResponseField>

## phone.properties

<ResponseField name="assa_abloy_credential_service_metadata" type="Object">
  ASSA ABLOY Credential Service metadata for the phone.

  <Expandable title="properties">
    <ResponseField name="endpoints" type="Array">
      Endpoints associated with the phone.
    </ResponseField>

    <ResponseField name="has_active_endpoint" type="Boolean">
      Indicates whether the credential service has active endpoints associated with the phone.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="salto_space_credential_service_metadata" type="Object">
  Salto Space credential service metadata for the phone.

  <Expandable title="properties">
    <ResponseField name="has_active_phone" type="Boolean">
      Indicates whether the credential service has an active associated phone.
    </ResponseField>
  </Expandable>
</ResponseField>