Activate an individual device to use the 5G Business Internet Fixed Wireless Access service. Please note that These plans are fixed location plans. It is agreed to only use the Service at the qualified service address that Verizon Wireless approved at the time the Service was activated. If the Service is used outside of the qualified service address without the specific written approval of Verizon Wireless, Verizon Wireless reserves the right to terminate the Service at any time thereafter upon written notice. For more information and best practices, please visit Best Practices for Activation.
POST https://thingspace.verizon.com/api/m2m/v1/devices/actions/activate
None.
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 parameters. All parameters listed are required unless marked "optional".
Parameter Name | Data Type | Description |
---|---|---|
accountName | string | The name of a billing account. This value is numeric and must include any leading zeroes. |
servicePlan | string | The service plan code that you want to assign to all specified devices. Set this parameter to one of the code values returned by GET /plans/{accountname}. Verizon Wireless provides service plan codes at the time of on-boarding and subsequently whenever there are any changes to the service plan. NOTE: Any devices in the request that are not supported by the service plan will not activate. |
deviceListWithServiceAddress | array | An array of Device ID information and customer information objects, including the object defining the address of where the device will be used. |
deviceIds | array | An array of Device ID objects. |
kind, |
object | The type and value of the device identifier. IMEI (decimal, 15 digits) and ICCID (decimal, 20 digits) in that order. |
primaryPlaceOfUse | object | The customer name and the address of the device’s primary place of use. |
address |
object | The customer address for the line’s primary place of use. |
addresLine1 |
string | The street address for the line’s primary place of use. This must be a physical address; it cannot be a P.O. box. |
city |
string | The city for the line’s primary place of use. |
state |
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 |
string | The Zip code for the line’s primary place of use. |
zip4 |
string | The ZIP+4 for the line’s primary place of use. |
country |
string | “USA” for the country of the line’s primary place of use. |
phone |
string | A phone number where the customer can be reached. |
phoneType |
string | A single letter to indicate the customer phone type:
|
emailAddress |
string | An email address for the customer. |
customerName
|
object | The customer name to be used for line usage taxation. |
title
optional |
string | An optional title for the customer, such as “Mr.” or “Dr.” |
firstName
|
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 |
string | The customer’s middle name. |
lastName
|
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.” |
publicIpRestriction optional |
string | For devices with static IP addresses on the public network, this specifies whether the devices have general access to the Internet. Valid values are “restricted” or “unrestricted”.
|
carrierName | string | The carrier that will perform the activation. This parameter is only required if you have more than one carrier. If you have only one carrier you do not need to specify the carrierName; your carrier will be used by default. |
mdnZipCode | string | The Zip code of the location where the line of service will primarily be used, or a Zip code that you have been told to use with these devices. For accounts that are configured for geographic numbering, this is the ZIP code from which the MDN will be derived. NOTE: you should set the mdnZipCode value to match the Zip value defined for primary place of use. |
{
"accountName":"0000123456-00001",
"servicePlan":"service plan name",
"deviceListWithServiceAddress":[
{
"deviceIds":[
{
"id":"15-digit IMEI",
"kind":"IMEI"
},
{
"kind":"iccid",
"id":"20-digit ICCID"
}
],
"primaryPlaceOfUse":{
"address":{
"addressLine1":"number and street",
"city":"city",
"state":"2-letter state ID (ISO 3166-2)",
"country":"USA",
"zip":"5-digit zip code",
"zip4":"",
"phone":"10-digit phone number",
"phoneType":"W",
"emailAddress":"email@emailaddress.com"
},
"customerName":{
"firstName":"first name",
"lastName":"last name",
"middleName":"middle name",
"title":"Mr",
"suffix":"Jr"
}
}
}
],
"publicIpRestriction":"Unrestricted",
"carrierName":"Verizon Wireless",
"mdnZipCode":"5-digit zip code"
}
{
"accountName":"0000123456-00001",
"servicePlan":"service plan name",
"deviceListWithServiceAddress":[
{
"deviceIds":[
{
"id":"15-digit IMEI",
"kind":"IMEI"
},
{
"kind":"iccid",
"id":"20-digit ICCID"
}
],
"primaryPlaceOfUse":{
"address":{
"addressLine1":"number and street",
"city":"city",
"state":"2-letter state ID (ISO 3166-2)",
"country":"USA",
"zip":"5-digit zip code",
"zip4":"",
"phone":"10-digit phone number",
"phoneType":"W",
"emailAddress":"email@emailaddress.com"
},
"customerName":{
"firstName":"first name",
"lastName":"last name",
"middleName":"middle name",
"title":"Mr",
"suffix":"Jr"
}
}
}
],
"publicIpRestriction":"",
"carrierName":"Verizon Wireless",
"mdnZipCode":"5-digit zip code"
}
{
"accountName":"0000123456-00001",
"servicePlan":"service plan name",
"deviceListWithServiceAddress":[
{
"deviceIds":[
{
"id":"15-digit IMEI",
"kind":"IMEI"
},
{
"kind":"iccid",
"id":"20-digit ICCID"
}
],
"primaryPlaceOfUse":{
"address":{
"addressLine1":"number and street",
"city":"city",
"state":"2-letter state ID (ISO 3166-2)",
"country":"USA",
"zip":"5-digit zip code",
"zip4":"",
"phone":"10-digit phone number",
"phoneType":"W",
"emailAddress":"email@emailaddress.com"
},
"customerName":{
"firstName":"first name",
"lastName":"last name",
"middleName":"middle name",
"title":"Mr",
"suffix":"Jr"
}
}
}
],
"carrierName":"Verizon Wireless",
"mdnZipCode":"5-digit zip code"
}
Status 200
{
"requestId": "be36accb-0a9a-4367-93ab-0af6c4ed256a"
}
{
"requestId": "be36accb-0a9a-4367-93ab-0af6c4ed256a",
"deviceIds": [
{
"id": "15-digit IMEI",
"kind": "imei"
}
],
"deviceResponse": {
"externalProvisioningChangeResponse": {
"change": "Device Detection",
"deviceInfo": {
"preIMEI": "15-digit IMEI",
"preSKU": "VZW080000250070",
"accountName": "0000123456-00001",
"billingCycleEndDate": "2023-01-10T00:00:00.0000000Z",
"carrierInformations": [
{
"carrierName": "Verizon Wireless",
"servicePlan": "5GBI200MBPSCband",
"state": "active"
}
],
"connected": true,
"createdAt": "2022-11-01T19:57:34.0000000Z",
"deviceIds": [
{
"id": "10-digit phone number",
"kind": "mdn"
},
{
"id": "15-digit IMSI",
"kind": "imsi"
},
{
"id": "15-digit IMEI",
"kind": "imei"
},
{
"id": "20-digit ICCID",
"kind": "iccId"
},
{
"id": "11-digit MSISDN",
"kind": "msisdn"
},
{
"id": "10-digit MIN",
"kind": "min"
}
],
"groupNames": [
"Default: 0000123456-00001"
],
"ipAddress": "0.0.0.0",
"lastActivationBy": "user name",
"lastActivationDate": "2022-12-20T16:32:05.0000000Z",
"lastConnectionDate": "2022-12-20T16:33:53.0000000Z"
}
}
},
"callbackCount": 1,
"maxCallbackThreshold": 4
}
Parameter Name | Data Type | Description |
---|---|---|
requestId | string | The request ID that the callback is for. |
deviceIds | array | An array of device ID objects where the "kind" could be the device's IMEI, IMSI or ICCID and the "id" is the value of the "kind". |
deviceResponse | object | The object containing the device's type of response, what the device is responding to and configuration. |
externalProvisioningChangeResponse | object | The object defining the type of device response. |
change | string | The type of change the device is responding to. |
deviceInfo | object | Device identification and basic service account information. |
preIMEI | string | The IMEI information shared at account creation. |
preSKU | string | The Stock Keeping Unit (SKU) of the device shared at account creation. |
accountName | string | The numeric name of the account. |
billingCycleEndDate | string ($date-time) | The assigned end date of the device's billing cycle. |
carrierInformations | array | An array containing the name of the service provider (carrierName), the service plan being used (servicePlan) and if the device's status on the service provider's network (state). |
connected | boolean | Indicates if the device is connected to the service provider's network (true) or not (false). |
createdAt | string ($date-time) | Timestamp for when the device record was created. |
deviceIds | array | An array of device identifier objects where the "kind" can be IMEI, IMSI, MSISDN, ICCID, MDN and MIN and the "id" is the value of the "kind" represented. |
groupNames | array | an array of groups the device is associated with. |
ipAddress | string | The IP address assigned to the device if it is activated as Public Static |
lastActivationBy | string | The user name that made the most recent change. |
lastActivationDate | string ($date-time) | The timestamp of the most recent change |
lastConnectionDate | string ($date-time) | The timestamp of the most recent connection to the service provider's network. |
callbackCount | integer | The number of callbacks for this request. |
maxCallbackThreshold | integre | The maximum number of callbacks allowed for this request. |
Status 400
All error messages are returned in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}