Skip to main content
GET
/
v1
/
companies
/
{company-id}
/
compliance_check
Check Compliance Status
curl --request GET \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/compliance_check \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "has_issues": true,
    "warnings": [
      {
        "type": "<string>",
        "document_type": "<string>",
        "document_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entity": "<string>",
        "expires_at": "2023-11-07T05:31:56Z"
      }
    ],
    "blocking": [
      {
        "type": "<string>",
        "document_type": "<string>",
        "document_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entity": "<string>",
        "expires_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

​
company-id
string<uuid>
required

Company ID

Query Parameters

​
account_id
string<uuid>

Account ID to check vendor compliance

​
user_id
string<uuid>

User ID to check driver compliance

​
equipment_id
string<uuid>

Equipment ID to check equipment compliance

Response

OK

​
data
ComplianceCheck-Read · object
required