Create a Sandbox Phone

• Request Parameters

• Response

Creates a new simulated phone in a sandbox workspace. See also Creating a Simulated Phone for a User Identity.

JavaScript

Creates a new simulated phone in a sandbox workspace.

Code:

await seam.phones.simulate.createSandboxPhone({
  custom_sdk_installation_id: "visionline_sdk",
  user_identity_id: "799f9914-f2c2-4087-ab34-f1ffb44d6a0b",
  phone_metadata: {
    operating_system: "android",
    os_version: 10,
    device_manufacturer: "Samsung",
    device_model: "Samsung Galaxy S10",
  },
  assa_abloy_metadata: {
    ble_capability: "true,",
    hce_capability: "false,",
    nfc_capability: "false,",
    application_version: "1.0.0",
    seos_applet_version: "1.0.0",
    seos_tsm_endpoint_id: 1,
  },
});

Output:

{
  "created_at": "2025-06-14T16:54:17.946540Z",
  "custom_metadata": { "id": "internalId1" },
  "device_id": "e452f665-a635-4c65-922b-9feab0e0f84f",
  "device_type": "android_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"
}

cURL

Python

Ruby

PHP

Seam CLI

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

user_identity_id String (Required)

ID of the user identity that you want to associate with the simulated phone.

---

assa_abloy_metadata Object

ASSA ABLOY metadata that you want to associate with the simulated phone.

application_version String

Application version that you want to use for the simulated phone.

---

ble_capability Boolean

Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.

---

hce_capability Boolean

Indicates whether the simulated phone should have host card emulation (HCE) capability.

---

nfc_capability Boolean

Indicates whether the simulated phone should have near-field communication (NFC) capability.

---

seos_applet_version String

SEOS applet version that you want to use for the simulated phone.

---

seos_tsm_endpoint_id Number

ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.

---

custom_sdk_installation_id String

ID of the custom SDK installation that you want to use for the simulated phone.

---

phone_metadata Object

Metadata that you want to associate with the simulated phone.

device_manufacturer String

Manufacturer that you want to use for the simulated phone.

---

device_model String

Device model that you want to use for the simulated phone.

---

operating_system Enum

Mobile operating system that you want to use for the simulated phone.

Enum values:

• android

• ios

---

os_version String

Mobile operating system version that you want to use for the simulated phone.

---

Response

Returns: phone

JSON

{
  "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"
}