Enable a Device Profile

Enable a Local Profile on a Device:
POST /devices/profile/actions/enable

Enables a downloaded eUICC local profile on a device, which enables services activated for the device so that the device can attach to the Verizon Wireless network.

NOTE: This API is currently in limited release, and is not yet available to all customer accounts.

Contents

See also:
Working with eUICC Devices
Download a Device Profile
Disable a Device Profile
Delete a Device Profile

Uses and Requirements

The local profile must be on the device before you can enable it. You can use the download device profile request to download a profile to devices.

ThingSpace sends an asynchronous DeviceProfileResponse callback message when it receives a response from the SM-SR system about a profile state change. If a time-out situation occurs, such as when a device is unreachable, the initial callback will include a “warning” status, and a later response will indicate either success or failure.

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/devices/profile/actions/enable

Resource Path and Query Parameters

None.

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 Body

The request body identifies the device on which you want to enable the local profile.

Parameter Name Data Type Description
devices
required
array of deviceIds objects The EID and ICCID of the device for which you want to enable a local profile.
kind,
id

required for devices
strings The type and value of the device identifier.
  • EID (required)
  • ICCID (required)
accountName
required
string The name of a billing account.
An account name is usually numeric, and must include any leading zeros.
smsrOid
required
string The Object ID of the SMSR system.

Example Request Body

Request to enable the local profile on a device:

{
  "devices":[  
    {
      "deviceIds":[
        {  
          "kind":"eid",
          "id":"666456789123456789123456784008"
        },
        {
          "kind":"iccid",
          "id":"89148000000840784259"
        }
      ]
    }
  ],
  "accountName":"1223334444-00001",
  "smsrOid": "1.3.6.1.4.1.31746.1.500.200.101.5"
}

Success Responses

Status 200

Parameter Name Data Type Description
requestId string A unique string that associates the request with the results that are sent via a callback message.
ThingSpace will send a separate callback message for each device that was in the request indicating whether the operation succeeded for that device. All of the callback messages will have the same requestId.

Example Success Response

{
  "requestId": "595f5c44-c31c-4552-8670-020a1545a84d"
}

Example Success Callback Response

{
  "username":"",
  "password":"",
  "requestId":"595f5c44-c31c-4552-8670-020a1545a84d",
  "deviceIds":[  
    {  
      "id":"666456789014008",
      "kind":"imei"
    },
    {  
      "id":"666456789123456789123456784008",
      "kind":"eid"
    }
  ],
  "deviceResponse":{  
    "deviceProfileResponse":{  
      "deviceIdentifierCollection":[  
        {  
          "id":"666456789014008",
          "kind":"imei"
        },
        {  
          "id":"89148000000840784259",
          "kind":"iccid"
        },
        {  
          "id":"2022326360",
          "kind":"mdn"
        },
        {  
          "id":"666456789123456789123456784008",
          "kind":"eid"
        }
      ],
      "ipAddress":"101.0.1.216",
      "state":"Active",
      "servicePlan":"RP4235311",
      "deviceCredential":{  
        "username":"2022326360@vzw4g.com",
        "password":"2022326360"
      },
      "smsrOid":"1.3.6.1.4.1.31746.1.500.200.101.5",
      "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"
    }
  },
  "status":"Success",
  "callbackCount":1,
  "maxCallbackThreshold":4
}

Failure Responses

Status 400

All error messages are returned in this format:

{
  "errorCode": "error code string",
  "errorMessage": "error message string"
}

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.

Try It Out!