Resources

Errors

The Onroad ELD API uses conventional HTTP status codes to indicate the result of a request. Codes in the 2xx range indicate success, 4xx a problem with the request, and 5xx an error on the server side.

Every error response shares the same JSON shape:

JSON

{
  "error": {
    "status": 0,
    "code": "string",
    "message": "string"
  }
}

401

Unauthorized

CLIENT

The x-api-key or provider-token header is missing, malformed, or invalid. Check that both headers are present and correct.

JSON

{
  "error": {
    "status": 401,
    "code": "unauthorized",
    "message": "Missing or invalid API credentials."
  }
}

403

Forbidden

CLIENT

The credentials are valid but the account is not authorized to access this resource — for example, requesting a USDOT number outside your permitted scope.

JSON

{
  "error": {
    "status": 403,
    "code": "forbidden",
    "message": "You do not have access to this resource."
  }
}

404

Not Found

CLIENT

The requested resource does not exist — an unknown USDOT number, VIN, or endpoint path.

JSON

{
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "No record found for the requested USDOT number."
  }
}

500

Internal Server Error

SERVER

An unexpected error occurred on our side while processing the request. Safe to retry after a short delay; if it persists, contact support.

JSON

{
  "error": {
    "status": 500,
    "code": "internal_error",
    "message": "An unexpected error occurred. Please try again later."
  }
}

501

Not Implemented

SERVER

The requested method or endpoint is recognized but not implemented. Verify you are using GET against a supported endpoint.

JSON

{
  "error": {
    "status": 501,
    "code": "not_implemented",
    "message": "This method is not implemented."
  }
}

502

Bad Gateway

SERVER

The upstream service returned an invalid response while processing the request. Safe to retry after a short delay; if it persists, contact support.

JSON

{
  "error": {
    "status": 502,
    "code": "bad_gateway",
    "message": "Upstream provider is temporarily unavailable."
  }
}