Carrier Vetting Assessment

Search by a USDOT number and receive a vetting assessment (pass, needs review, fail) along with assessment details per rule.

Authentication

• Include your Access-Token and x-api-key in the header of your requests.

Permissions

The external-api-compliance-rules permission is required to access this endpoint.

Endpoint

• URL: https://api.genlogs.io/compliance-rules

• Method: GET

Request Parameters

• usdot_number (string, Required): The USDOT number corresponding to the carrier you would like to review.

Headers

• Access-Token: (string, required): Access token obtained from the "Create Access Token" endpoint.

• x-api-key (string, required): The API key provided by GenLogs.

Request Example:

curl --location 'https://api.genlogs.io/compliance-rules?usdot_number=100000' \
--header 'access-token: <your-api-token>' \
--header 'x-api-key: <your-x-api-key>'

Response:

• 200 OK: A JSON object containing the vetting information for the provided carrier.

• 400 Bad Request: If usdot_number required parameter is missing or invalid.

• 401 Unauthorized: If the authentication credentials (Access-Token) is missing or incorrect.

• 403 Forbidden: If the permission has not been set to your user.

• 500 Internal Server Error: If there is an issue on the server that prevents processing the request.

Response Body:

200 OK – Vetting information found for carrier

{
   "rules":[
      {
         "rule_result_description":"Carrier has been observed by GenLogs.",
         "status":"pass",
         "category":"GenLogs",
         "rule_order":1
      }
   ],
   "rule_status":{
      "pass":{
         "total":1
      },
      "fail":{
         "total":0
      },
      "review":{
         "total":0
      }
   }
}

400 Bad Request

Returned when:

• usdot_number is missing, empty, malformed or zero

{
    "detail": "usdot_number is required"
}

{
    "detail": "usdot_number must not be empty or zero"
}

403 Forbidden

{
    "detail": "User does not have the required permissions to access this resource"
}

404 Not Found

{
    "message": "No vetting data found for usdot_number: 100000"
}

Get carrier compliance rules by USDOT (single or batch)

get

Returns carrier compliance rules for one or more USDOT numbers.

• Single mode: provide usdot_number. The response shape is a single object with rules and rule_status and is fully backward compatible with the existing API.

• Batch mode: provide usdot_numbers as a comma-separated list. The response shape is an object with a results array where each item represents one USDOT and includes a found flag.

When both usdot_number and usdot_numbers are provided, usdot_numbers takes precedence and usdot_number is ignored. The maximum number of USDOT values allowed in usdot_numbers is limited to 50. Requests that exceed this limit return HTTP 400. Each batch result item uses found=false when no vetting data exists for that USDOT. In that case the item only contains usdot_number and found. When found=true, rules and rule_status are populated with the same structure as the single-USDOT response. Examples:

• Single: /compliance-rules?usdot_number=1234567

• Batch: /compliance-rules?usdot_numbers=1234567,7654321

Authorizations

Access-Token & X-Api-Key

Access-TokenstringRequired

JWT provided directly in the Access-Token header.

x-api-keystringRequired

API key provided by GenLogs.

Query parameters

usdot_numberstringOptional

Single USDOT number to evaluate. Ignored when usdot_numbers is also provided.

Example: 1234567

usdot_numbersstringOptional

Comma-separated list of USDOT numbers for batch evaluation. When provided, this parameter takes precedence over usdot_number.

Example: 1234567,7654321

Responses

200

Compliance rules retrieved successfully (single or batch).

• Single: single carrier response (rules + rule_status). - Batch: list of per-carrier results with found flags.

application/json

or

400

Bad Request – invalid input, missing required query parameters, or exceeding the maximum allowed number of USDOT values.

application/json

401

Unauthorized – Invalid or missing Access-Token.

application/json

403

Forbidden – Company user does not have vetting access permission.

application/json

404

Not Found – no vetting data exists for any of the requested USDOT numbers.

application/json

500

Internal Server Error.

application/json

get

/compliance-rules

HTTPcURLJavaScriptPython

GET /compliance-rules HTTP/1.1
Host: api.genlogs.io
Access-Token: YOUR_API_KEY
x-api-key: YOUR_API_KEY
Accept: */*

{
  "rules": [
    {
      "rule_result_description": "text",
      "status": "text",
      "category": "text",
      "rule_order": "text"
    }
  ],
  "rule_status": {
    "pass": {
      "total": 1
    },
    "fail": {
      "total": 1
    },
    "review": {
      "total": 1
    }
  }
}