The payload that provides device info on private network deployments, including geographical location, preference over Wi-Fi, and network deployment type.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
Geofences Geofences A list of up to 1000 geofences for private networks. Geofencing is only used on iPhone. 1 subkey | array | optional | — | ✓Yes | iOS (17.0+) |
└─ GeofenceItem GeofenceItem A geofence for a private network. 4 subkeys | dictionary | — | ✓Yes | iOS (17.0+) | |
└─ └─ Longitude Longitude The longitude of the geofence. Range: -180 - 180 | real | required | — | ✓Yes | iOS (17.0+) |
└─ └─ Latitude Latitude The latitude of the geofence. Range: -90 - 90 | real | required | — | ✓Yes | iOS (17.0+) |
└─ └─ Radius Radius Specifies the radius of the geofence in meters. Set this value slightly greater than the private cellular network coverage area. Range: 100 - 6500 | real | required | — | ✓Yes | iOS (17.0+) |
└─ └─ GeofenceId GeofenceId A geofence identifier that's unique within a list of geofences. | string | required | — | ✓Yes | iOS (17.0+) |
DataSetName DataSetName The name of the private network configuration data set. | string | required | — | ✓Yes | iOS (17.0+) |
VersionNumber VersionNumber The version number of this dataset that the system uses to track updates. | string | required | — | ✓Yes | iOS (17.0+) |
CellularDataPreferred CellularDataPreferred Set to `true` to prefer this private network over Wi-Fi. | boolean | optional | false | ✓Yes | iOS (17.0+) |
EnableNRStandalone EnableNRStandalone Set to `true` if this private network is NR Standalone. | boolean | optional | false | ✓Yes | iOS (17.0+) |
NetworkIdentifier NetworkIdentifier A string using the 3GPP "Coordinated NID" (option 1 or option 2) format (defined in 3GPP 31.102, Section 12.7.1). The device uses this value to match a SIM present on the device.
All combinations of `NetworkIdentifier` and `CsgNetworkIdentifier` must be unique across all profiles installed on the device. | string | optional | — | ✓Yes | iOS (18.0+) |
CsgNetworkIdentifier CsgNetworkIdentifier A string using the 3GPP "CSG_ID" format (defined in 3GPP 23.003, Section 4.7). The device uses this value to match a SIM present on the device.
All combinations of `NetworkIdentifier` and `CsgNetworkIdentifier` must be unique across all profiles installed on the device. | string | optional | — | ✓Yes | iOS (18.0+) |
