Register an Apple device

POST/children/{childID}/devices

Register a device for on-device policy enforcement. Returns a one-time API key the iOS app stores in Keychain.

Auth:Bearer

Path parameters

childID

uuidrequired

Request body

device_name

stringrequired
device_model

stringrequired
os_version

stringrequired
app_version

stringrequired
apns_token

string
capabilities

Apple frameworks the device supports (e.g. FamilyControls, ManagedSettings, DeviceActivity)

string[]

Response

device

object
api_key

One-time device API key (store in Keychain)

string
Request
bash
curl -X POST "https://prodapi.phosra.com/api/v1/children/{childID}/devices" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "device_name": "string",
  "device_model": "string",
  "os_version": "string",
  "app_version": "string",
  "apns_token": "string",
  "capabilities": [
    "string"
  ]
}'
Response
json
{
  "device": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "child_id": "550e8400-e29b-41d4-a716-446655440000",
    "family_id": "550e8400-e29b-41d4-a716-446655440000",
    "platform_id": "string",
    "device_name": "string",
    "device_model": "string",
    "os_version": "string",
    "app_version": "string",
    "apns_token": "string",
    "capabilities": [
      "string"
    ],
    "enforcement_summary": {},
    "last_seen_at": "2025-01-15T09:30:00Z",
    "last_policy_version": 0,
    "status": "active",
    "created_at": "2025-01-15T09:30:00Z",
    "updated_at": "2025-01-15T09:30:00Z"
  },
  "api_key": "string"
}