Standard APIsConnectivity ManagementAPI EndpointsEmbedded SIM Including Consumer eSIMActivate Device Through Profile
API Reference
Activate Enable a Device (for eUICC)
Uses and Requirements
Enable a eUICC device, or multiple devices, for a profile. Enabling a device brings the device under the control of a profile.
Request Components
HTTP Request:
POST https://thingspace.verizon.com/api/m2m/v1/devices/profile/actions/activate_enable
Header Parameters
The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization required | string | HTTP Authorization bearer token. |
| VZ-M2M-Token required | string | A valid session token returned by POST /session/login. |
| Content-Type required | string | Must be application/json. |
Request Parameters
| Parameter | Data Type | Description |
|---|---|---|
| devices required | array | An array of deviceIds. Each deviceId will contain: id kind |
| id | string | The numeric ID of the device. |
| kind | string | The the type of device ID represented by the ID value. This could be: imei iccid mdn eid |
| accountName required | string | The name of the account. |
| servicePlan | string | The name of the service plan controlling billing for the account. |
| mdnZipCode | string | The 5-digit zip code of the profile |
Request Body
{
"devices":[
{
"deviceIds":[
{
"id":"15-digit IMEI",
"kind":"imei"
},
{
"id":"32-digit EID",
"kind":"eid"
}
]
}
],
"accountName":"0000123456-00001",
"servicePlan":"name of the service plan",
"mdnZipCode":"5 digit zip code"
}Success Responses
A successful response shows a system generated request ID to track the request.
Example Success Response:
{
"requestId": "595f5c44-c31c-4552-8670-020a1545a84d"
}Callback Response Parameters
These endpoints send responses asynchronously. In order to read the results a callback is required.To learn more about callback, please visti About Callback Services.
Example callback response:
{
"username":"username",
"password":"password",
"requestId":"d1f08526-5443-4054-9a29-4456490ea9f8",
"deviceIds":[
{
"id":"20-digit ICCID",
"kind":"iccid"
},
{
"id":"15-digit IMEI",
"kind":"imei"
},
{
"id":"32-digit EID",
"kind":"eid"
},
{
"id":"10-digit MDN",
"kind":"mdn"
}
],
"deviceResponse":{
"deviceProfileResponse":{
"deviceIdentifierCollection":[
{
"id":"20-digit ICCID",
"kind":"iccid"
},
{
"id":"15-digit IMEI",
"kind":"imei"
},
{
"id":"32-digit EID",
"kind":"eid"
},
{
"id":"10-digit MDN",
"kind":"mdn"
}
],
"state":"Active",
"profileStatus":"ENABLE",
"euiccStatus":"EXECUTED_SUCCESS",
"euiccStatusCode":"1.2.365",
"euiccStatusDesc":"EUICC device profile has been updated",
"euiccSubAddressUpdateStatus":"EXECUTED_SUCCESS",
"euiccSubAddressUpdateStatusCode":"1",
"euiccSubAddressUpdateStatusDesc":"SUCCESS: Address has been updated",
"carrierName":"VerizonWireless",
"profileRole":"LEAD"
}
},
"status":"SUCCESS",
"callbackCount":1,
"maxCallbackThreshold":4
}Callback Parameters
| Parameter | Data Type | Description |
|---|---|---|
| username | string | The username making the request. |
| password | string | The password associated with the username. |
| requestId | string | The requestId being viewed. This is a system generated value from the request above. |
| deviceIds | array | An array of devices being queried by the request. Each deviceId will contain: id kind |
| id | string | The numeric ID of the device. |
| kind | string | The the type of device ID represented by the ID value. This could be: imei iccid mdn eid |
| deviceResponse | array | Contains the deviceProfileResponse, status and number of callback records returned. |
| deviceProfileResponse | array | Contains the details and status of the devices and the request. |
| deviceIdentifierCollection | array | Similar to deviceIds above, but this lists the devices responding. |
| state | string | The state of the device(s) responding. |
| smsrOid | string | System Management Service Request Object ID. This is a system generated ID to track transaction requests made by the device. |
| profileStatus | string | Indicates the profile state and will show what request was made. |
| euiccStatus | string | This shows how the device, or devices, has responded to the request. eUICC is embedded universal integrated circuit card and refers to the SIM card for the device. For more information, visit Working with eUICC Devices. |
| euiccStatusCode | string | The system generated status code for an eUICC device. |
| euiccStatusDesc | string | Description of the eUICC status code |
| euiccSubAddressUpdateStatus | string | Status of any address update requests. |
| euiccSubAddressUpdateStatusCode | string | A system generated status code for an address update request. |
| euiccSubAddressUpdateStatusDesc | string | A description of the status code from above. |
| status | string | The status of the deviceResponse. |
| callbackCount | string | The number of responses for deviceResponse found. |
| maxCallbackThreshold | string | The maximum number of responses for deviceResponse allowed. |
Failure Responses
All error responses will be in the following format
{
"errorCode": "The 3-digit HTML error code",
"errorMessage": "string"
}