Devices API
Last updated
Last updated
GET
{baseUrl}/v1/user/devices/me
Lists all devices associated with the authenticated user.
Name | Type | Description |
---|
GET
{baseUrl}/v1/user/devices/shared
Lists all devices shared with the authenticated user.
Name | Type | Description |
---|
GET
{baseUrl}/v1/aftermarket/device/by-serial/{serial}
Retrieves the aftermarket device data for the device serial number.
POST
{baseUrl}/v1/aftermarket/device/by-serial/{serial}/update
Retrieves the aftermarket device data for the device serial number.
GET
{baseUrl}/v1/documents
Retrieves a list containing all documents for an authorized user.
GET
{baseUrl}/v1/documents/{documentId}
Retrieves a document for an authorized user with the provided document ID.
GET
{baseUrl}/v1/documents/{documentId}/download
Downloads a document for an authorized user with the provided document ID.
POST
{baseUrl}/v1/documents
Uploads a new document for an authorized user.
DELETE
{baseUrl}/v1/documents/{documentId}
Deletes a document for an authorized user with the provided document ID.
POST
{baseUrl}/v1/aftermarket/device/by-serial/{serial}/commands/unclaim
Dev-only endpoint for removing a claim. Removes the flag on-chain and clears the owner in the database.
Pairs the aftermarket device identified by User Device ID, signs the pairing payload with a device signature and a user signature while sending to the blockchain.
Unpairs the aftermarket device identified by User Device ID, signs the unpairing payload with a device signature and a user signature while sending to the blockchain.
Developer Notes
The following endpoints are publicly available providing on-chain metadata.
Retrieves the synthetic device metadata for the given token ID.
Retrieves the aftermarket device metadata for the given token ID. This returns the same data as Get Aftermarket Device Metadata by Ethereum Address.
Retrieves the aftermarket device image for the given token ID.
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Body type needs to be form-data
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
GET
/v1/user/devices/{userDeviceId}/aftermarket/commands/pair
Retrieves the payload for user device <> vehicle pairing.
Name | Type | Description |
---|
Name | Type | Description |
---|
POST
/v1/user/devices/{userDeviceId}/aftermarket/commands/pair
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
GET
/v1/user/devices/{userDeviceId}/aftermarket/commands/unpair
Retrieves the payload for user device <> vehicle pairing.
Name | Type | Description |
---|
Name | Type | Description |
---|
POST
/v1/user/devices/{userDeviceId}/aftermarket/commands/pair
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
GET
/v1/synthetic/device/{tokenId}
Name | Type | Description |
---|
GET
/v1/aftermarket/device/{tokenId}
Name | Type | Description |
---|
GET
/v1/aftermarket/device/{tokenId}/image
Name | Type | Description |
---|
GET
/v1/aftermarket/device/by-address/{address}
Retrieves the aftermarket device metadata for the given 0x
Ethereum address. This returns the same data as in
Name | Type | Description |
---|
documentId* | String |
documentId* | String |
file* | File | The file to upload. |
name* | String | The name of the document. |
type* | String | The type of the document. |
userDeviceId | String | Optional user device ID. |
documentId* | String |
serial* | String |
tokenId* | String | Device token ID, this is the token ID of your device NFT. This is publicly available to query in the Identity API. |
tokenId* | String | Device token ID, this is the token ID of your device NFT. This is publicly available to query in the Identity API. |
tokenId* | String | Device token ID, this is the token ID of your device NFT. This is publicly available to query in the Identity API. |
address* | String | Ethereum address. |
Authorization* | String |
Authorization* | String |
Authorization* | String |
Authorization* | String |
Authorization* | String |
Authorization* | String |
Authorization* | String |
Authorization* | String |
Authorization* | String |
Authorization* | String |
userDeviceId* | String |
Authorization* | String |
userDeviceId* | String |
Authorization* | String |
userSignature* | Object |
userDeviceId* | String |
Authorization* | String |
userDeviceId* | String |
Authorization* | String |
userSignature* | Object |
Bearer authentication using the access_token
generated from the .
Bearer authentication using the access_token
generated from the .
Bearer authentication using the access_token
generated from the .
Bearer authentication using the access_token
generated from the .
Bearer authentication using the access_token
generated from the .
Bearer authentication using the access_token
generated from the .
Bearer authentication using the access_token
generated from the .
Bearer authentication using the access_token
generated from the .
Bearer authentication using the access_token
generated from the .
Bearer authentication using the access_token
generated from the .
For userDeviceId
, please refer to the User Device entity under
Bearer authentication using the access_token
generated from the .
For userDeviceId
, please refer to the User Device entity under
Bearer authentication using the access_token
generated from the .
For userDeviceId
, please refer to the User Device entity under
Bearer authentication using the access_token
generated from the .
For userDeviceId
, please refer to the User Device entity under
Bearer authentication using the access_token
generated from the .