Create a Sandbox Phone

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

POST /phones/simulate/create_sandbox_phone

JavaScript

Seam SDK

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, }, }); /* { "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" } */

200

{
  "ok": true,
  "phone": {
    "created_at": "2023-11-07T05:31:56Z",
    "custom_metadata": {},
    "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "display_name": "<string>",
    "errors": [
      {
        "error_code": "<string>",
        "message": "<string>"
      }
    ],
    "properties": {
      "assa_abloy_credential_service_metadata": {
        "endpoints": [
          {
            "endpoint_id": "<string>",
            "is_active": true
          }
        ],
        "has_active_endpoint": true
      },
      "salto_space_credential_service_metadata": {
        "has_active_phone": true
      }
    },
    "warnings": [
      {
        "message": "<string>",
        "warning_code": "<string>"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nickname": "<string>"
  }
}

Authorizations

api_keypat_with_workspaceconsole_session_with_workspace

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

user_identity_id · string<uuid> · 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.

Show child attributes

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.

Show child attributes

Response

200

application/json

OK

ok · boolean · required

phone · object · required

Represents an app user's mobile phone.

Show child attributes