Compliance rules

Get compliance rules for a carrier. Returns vetting/compliance rule results for a carrier identified by USDOT number.

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

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 'http://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"
}