Activate a Device (for eUICC)

POST /devices/profile/actions/activate

Activate a eUICC device, or multiple devices, for a profile.

Contents

See also:

Request Components

Header Parameters

The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit  Getting Started.

Parameter Name Data Type Description
Authorization
required		 string

HTTP Authorization bearer token:
Authorization: Bearer {token}
VZ-M2M-Token
required		 string

A valid session token:
VZ-M2M-Token: {M2Mtoken}
Content-Type
required		 string

Must be application/json:
Content-Type: application/json

HTTP Request

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

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
smsrOid string System Management Service Request Object ID. This is a system generated ID to track transaction requests made by the device.
carrierName
 string The name of the carrier providing cellular network access.
accountName
required		 string The name of the account.
servicePlan
 string The service plan the account is subscribed to. This drives billing for usage.
mdnZipCode
 string The 5-digit zip code of the profile
carrierIpPoolName string The name of the pool of IP addresses assigned to the profile.
primaryPlaceOfUse object  An object with 2 arrays containing the account owner's name and address information.
customerName
required for primaryPlaceOfUse		 object The customer name to be used for line usage taxation.
title
optional for customerName		 string An optional title for the customer, such as “Mr.” or “Dr.”
firstName
required for customerName		 string The customer’s first name. Valid values are any string of up to 20 alphanumeric characters, space, dash, exclamation point, and pound sign.
middleName
optional for customerName		 string The customer’s middle name.
lastName
required for customerName		 string The customer’s last name. Valid values are any string of up to 25 alphanumeric characters, space, dash, exclamation point, and pound sign.
suffix
optional		 string An optional suffix for the customer name, such as “Jr.” or “III.”
address
required for primaryPlaceOfUse		 object The customer address for the line’s primary place of use, for line usage taxation.
addresLine1
required for address		 string The street address for the line’s primary place of use. This must be a physical address for taxation; it cannot be a P.O. box.
addressLine2
optional for address		 string Optional additional street address information.
city
required for address		 string The city where the address is located
state
required for address		 string The two-letter abbreviation of the state for the line’s primary place of use. To see examples of the two-letter codes (i.e. TX for Texas), please see the Wikipedia page on ISO-3166-2:US
zip
required for address		 string The Zip code for the line’s primary place of use.
zip4
optional		 string The ZIP+4 for the line’s primary place of use.
country
required for address		 string Either “US” or “USA” for the country of the line’s primary place of use.

Request Body

Example request:

{
    "devices": [
        {
            "deviceIds": [
                {
                    "kind": "eid",
                    "id": "32-digit EID"
                },
                {
                    "kind": "iccid",
                    "id": "20-digit ICCID"
                }
            ]
        }
    ],
    "carrierName": "name of the mobile service provider",
    "accountName": "0000123456-00001",
    "servicePlan": "name of the service plan (for Consumer eSIM for enterprise the value will be 'HybridESim')",
    "mdnZipCode": "5 digit zip code",
    "carrierIpPoolName":"",
    "primaryPlaceOfUse": {
        "customerName": {
            "title": "Mr",
            "firstName": "First name",
            "lastName": "Surname"
        },
        "address": {
            "addressLine1": "line 1 of the address",
            "city": "city of the address",
            "state": "state of the address",
            "zip": "5 digit zip code",
            "country": "country of the address"
        }
    }
}

Success Response

Status 200

A successful response shows a system generated request ID to track the request.

Example Response:

{
  "requestId": "d1f08526-5443-4054-9a29-4456490ea9f8"
}

Callback Response

These endpoints send responses asynchronously. In order to read the results a callback is required. To learn more about callbacks, please visit About Callback Services. The callback that must be subscribed to is DeviceProfileService.

Example callback responses:

{
   "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":"the name of the mobile service provider",
         "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.
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.
   profileStatus string Indicates the profile state
   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.
   carrierName string The name of the mobile service provider
   profileRole string The role (and permissions) of the profile.
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"
}