Domestic 4G and 5G Fixed Wireless qualification

`POST /v1/intelligence/wireless-coverage`

Qualify addresses for Fixed Wireless Access unlimited plans. This API endpoint checks for both coverage and network capacity to sustain unlimited data plans. If the use case is FWA share plans, IoT, or mobility plans, use the Domestic 4G and 5G nationwide network coverage API which will not take FWA unlimited capacity into account in the response.

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/intelligence/wireless-coverage

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 request header containing a valid Bearer token: `Authorization: Bearer {token}`
VZ-M2M-Token (required)	string	A valid session token returned by a Connectivity Management `POST /session/login` request.
Content-Type (required)	string	Must be `application/json`.

Request Body

Example request:

{   "accountName":"0000123456-00001",   "requestType":"FWA",   "locationType":"ADDRESS",   "locations":{      "addressList":[         {            "addressLine1":"123 Astreet",            "addressLine2":"Suite 01",            "city":"Basking Ridge",            "state":"NJ",            "country":"USA",            "zip":"07920",            "zip4":"optional +4 digit postal code"         },         {            "addressLine1":"123 Anotherstreet",            "addressLine2":"optional address information",            "city":"Basking Ridge",            "state":"NJ",            "country":"USA",            "zip":"07920",            "zip4":"optional +4 digit postal code"         }      ]   },   "networkTypesList":[      {         "networkType":"C-BAND"      },   ]}

Request Body Parameters

All parameters are (required) unless marked (optional).

Parameter	Data Type	Description
accountName	string	The numeric name of the account, including leading zeros.
requestType	string	Set to FWA for address qualification.
locationType	string	Specifies the location type used for the query. ADDRESS is the value to use fo this requestType.
locations	object	Contains the location details to be queried.
addressList	array	An array of address objects (up to 10,000 locations per billing account per day).
addressLine1	string	The street number and name.
addressLine2 (optional)	string	Optional address information like suite number or building number.
city	string	The name of the city.
state	string	The 2 letter ISO-3066 state name.
country	string	The 2 letter ISO-3066 country code or USA if in the United States.
zip	string	The 5-digit postal, or zip, code.
zip4 (optional)	string	The optional +4 digit postal code added to the zip code.
networkTypesList	array	An array of networkType objects.
networkType	string	The type of network being queried. Valid values are: LTE, C-BAND and MMWAVE. Note: Only one `networkType` can be specified per request.

Success Responses

Status 200

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

Example Response:

{  "requestId": "d1f08526-eeee-ffff-gggg-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 service to subscribe to is IntelligenceService.

Example callback response for C-band:

{  "username" : "the user's login information",  "password" : "the user's password",  "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8",  "intelligenceResponse": {    "wirelessCoverages": {      "fwaCoverage": [        {          "location": {            "address": {              "addressLine1": "123 Astreet",              "addressLine1": "Suite 01",              "city": "Basking Ridge",              "state": "NJ",              "zip": "07920"            }          },          "coverage": {            "networkType": "C-BAND",            "qualified": "true"          },          "status": "SUCCESS"        },        {          "location": {            "address": {              "addressLine1": "123 Anotherstreet",              "city": "Basking ridge",              "state": "NJ",              "zip": "07920"            }          },          "coverage": {            "networkType": "C-BAND",            "qualified": "false"          },          "status": "FAILED",          "reason": "Address not qualified for 5G coverage"        }      ]    }  },  "status": "SUCCESS",  "callbackCount": 1,  "maxCallbackThreshold": 4}

Example callback for Millimeter Wave (mmwave) which includes the maximum megabits per second (Mbps) speed supported at that address, depending on the mounting of the outdoor antenna.

{  "username" : "the user's login information",  "password" : "the user's password",  "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8",  "intelligenceResponse": {    "wirelessCoverages": {      "fwaCoverage": [        {          "location": {            "address": {              "addressLine1": "123 Astreet",              "addressLine1": "Suite 01",              "city": "Basking Ridge",              "state": "NJ",              "zip": "07920"            }          },          "coverage": {            "networkType": "MMWAVE",            "qualified": "false"          },          "status": "FAILED",          "reason": "Address not qualified for mmwave coverage"        },        {          "location": {            "address": {              "addressLine1": "123 Anotherstreet",              "city": "Basking Ridge",              "state": "NJ",              "zip": "07920"            }          },          "coverage": {            "networkType": "MMWAVE",            "qualified": "true",            "speed": "300"          },          "status": "SUCCESS"        }      ]    }  },  "status": "SUCCESS",  "callbackCount": 1,  "maxCallbackThreshold": 4}

Callback Parameters

Parameter	Data Type	Description
username	string	The user's login information.
password	object	The user's password.
requestId	string	The requestId being viewed. This is a system generated value from the request above.
intelligenceResponse	object	Details about the caalback response.
wirelessCoverages	object	Details about the wireless coverage in the area queried.
fwaCoverage	array	An array of objects containing network information based on the location information queried.
location	object	Contains the location information being queried.
address	object	Contains the address information queried.
coverage	object	Details of coverage for the `networkType` queried.
networkType	string	The type of network queried for. Values are: LTE, C-BAND and MMWAVE.
qualified	boolean	Shows if the address is qualified for the networkType. Will be either true or false. Note: this API takes available FWA capacity into account. If the use case is FWA share plans, IoT, or mobility plans, use the Domestic 4G and 5G nationwide network coverage API.
speed	sring	Only valid for Millimeter wave. Shows the maximum throughput supported in Megabits per second.
status	string	Based on the location information used, the status shows if the location is qualified to use the networkType (SUCCESS) or not (FAILED).
reason	string	Reason for FAILED response.
status	string	The status of the `intelligenceResponse`.
callbackCount	string	The number of responses for `intelligenceResponse` found.
maxCallbackThreshold	string	The maximum number of responses for `intelligenceResponse` allowed.

Failure Responses

All error messages are returned in this format:

{  "errorCode": "The 3-digit HTML error code",  "errorMessage": "string"}

# Domestic 4G and 5G Fixed Wireless qualification ### `POST /v1/intelligence/wireless-coverage` Qualify addresses for Fixed Wireless Access unlimited plans. This API endpoint checks for both coverage and network capacity to sustain unlimited data plans. If the use case is FWA share plans, IoT, or mobility plans, use the [Domestic 4G and 5G nationwide network coverage](https://thingspace.verizon.com/documentation/api-documentation.html#/http/thingspace-intelligence/wireless-network-performance/api-reference/domestic-4g-and-5g-nationwide-network-coverage) API which will not take FWA unlimited capacity into account in the response. ## HTTP Request [POST https://thingspace.verizon.com/api/m2m/v1/intelligence/wireless-coverage](/docs/premium-apis/thingspace-intelligence/api-endpoints/wireless-network-performance/domestic4gand5gnationwidenetworkcoverage) ## 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](https://thingspace.verizon.com/documentation/api-documentation.html#/http/session-management/guides/getting-started). | Parameter Name | Data Type | Description | |----------|----------|----------| | **Authorization** *(required)* | string | HTTP Authorization request header containing a valid Bearer token: `Authorization: Bearer {token}` | | **VZ-M2M-Token** *(required)* | string | A valid session token returned by a Connectivity Management `POST /session/login` request. | | **Content-Type** *(required)* | string | Must be `application/json`. | ## Request Body Example request: ``` json { "accountName":"0000123456-00001", "requestType":"FWA", "locationType":"ADDRESS", "locations":{ "addressList":[ { "addressLine1":"123 Astreet", "addressLine2":"Suite 01", "city":"Basking Ridge", "state":"NJ", "country":"USA", "zip":"07920", "zip4":"optional +4 digit postal code" }, { "addressLine1":"123 Anotherstreet", "addressLine2":"optional address information", "city":"Basking Ridge", "state":"NJ", "country":"USA", "zip":"07920", "zip4":"optional +4 digit postal code" } ] }, "networkTypesList":[ { "networkType":"C-BAND" }, ] } ``` ## Request Body Parameters All parameters are *(required)* unless marked *(optional)*. | Parameter | Data Type | Description | |---------------------------------|---------------|--------------------------------------| | **accountName** | string | The numeric name of the account, including leading zeros. | | **requestType** | string | Set to **FWA** for address qualification. | | **locationType** | string | Specifies the location type used for the query. **ADDRESS** is the value to use fo this requestType. | | **locations** | object | Contains the location details to be queried. | | **addressList** | array | An array of address objects (up to 10,000 locations per billing account per day). | | **addressLine1** | string | The street number and name. | | **addressLine2** *(optional)* | string | Optional address information like suite number or building number. | | **city** | string | The name of the city. | | **state** | string | The 2 letter ISO-3066 state name. | | **country** | string | The 2 letter ISO-3066 country code or USA if in the United States. | | **zip** | string | The 5-digit postal, or zip, code. | | **zip4** *(optional)* | string | The optional +4 digit postal code added to the zip code. | | **networkTypesList** | array | An array of networkType objects. | | **networkType** | string | The type of network being queried. Valid values are: **LTE**, **C-BAND** and **MMWAVE**. <br>**Note:** Only one `networkType` can be specified per request. | ## Success Responses **Status 200** A successful response shows a system generated request ID to track the request. Example Response: ``` json { "requestId": "d1f08526-eeee-ffff-gggg-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](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/guides/callbacks/about-callback-services). The callback service to subscribe to is [IntelligenceService](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/guides/callbacks/about-callback-services/request-body-format). Example callback response for C-band: ``` json { "username" : "the user's login information", "password" : "the user's password", "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8", "intelligenceResponse": { "wirelessCoverages": { "fwaCoverage": [ { "location": { "address": { "addressLine1": "123 Astreet", "addressLine1": "Suite 01", "city": "Basking Ridge", "state": "NJ", "zip": "07920" } }, "coverage": { "networkType": "C-BAND", "qualified": "true" }, "status": "SUCCESS" }, { "location": { "address": { "addressLine1": "123 Anotherstreet", "city": "Basking ridge", "state": "NJ", "zip": "07920" } }, "coverage": { "networkType": "C-BAND", "qualified": "false" }, "status": "FAILED", "reason": "Address not qualified for 5G coverage" } ] } }, "status": "SUCCESS", "callbackCount": 1, "maxCallbackThreshold": 4 } ``` Example callback for Millimeter Wave (mmwave) which includes the maximum megabits per second (Mbps) speed supported at that address, depending on the mounting of the outdoor antenna. ``` json { "username" : "the user's login information", "password" : "the user's password", "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8", "intelligenceResponse": { "wirelessCoverages": { "fwaCoverage": [ { "location": { "address": { "addressLine1": "123 Astreet", "addressLine1": "Suite 01", "city": "Basking Ridge", "state": "NJ", "zip": "07920" } }, "coverage": { "networkType": "MMWAVE", "qualified": "false" }, "status": "FAILED", "reason": "Address not qualified for mmwave coverage" }, { "location": { "address": { "addressLine1": "123 Anotherstreet", "city": "Basking Ridge", "state": "NJ", "zip": "07920" } }, "coverage": { "networkType": "MMWAVE", "qualified": "true", "speed": "300" }, "status": "SUCCESS" } ] } }, "status": "SUCCESS", "callbackCount": 1, "maxCallbackThreshold": 4 } ``` ## Callback Parameters | Parameter | Data Type | Description | |:-------------------------|:---------|:---------------------------------------------------------------------------------------------------------------------------------------| | **username** | string | The user's login information. | | **password** | object | The user's password. | | **requestId** | string | The requestId being viewed. This is a system generated value from the request above. | | **intelligenceResponse** | object | Details about the caalback response. | | **wirelessCoverages** | object | Details about the wireless coverage in the area queried. | | **fwaCoverage** | array | An array of objects containing network information based on the location information queried. | | **location** | object | Contains the location information being queried. | | **address** | object | Contains the address information queried. | | **coverage** | object | Details of coverage for the `networkType` queried. | | **networkType** | string | The type of network queried for. Values are: **LTE**, **C-BAND** and **MMWAVE**. | | **qualified** | boolean | Shows if the address is qualified for the networkType. Will be either **true** or **false**. <br>**Note:** this API takes available FWA capacity into account. If the use case is FWA share plans, IoT, or mobility plans, use the [Domestic 4G and 5G nationwide network coverage](https://thingspace.verizon.com/documentation/api-documentation.html#/http/premium-apis/thingspace-intelligence/wireless-network-performance/api-reference/domestic-4g-and-5g-nationwide-network-coverage) API. | | **speed** | sring | Only valid for Millimeter wave. Shows the maximum throughput supported in Megabits per second. | | **status** | string | Based on the location information used, the status shows if the location is qualified to use the networkType (**SUCCESS**) or not (**FAILED**). | | **reason** | string | Reason for **FAILED** response. | | **status** | string | The status of the `intelligenceResponse`. | | **callbackCount** | string | The number of responses for `intelligenceResponse` found. | | **maxCallbackThreshold** | string | The maximum number of responses for `intelligenceResponse` allowed. | ## Failure Responses All error messages are returned in this format: ``` json { "errorCode": "The 3-digit HTML error code", "errorMessage": "string" } ```