Devices API Endpoints
Last updated
Last updated
DIMO Check-in
This is a legacy API endpoint that consists of different operations. Be mindful of the different authorization headers for each API call, as we've noted them with some visual cues:
Restricted by Privilege Token
Restricted by Access Token
https://devices-api.dimo.zone
POST
{baseUrl}
/v1/user/devices
Creates a vehicle in the system with a specific device definition. Optionally, a device definition will be created if only supplied with Make, Model, and Year.
Name | Type | Description |
---|---|---|
POST
{baseUrl}
/v1/user/devices/fromsmartcar
Creates a vehicle in the system via Smartcar integration.
POST
{baseUrl}
/v1/user/devices/fromvin
Creates a vehicle in the system by decoding a Vehicle Identification Number (VIN).
PATCH
{baseUrl}
/v1/user/devices/{userDeviceId}/vin
Updates the Vehicle Identification Number (VIN) by User Device ID.
GET
{baseUrl}
/v1/aftermarket/device/by-serial/{serial}/commands/claim
Retrieves the EIP-712 payload for Aftermarket device claiming.
POST
{baseUrl}
/v1/aftermarket/device/by-serial/{serial}/commands/claim
Claims the aftermarket device identified by serial number, signs the claiming payload with a device signature and a user signature while sending to the blockchain.
GET
{baseUrl}
/v1/user/devices/{userDeviceId}/commands/mint
Retrieves the payload for user device minting.
POST
{baseUrl}
/v1/user/devices/{userDeviceId}/commands/mint
Mints the vehicle identified by user device ID, signs the minting payload with a signature while sending to the blockchain.
POST
{baseUrl}
/v1/user/devices/{userDeviceId}/commands/opt-in
Opts the device into data-sharing to qualify for $DIMO rewards.
POST
{baseUrl}
/v1/user/devices/{userDeviceId}/commands/refresh
Starts the process of refreshing device status from Smartcar. Note that this endpoint is rate-limited separately as it involves with our API agreement with Smartcar.
Developer Notes
To access the vehicle commands, a token exchange transaction is required to obtain a 2nd JWT to get permission to access the vehicle's commands. Please check Token Exchange API prior to using this endpoint.
POST
{baseUrl}
/v1/vehicle/{tokenId}/commands/doors/lock
Sends a vehicle command to lock the doors.
POST
{baseUrl}
/v1/vehicle/{tokenId}/commands/doors/unlock
Sends a vehicle command to unlock the doors.
POST
{baseUrl}
/v1/vehicle/{tokenId}/commands/frunk/open
Sends a vehicle command to open the frunk.
POST
{baseUrl}
/v1/vehicle/{tokenId}/commands/trunk/open
Sends a vehicle command to open the trunk.
The following endpoints defers back to using the Authentication Web3 access token given that API users are interacting with user devices under their personal possession. No additional permission is needed.
Vehicle error codes are not actively synced with the DIMO Network, hence a submission of error codes is required to store error code history. This is also a function seen in the DIMO Mobile App: https://dimo.zone/news/how-to-scan-your-cars-error-codes-with-dimo-mobile
GET
{baseUrl}
/v1/user/devices/{userDeviceId}/error-codes
Retrieves a list of error code queries made for the vehicle identified by the user device ID.
POST
{baseUrl}
/v1/user/devices/{userDeviceId}/error-codes
Submits a list of error codes for the vehicle identified by the user device ID. This submission will actively store the error codes provided for the vehicle while returning the full descriptions for evaluation.
Use application/json
for raw body parameters.
POST
{baseUrl}
/v1/user/devices/{userDeviceId}/error-codes/clear
Submits a clearing signal to DIMO, indicating that the most recently error codes submitted for the vehicle has been cleared.
GET
{baseUrl}
/v1/dcn/{nodeId}
Retrieves DCN Metadata identified by the node ID.
GET
{baseUrl}
/v1/dcn/{nodeId}/image
Retrieves DCN image identified by the node ID.
GET
{baseUrl}
/v1/user/geofences
List all geofences for user devices that belongs to the authorized user.
POST
{baseUrl}
/v1/user/geofences
Creates a geofence object bounded by h3indexes for an authorized user account, optionally attaching the geofence to specific user devices.
PUT
{baseUrl}
/v1/user/geofences/{geofenceId}
Updates a geofence object for an authorized user with the provided geofence ID.
DELETE
{baseUrl}
/v1/user/geofences/{geofenceId}
Deletes a geofence object for an authorized user with the provided geofence ID.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|