Specialized APIsHyper Precise LocationAPI EndpointsManage Device CredentialsRetrieve Credentials
API Reference
Retrieve Device Credentials for Hyper Precise
Retrieve the credentials assigned to a device for Hyper Precise.
POST /credentials/retrieve
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 Tokens.
| 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. |
HTTP Request
POST https://thingspace.verizon.com/api/auth/v1/credentials/retrieve
Request Parameters
| Parameter | Data Type | Description |
|---|---|---|
| ECPD (required) | string | The customer's ID value in the Enterprise Customer Profile Database. This is a 6-digit value with no leading zeroes. |
| accountName (required) | string | The numeric name of the account in the format "0000123456-00001". Leading zeroes must be included. |
| items (required) | array | An array of International Mobile Equipment Identifier (IMEI) values. |
Request Body
Example Request:
{
"ECPD": "Enterprise Customer Profile ID",
"accountNumber": "0000123456-00001",
"items": [
{
"imei": "15-digit IMEI"
}
]
}Success Response
Status 200 A successful response will return the credentials assigned to a device.
Example Response:
{
"items": [
{
"imei": "15-digit IMEI",
"username": "credentials",
"failure": " "
}
]
}Success Parameters
| Parameter | Data Type | Description |
|---|---|---|
| items | array | An array of objects showing the assigned credentials or a reason the request failed. |
| imei | string | The IMEI of the device responding. |
| username | string | This field is used to display the device's credentials. |
| failure | string | A message indicating the type of failure. This will only be shown if a failure occurs. |
Failure Responses
Example Response:
{
"errorCode": "The 3-digit HTML error code",
"errorMessage": "string"
}