API Documentation: Carrier Details by VIN

GET /api/carrier/:vin

This endpoint provides the MC (Motor Carrier) number or USDOT number of a company associated with a specific Vehicle Identification Number (VIN).

URL

https://app.onroadnetworks.com/api/carrier/:vin

Parameters:

  • :vin (required): The Vehicle Identification Number of the vehicle for which carrier information is requested.

Authentication

To access this endpoint, the following headers must be included in the request:

Key:x-api-key
Value:API key value
Key:provider-token
Value:Provider token value

Example

cURL
curl --location --request GET 'https://app.onroadnetworks.com/api/carrier/:vin' --header 'x-api-key: ${key}' --header 'provider-token: ${token}'

Response format

JSON
{
  "mcNumber": "string",
  "usDotNumber": "string"
}

Generating API Key

API keys can be generated by following the steps below:

  1. Click on your profile avatar in the top right corner
  2. Go to the “Settings” page by clicking on the button in the menu that appears
  3. Click on the “API Keys” tab
  4. Click on the “Add key” button and create a new key
Step №1
First step
Step №2
Second step
Step №3
Third step
Step №4
Fourth step

Test Data

Endpoint:https://app.onroadnetworks.com/api/carrier/:vin
VIN:3AKJHHDR4PSNH1111
x-api-key:2b2y38VUi9AWSSUQRn5GD8eKLuKFlORBV7rk-8dCmFTAonRoadELD
provider-token:1R8xFqCfchWVnjjQonRoadELD
cURL
curl --location --request GET 'https://app.onroadnetworks.com/api/carrier/3AKJHHDR4PSNH1111' --header 'x-api-key: 2b2y38VUi9AWSSUQRn5GD8eKLuKFlORBV7rk-8dCmFTAonRoadELD' --header 'provider-token: 1R8xFqCfchWVnjjQonRoadELD'

Notes

  • Ensure that the API key and provider token are kept secure and not exposed in client-side code.
  • This endpoint is useful for retrieving regulatory information about a vehicle's carrier for compliance and verification purposes.
  • The response includes the MC and USDOT numbers which are critical for various logistic and regulatory needs.