--- updatedAt: 2026-08-28T21:58:01.000Z agentTools: projectIndex: https://developer.truckstop.com/llms.txt --- # Get Current Snapshot for Monitored Carrier Returns details of a carrier based on requested DOT number and modules. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "CarrierHub", "description": "Public operations exposed to Truckstop customers", "version": "1.6.0", "x-serviceName": "CarrierHub External" }, "tags": [ { "name": "Carrier Hub", "description": "Public operations exposed to Truckstop customers" } ], "paths": { "/monitoring/carriers/{dotNumber}": { "parameters": [ { "name": "dotNumber", "in": "path", "required": true, "description": "DOT number of the carrier.", "schema": { "type": "string", "minLength": 1, "maxLength": 25 } } ], "get": { "parameters": [ { "name": "modules", "in": "query", "required": false, "description": "List of monitoring modules to include in the response. If omitted, all modules are included.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalModule" } } } ], "tags": [ "Carrier Hub" ], "summary": "Get Current Snapshot for Monitored Carrier", "description": "Returns details of a carrier based on requested DOT number and modules.", "operationId": "get-monitoring-carrier-details", "responses": { "200": { "description": "Carrier details for the requested DOT number and modules", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ExternalCarrier" } ], "example": { "dotNumber": "string", "docketNumbers": [ "string" ], "lastUpdated": "2026-08-28T21:45:57.424Z", "modules": { "demographics": { "status": "Ok", "lastUpdated": "2026-08-28T21:45:57.424Z", "sources": [ "DotCensus" ], "data": { "legalName": "string", "dbaName": "string", "status": "string", "physicalAddress": { "street": "string", "city": "string", "state": "string", "postalCode": "string", "country": "string" }, "mailingAddress": { "street": "string", "city": "string", "state": "string", "postalCode": "string", "country": "string" }, "phone": "string", "fax": "string", "cell": "string", "emailAddress": "string", "dunBradstreetNumber": "string", "companyOfficer1": "string", "companyOfficer2": "string", "carrierOperation": "Interstate", "entityTypes": [ "Carrier" ], "classification": [ "string" ], "cargoTypes": [ "string" ], "equipmentTypes": [ { "equipmentType": "string", "owned": 0, "leased": 0, "tripLeased": 0 } ], "driversEquipment": { "totalDrivers": 0, "cdlEmployedDrivers": 0, "monthlyAverageLeasedDrivers": 0, "interstateDrivers": 0, "intrastateDrivers": 0, "interstateDriversWithin100Miles": 0, "intrastateDriversWithin100Miles": 0, "interstateDriversBeyond100Miles": 0, "intrastateDriversBeyond100Miles": 0, "totalPoweredUnits": 0, "totalTrucksAndTractors": 0, "fleetSizeRange": "string", "mcs150Mileage": 0 }, "mcs150Year": 0, "mcs150Date": "2026-08-28T21:45:57.424Z", "hazmatIndicator": true, "outOfService": true, "outOfServiceIssueDate": "2026-08-28", "outOfServiceReason": "string" } }, "authority": { "status": "Ok", "lastUpdated": "2026-08-28T21:45:57.424Z", "sources": [ "DotCensus" ], "data": { "authorities": [ { "docketNumber": "string", "isBroker": true, "authorityAgeDays": 0, "bipdRequired": 0, "bipdOnFile": 0, "cargoRequired": true, "cargoOnFile": true, "bondSuretyRequired": true, "bondSuretyOnFile": true, "property": true, "passenger": true, "householdGoods": true, "private": true, "enterprise": true, "pendingCommonAuthorityRevocation": true, "pendingContractAuthorityRevocation": true, "pendingBrokerAuthorityRevocation": true, "grants": [ { "authorityType": "string", "authorityCategory": "string", "authorityStatus": "string", "originalAction": "string", "lastAction": "string", "originalGrantDate": "2026-08-28", "lastGrantDate": "2026-08-28", "appPending": true, "pendingAuthorityRevocation": true, "revoked": true, "lastRevocationDate": "2026-08-28", "authorityAgeDays": 0 } ] } ] } }, "insurance": { "status": "Ok", "lastUpdated": "2026-08-28T21:45:57.424Z", "sources": [ "DotCensus" ], "data": { "fmcsaInsurance": { "policies": [ { "underwriter": "string", "policyNumber": "string", "coverageType": "string", "coverageAmount": 0, "effectiveDate": "2026-08-28", "postedDate": "2026-08-28", "cancellationDate": "2026-08-28" } ] }, "managedInsurance": { "certificates": [ { "certificateId": 0, "mcNumber": "string", "producerName": "string", "producerEmail": "string", "producerPhone": "string", "producerFax": "string", "producerAddress": { "street": "string", "city": "string", "state": "string", "postalCode": "string", "country": "string" }, "coverages": [ { "type": "string", "status": "Active", "effectiveDate": "2026-08-28", "expirationDate": "2026-08-28", "cancellationDate": "2026-08-28", "policyNumber": "string", "underwriter": "string", "amBest": "str", "renewalCertificateId": 0, "renewalEffectiveDate": "2026-08-28", "renewalExpirationDate": "2026-08-28", "isAuto": true, "isCargo": true, "isGeneralLiability": true, "isWorkersComp": true, "isExcess": true, "isUmbrella": true, "isContingent": true, "isPrimary": true, "limits": [ { "description": "string", "coverageAmount": 0 } ], "categories": [ { "description": "string" } ] } ], "equipment": [ { "vin": "string", "year": 0, "make": "string", "model": "string", "manufacturer": "string", "gvwr": "string", "vehicleType": "string" } ] } ] } } }, "safety": { "status": "Ok", "lastUpdated": "2026-08-28T21:45:57.424Z", "sources": [ "DotCensus" ], "data": { "generalSafetyRating": "string", "generalSafetyRatingDate": "2026-08-28", "safetyRating": "string", "safetyRatingDate": "2026-08-28", "reviewType": "s", "reviewDate": "2026-08-28", "basedInCity": "string", "basedInState": "st", "totalCrashes": 0, "fatalCrashes": 0, "injuryCrashes": 0, "towCrashes": 0, "inspections": { "totalInspections": 0, "vehicleInspections": 0, "driverInspections": 0, "violationCount": 0, "lastInspectionDate": "2026-08-28", "lastViolationDate": "2026-08-28", "vehicleOosViolations": 0, "driverOosViolations": 0, "hazmatOosViolations": 0, "vehicleOosPercentile": 0, "driverOosPercentile": 0, "mcs150PowerUnits": 0, "inspectedVehicleCount": 0, "inspectedVehiclePercentage": 0, "inspectedStateCount": 0, "thresholdAlertCount": 0, "csaInspectionTotal": 0, "csaDriverInspectionTotal": 0, "csaDriverOosInspectionWithViolation": 0, "csaVehicleInspectionTotal": 0, "csaVehicleOosInspectionTotal": 0 }, "inspectionsByState": [ { "stateCode": "st", "inspectionCount": 0 } ], "csaBasics": [ { "basicCategory": "string", "eventGroup": "string", "effectiveDate": "2026-08-28", "isHazmat": true, "basicValue": 0, "inspectionWithViolation": 0, "thresholdHazmat": 0, "thresholdRegular": 0, "measure": 0, "percentile": 0, "isOverThreshold": true, "isAdditionalConcern": true, "isRoadsideAlert": true, "isBasicAlert": true } ] } }, "reputation": { "status": "Ok", "lastUpdated": "2026-08-28T21:45:57.424Z", "sources": [ "DotCensus" ], "data": { "score": { "cprRating": "string", "hasActiveReports": true, "goodReportCountZeroToThirtyDays": 0, "goodReportCountThirtyOneToNinetyDays": 0, "goodReportCountNinetyOneToYear": 0, "goodReportCountOverOneYear": 0, "badReportCountZeroToThirtyDays": 0, "badReportCountThirtyOneToNinetyDays": 0, "badReportCountNinetyOneToYear": 0, "badReportCountOverOneYear": 0 }, "reports": [ { "type": "Good", "date": "2026-08-28", "source": "string", "complaint": "string", "description": "string" } ] } } } } } } } }, "400": { "$ref": "#/components/responses/Standard400" }, "401": { "$ref": "#/components/responses/Standard401" }, "404": { "$ref": "#/components/responses/Standard404" }, "499": { "$ref": "#/components/responses/Standard499" }, "500": { "$ref": "#/components/responses/Standard500" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Provide a bearer token in the Authorization header: `Authorization: Bearer `." } }, "schemas": { "EntityType": { "title": "Carrier Entity Type", "description": "Carrier Entity Type", "type": "string", "enum": [ "Carrier", "ShipperOnly", "Broker", "Registrant", "FreightForwarder", "IntermodalEquipmentProvider", "CargoTank" ] }, "ProblemDetails": { "type": "object", "title": "Problem Details", "description": "Standard problem details object used for error responses.", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "A URI reference that identifies the problem type.", "nullable": true, "example": "https://tools.ietf.org/html/rfc9110#section-15.5.1" }, "title": { "type": "string", "description": "A short human-readable summary of the problem type.", "nullable": true, "example": "Bad Request" }, "status": { "type": "integer", "description": "The HTTP status code for this occurrence of the problem.", "nullable": true, "example": 400 }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem.", "nullable": true, "example": "The request body is invalid." }, "instance": { "type": "string", "description": "A URI reference that identifies the specific occurrence of the problem.", "nullable": true }, "errors": { "type": "object", "description": "A dictionary of validation errors, keyed by property name.", "nullable": true, "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "errors": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] } } }, "Address": { "title": "Carrier Address", "description": "Mailing or physical address for a carrier contact.", "type": "object", "properties": { "street": { "type": "string", "description": "The street number of the address", "nullable": true }, "city": { "type": "string", "description": "The city of the address", "nullable": true }, "state": { "type": "string", "description": "The State of the address", "nullable": true }, "postalCode": { "type": "string", "description": "The postal code of the address", "nullable": true }, "country": { "type": "string", "description": "The country of the address", "nullable": true } }, "additionalProperties": false }, "CarrierAuthorities": { "title": "Carrier Authorities", "description": "Operating authority information for a carrier. A carrier may hold multiple authorities, one per docket number.", "type": "object", "additionalProperties": false, "properties": { "authorities": { "type": "array", "description": "Individual operating authorities held by the carrier", "items": { "$ref": "#/components/schemas/CarrierAuthorityRecord" } } } }, "CarrierAuthorityGrant": { "title": "Carrier Authority Grant", "description": "A single operating authority grant held by a carrier.", "type": "object", "additionalProperties": false, "properties": { "authorityType": { "type": "string", "maxLength": 128, "nullable": true }, "authorityCategory": { "type": "string", "maxLength": 50, "nullable": true }, "authorityStatus": { "type": "string", "maxLength": 50, "nullable": true }, "originalAction": { "type": "string", "maxLength": 60, "nullable": true }, "lastAction": { "type": "string", "maxLength": 60, "nullable": true }, "originalGrantDate": { "type": "string", "format": "date", "nullable": true }, "lastGrantDate": { "type": "string", "format": "date", "nullable": true }, "appPending": { "type": "boolean" }, "pendingAuthorityRevocation": { "type": "boolean" }, "revoked": { "type": "boolean" }, "lastRevocationDate": { "type": "string", "format": "date", "nullable": true }, "authorityAgeDays": { "type": "integer" } } }, "CarrierAuthorityRecord": { "title": "Carrier Authority Record", "description": "A single operating authority held by a carrier, identified by docket number.", "type": "object", "additionalProperties": false, "properties": { "docketNumber": { "type": "string", "maxLength": 25, "nullable": true }, "isBroker": { "type": "boolean" }, "authorityAgeDays": { "type": "integer", "nullable": true }, "bipdRequired": { "type": "integer", "nullable": true }, "bipdOnFile": { "type": "integer", "nullable": true }, "cargoRequired": { "type": "boolean", "nullable": true }, "cargoOnFile": { "type": "boolean", "nullable": true }, "bondSuretyRequired": { "type": "boolean", "nullable": true }, "bondSuretyOnFile": { "type": "boolean", "nullable": true }, "property": { "type": "boolean", "nullable": true }, "passenger": { "type": "boolean", "nullable": true }, "householdGoods": { "type": "boolean", "nullable": true }, "private": { "type": "boolean", "nullable": true }, "enterprise": { "type": "boolean", "nullable": true }, "pendingCommonAuthorityRevocation": { "type": "boolean", "nullable": true }, "pendingContractAuthorityRevocation": { "type": "boolean", "nullable": true }, "pendingBrokerAuthorityRevocation": { "type": "boolean", "nullable": true }, "grants": { "type": "array", "description": "Individual authority grants held under this authority", "items": { "$ref": "#/components/schemas/CarrierAuthorityGrant" } } } }, "CarrierCsaBasicSummary": { "title": "Carrier CSA Basic Summary", "description": "A single CSA BASIC category measure for a carrier.", "type": "object", "additionalProperties": false, "properties": { "basicCategory": { "type": "string", "maxLength": 100, "nullable": true }, "eventGroup": { "type": "string", "maxLength": 25, "nullable": true }, "effectiveDate": { "type": "string", "format": "date", "nullable": true }, "isHazmat": { "type": "boolean", "nullable": true }, "basicValue": { "type": "integer", "nullable": true }, "inspectionWithViolation": { "type": "integer", "nullable": true }, "thresholdHazmat": { "type": "number", "nullable": true }, "thresholdRegular": { "type": "number", "nullable": true }, "measure": { "type": "number", "nullable": true }, "percentile": { "type": "number", "nullable": true }, "isOverThreshold": { "type": "boolean", "nullable": true }, "isAdditionalConcern": { "type": "boolean", "nullable": true }, "isRoadsideAlert": { "type": "boolean", "nullable": true }, "isBasicAlert": { "type": "boolean", "nullable": true } } }, "CarrierDemographics": { "title": "Carrier Demographics", "description": "Demographic and identifying information for a carrier.", "type": "object", "additionalProperties": false, "properties": { "legalName": { "type": "string", "description": "Legal name of the carrier", "maxLength": 120, "nullable": true }, "dbaName": { "type": "string", "description": "Doing business as name of the carrier", "maxLength": 120, "nullable": true }, "status": { "type": "string", "description": "The current status of the carrier", "maxLength": 50, "nullable": true }, "physicalAddress": { "$ref": "#/components/schemas/Address" }, "mailingAddress": { "$ref": "#/components/schemas/Address" }, "phone": { "type": "string", "maxLength": 20, "nullable": true }, "fax": { "type": "string", "maxLength": 20, "nullable": true }, "cell": { "type": "string", "maxLength": 20, "nullable": true }, "emailAddress": { "type": "string", "maxLength": 80, "nullable": true }, "dunBradstreetNumber": { "type": "string", "maxLength": 25, "nullable": true }, "companyOfficer1": { "type": "string", "maxLength": 140, "nullable": true }, "companyOfficer2": { "type": "string", "maxLength": 140, "nullable": true }, "carrierOperation": { "$ref": "#/components/schemas/CarrierOperation" }, "entityTypes": { "type": "array", "description": "List of entity types associated with the carrier", "nullable": true, "items": { "$ref": "#/components/schemas/EntityType" } }, "classification": { "type": "array", "description": "Carrier classification codes", "items": { "type": "string" } }, "cargoTypes": { "type": "array", "description": "Cargo types carried by the carrier", "items": { "type": "string" } }, "equipmentTypes": { "type": "array", "description": "Equipment types operated by the carrier, with owned/leased breakdowns", "items": { "$ref": "#/components/schemas/CarrierEquipmentTypeSummary" } }, "driversEquipment": { "description": "Canonical source for the carrier's fleet and driver counts (total drivers, power units, trucks and tractors, fleet size range)", "allOf": [ { "$ref": "#/components/schemas/CarrierDriversEquipmentSummary" } ] }, "mcs150Year": { "type": "integer", "nullable": true }, "mcs150Date": { "type": "string", "format": "date-time", "nullable": true }, "hazmatIndicator": { "type": "boolean" }, "outOfService": { "type": "boolean" }, "outOfServiceIssueDate": { "type": "string", "format": "date", "nullable": true }, "outOfServiceReason": { "type": "string", "maxLength": 49, "nullable": true } } }, "CarrierDriversEquipmentSummary": { "title": "Carrier Drivers and Equipment Summary", "description": "Driver and power unit counts reported for the carrier.", "type": "object", "additionalProperties": false, "properties": { "totalDrivers": { "type": "integer", "nullable": true }, "cdlEmployedDrivers": { "type": "integer", "nullable": true }, "monthlyAverageLeasedDrivers": { "type": "integer", "nullable": true }, "interstateDrivers": { "type": "integer", "nullable": true }, "intrastateDrivers": { "type": "integer", "nullable": true }, "interstateDriversWithin100Miles": { "type": "integer", "nullable": true }, "intrastateDriversWithin100Miles": { "type": "integer", "nullable": true }, "interstateDriversBeyond100Miles": { "type": "integer", "nullable": true }, "intrastateDriversBeyond100Miles": { "type": "integer", "nullable": true }, "totalPoweredUnits": { "type": "integer", "nullable": true }, "totalTrucksAndTractors": { "type": "integer", "nullable": true }, "fleetSizeRange": { "type": "string", "maxLength": 50, "nullable": true }, "mcs150Mileage": { "type": "integer", "format": "int64", "nullable": true } } }, "CarrierEquipmentTypeSummary": { "title": "Carrier Equipment Type Summary", "description": "Owned/leased breakdown for a single equipment type operated by the carrier.", "type": "object", "additionalProperties": false, "properties": { "equipmentType": { "type": "string", "maxLength": 100, "nullable": false }, "owned": { "type": "integer" }, "leased": { "type": "integer" }, "tripLeased": { "type": "integer" } } }, "CarrierFmcsaInsurance": { "title": "Carrier FMCSA Insurance", "description": "FMCSA-filed insurance information for a carrier.", "type": "object", "additionalProperties": false, "properties": { "policies": { "type": "array", "description": "FMCSA-filed insurance policies on file for the carrier", "items": { "$ref": "#/components/schemas/CarrierInsurancePolicy" } } } }, "CarrierInspectionByStateSummary": { "title": "Carrier Inspection By State Summary", "description": "Inspection count for a carrier within a single state.", "type": "object", "additionalProperties": false, "properties": { "stateCode": { "type": "string", "maxLength": 2, "nullable": false }, "inspectionCount": { "type": "integer" } } }, "CarrierInspectionsSummary": { "title": "Carrier Inspections Summary", "description": "Aggregate inspection and out-of-service statistics for a carrier.", "type": "object", "additionalProperties": false, "properties": { "totalInspections": { "type": "integer" }, "vehicleInspections": { "type": "integer" }, "driverInspections": { "type": "integer" }, "violationCount": { "type": "integer" }, "lastInspectionDate": { "type": "string", "format": "date", "nullable": true }, "lastViolationDate": { "type": "string", "format": "date", "nullable": true }, "vehicleOosViolations": { "type": "integer" }, "driverOosViolations": { "type": "integer" }, "hazmatOosViolations": { "type": "integer" }, "vehicleOosPercentile": { "type": "number", "nullable": true }, "driverOosPercentile": { "type": "number", "nullable": true }, "mcs150PowerUnits": { "type": "integer", "nullable": true }, "inspectedVehicleCount": { "type": "integer", "nullable": true }, "inspectedVehiclePercentage": { "type": "number", "nullable": true }, "inspectedStateCount": { "type": "integer" }, "thresholdAlertCount": { "type": "integer" }, "csaInspectionTotal": { "type": "integer" }, "csaDriverInspectionTotal": { "type": "integer" }, "csaDriverOosInspectionWithViolation": { "type": "integer" }, "csaVehicleInspectionTotal": { "type": "integer" }, "csaVehicleOosInspectionTotal": { "type": "integer" } } }, "CarrierInsurance": { "title": "Carrier Insurance", "description": "Insurance coverage information for a carrier, from both FMCSA-filed policies and Truckstop-managed insurance certificates.", "type": "object", "additionalProperties": false, "properties": { "fmcsaInsurance": { "$ref": "#/components/schemas/CarrierFmcsaInsurance" }, "managedInsurance": { "$ref": "#/components/schemas/CarrierManagedInsurance" } } }, "CarrierInsuranceCategory": { "title": "Carrier Insurance Category", "description": "A single category associated with a managed insurance coverage.", "type": "object", "additionalProperties": false, "properties": { "description": { "type": "string", "maxLength": 50, "nullable": true } } }, "CarrierInsuranceCertificate": { "title": "Carrier Insurance Certificate", "description": "A Truckstop-managed insurance certificate on file for a carrier.", "type": "object", "additionalProperties": false, "properties": { "certificateId": { "type": "integer" }, "mcNumber": { "type": "string", "maxLength": 50, "nullable": true }, "producerName": { "type": "string", "maxLength": 120, "nullable": false }, "producerEmail": { "type": "string", "maxLength": 80, "nullable": true }, "producerPhone": { "type": "string", "maxLength": 20, "nullable": true }, "producerFax": { "type": "string", "maxLength": 20, "nullable": true }, "producerAddress": { "$ref": "#/components/schemas/Address" }, "coverages": { "type": "array", "description": "Individual coverages on this certificate", "items": { "$ref": "#/components/schemas/CarrierInsuranceCoverage" } }, "equipment": { "type": "array", "description": "Equipment scheduled on this certificate", "items": { "$ref": "#/components/schemas/CarrierInsuranceEquipment" } } } }, "CarrierInsuranceCoverage": { "title": "Carrier Insurance Coverage", "description": "A single coverage on a managed insurance certificate.", "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "maxLength": 50, "nullable": false }, "status": { "$ref": "#/components/schemas/CoverageStatus" }, "effectiveDate": { "type": "string", "format": "date", "nullable": true }, "expirationDate": { "type": "string", "format": "date", "nullable": true }, "cancellationDate": { "type": "string", "format": "date", "nullable": true }, "policyNumber": { "type": "string", "maxLength": 50, "nullable": true }, "underwriter": { "type": "string", "maxLength": 120, "nullable": true }, "amBest": { "type": "string", "maxLength": 3, "nullable": true }, "renewalCertificateId": { "type": "integer", "nullable": true }, "renewalEffectiveDate": { "type": "string", "format": "date", "nullable": true }, "renewalExpirationDate": { "type": "string", "format": "date", "nullable": true }, "isAuto": { "type": "boolean", "nullable": true }, "isCargo": { "type": "boolean", "nullable": true }, "isGeneralLiability": { "type": "boolean", "nullable": true }, "isWorkersComp": { "type": "boolean", "nullable": true }, "isExcess": { "type": "boolean", "nullable": true }, "isUmbrella": { "type": "boolean", "nullable": true }, "isContingent": { "type": "boolean", "nullable": true }, "isPrimary": { "type": "boolean", "nullable": true }, "limits": { "type": "array", "description": "Coverage limits on file for this coverage", "items": { "$ref": "#/components/schemas/CarrierInsuranceLimit" } }, "categories": { "type": "array", "description": "Categories associated with this coverage", "items": { "$ref": "#/components/schemas/CarrierInsuranceCategory" } } } }, "CarrierInsuranceEquipment": { "title": "Carrier Insurance Equipment", "description": "A single piece of equipment scheduled on a managed insurance certificate.", "type": "object", "additionalProperties": false, "properties": { "vin": { "type": "string", "maxLength": 17, "nullable": false }, "year": { "type": "integer", "nullable": true }, "make": { "type": "string", "maxLength": 80, "nullable": true }, "model": { "type": "string", "maxLength": 140, "nullable": true }, "manufacturer": { "type": "string", "maxLength": 135, "nullable": true }, "gvwr": { "type": "string", "maxLength": 55, "nullable": true }, "vehicleType": { "type": "string", "maxLength": 40, "nullable": true } } }, "CarrierInsuranceLimit": { "title": "Carrier Insurance Limit", "description": "A single coverage limit on a managed insurance coverage.", "type": "object", "additionalProperties": false, "properties": { "description": { "type": "string", "maxLength": 75, "nullable": true }, "coverageAmount": { "type": "number", "nullable": true } } }, "CarrierInsurancePolicy": { "title": "Carrier Insurance Policy", "description": "A single FMCSA-filed insurance policy on file for a carrier.", "type": "object", "additionalProperties": false, "properties": { "underwriter": { "type": "string", "maxLength": 120, "nullable": true }, "policyNumber": { "type": "string", "maxLength": 50, "nullable": true }, "coverageType": { "type": "string", "maxLength": 50, "nullable": true }, "coverageAmount": { "type": "number", "nullable": true }, "effectiveDate": { "type": "string", "format": "date", "nullable": true }, "postedDate": { "type": "string", "format": "date", "nullable": true }, "cancellationDate": { "type": "string", "format": "date", "nullable": true } } }, "CarrierManagedInsurance": { "title": "Carrier Managed Insurance", "description": "Truckstop-managed insurance information for a carrier.", "type": "object", "additionalProperties": false, "properties": { "certificates": { "type": "array", "description": "Truckstop-managed insurance certificates on file for the carrier", "items": { "$ref": "#/components/schemas/CarrierInsuranceCertificate" } } } }, "CarrierOperation": { "title": "Carrier Operation", "type": "string", "enum": [ "Interstate", "Intrastate", "None" ], "description": "Type of carrier operation", "nullable": true }, "CarrierReputation": { "title": "Carrier Reputation", "description": "CPR (Carrier Performance Report) reputation data for a carrier.", "type": "object", "additionalProperties": false, "properties": { "score": { "$ref": "#/components/schemas/CprScoreBase" }, "reports": { "type": "array", "description": "Individual CPR reports on file for the carrier", "items": { "$ref": "#/components/schemas/CprReport" } } } }, "CarrierSafety": { "title": "Carrier Safety", "description": "Safety rating, crash, and inspection information for a carrier.", "type": "object", "additionalProperties": false, "properties": { "generalSafetyRating": { "type": "string", "maxLength": 50, "nullable": true }, "generalSafetyRatingDate": { "type": "string", "format": "date", "nullable": true }, "safetyRating": { "type": "string", "maxLength": 50, "nullable": true }, "safetyRatingDate": { "type": "string", "format": "date", "nullable": true }, "reviewType": { "type": "string", "maxLength": 1, "nullable": true }, "reviewDate": { "type": "string", "format": "date", "nullable": true }, "basedInCity": { "type": "string", "maxLength": 25, "nullable": true }, "basedInState": { "type": "string", "maxLength": 2, "nullable": true }, "totalCrashes": { "type": "integer" }, "fatalCrashes": { "type": "integer" }, "injuryCrashes": { "type": "integer" }, "towCrashes": { "type": "integer" }, "inspections": { "$ref": "#/components/schemas/CarrierInspectionsSummary" }, "inspectionsByState": { "type": "array", "description": "Inspection counts broken down by state", "items": { "$ref": "#/components/schemas/CarrierInspectionByStateSummary" } }, "csaBasics": { "type": "array", "description": "CSA BASIC category measures for the carrier", "items": { "$ref": "#/components/schemas/CarrierCsaBasicSummary" } } } }, "CoverageStatus": { "title": "Coverage Status", "description": "The status of an insurance coverage.", "type": "string", "enum": [ "Active", "Pending", "Expired", "Cancelled" ] }, "CprReport": { "title": "CPR report", "description": "CPR report result containing carrier report.", "type": "object", "additionalProperties": false, "properties": { "type": { "$ref": "#/components/schemas/CprReportType" }, "date": { "type": "string", "description": "date", "format": "date", "nullable": true }, "source": { "type": "string", "description": "source", "nullable": true }, "complaint": { "type": "string", "description": "source", "nullable": true }, "description": { "type": "string", "description": "source", "nullable": true } } }, "CprReportType": { "title": "Cpr Report Type", "description": "Enumeration of CPR report types.", "type": "string", "enum": [ "Good", "Bad" ] }, "CprScoreBase": { "title": "CPR Score Base", "description": "CPR rating and broker report counts shared across CPR score views.", "type": "object", "additionalProperties": false, "properties": { "cprRating": { "description": "The CPR grade rating of the carrier.", "type": "string", "nullable": true }, "hasActiveReports": { "description": "Whether the carrier has any good or bad reports on record.", "type": "boolean", "nullable": false }, "goodReportCountZeroToThirtyDays": { "description": "Good reports within 0-30 days.", "type": "integer", "nullable": true }, "goodReportCountThirtyOneToNinetyDays": { "description": "Good reports within 31-90 days.", "type": "integer", "nullable": true }, "goodReportCountNinetyOneToYear": { "description": "Good reports within 91-365 days.", "type": "integer", "nullable": true }, "goodReportCountOverOneYear": { "description": "Good reports over one year.", "type": "integer", "nullable": true }, "badReportCountZeroToThirtyDays": { "description": "Bad reports within 0-30 days.", "type": "integer", "nullable": true }, "badReportCountThirtyOneToNinetyDays": { "description": "Bad reports within 31-90 days.", "type": "integer", "nullable": true }, "badReportCountNinetyOneToYear": { "description": "Bad reports within 91-365 days.", "type": "integer", "nullable": true }, "badReportCountOverOneYear": { "description": "Bad reports over one year.", "type": "integer", "nullable": true } } }, "ExternalCarrier": { "title": "External Carrier", "description": "A monitored carrier, including the requested data modules on file for it.", "type": "object", "additionalProperties": false, "required": [ "dotNumber", "lastUpdated" ], "properties": { "dotNumber": { "type": "string", "description": "The DOT number of the monitored carrier.", "maxLength": 25, "nullable": false }, "docketNumbers": { "type": "array", "description": "An array of docket numbers associated with the monitored carrier.", "items": { "type": "string", "maxLength": 25 } }, "lastUpdated": { "type": "string", "format": "date-time", "description": "The date and time when the monitored carrier was last updated.", "nullable": false }, "modules": { "$ref": "#/components/schemas/ExternalCarrierModules" } } }, "ExternalCarrierAuthority": { "title": "External Carrier Authority", "description": "Authority information for a carrier.", "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/ExternalModuleBase" }, { "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CarrierAuthorities" } } } ] }, "ExternalCarrierDemographics": { "title": "External Carrier Demographics", "description": "Demographic information for a carrier.", "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/ExternalModuleBase" }, { "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CarrierDemographics" } } } ] }, "ExternalCarrierInsurance": { "title": "External Carrier Insurance", "description": "Insurance information for a carrier.", "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/ExternalModuleBase" }, { "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CarrierInsurance" } } } ] }, "ExternalCarrierModules": { "title": "External Carrier Modules", "description": "The requested modules of carrier data. A module is omitted when it was not requested via the `modules` query parameter.", "type": "object", "additionalProperties": false, "properties": { "demographics": { "$ref": "#/components/schemas/ExternalCarrierDemographics" }, "authority": { "$ref": "#/components/schemas/ExternalCarrierAuthority" }, "insurance": { "$ref": "#/components/schemas/ExternalCarrierInsurance" }, "safety": { "$ref": "#/components/schemas/ExternalCarrierSafety" }, "reputation": { "$ref": "#/components/schemas/ExternalCarrierReputation" } } }, "ExternalCarrierReputation": { "title": "External Carrier Reputation", "description": "Reputation information for a carrier, sourced from CPR (Carrier Performance Report) data.", "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/ExternalModuleBase" }, { "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CarrierReputation" } } } ] }, "ExternalCarrierSafety": { "title": "External Carrier Safety", "description": "Safety information for a carrier.", "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/ExternalModuleBase" }, { "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CarrierSafety" } } } ] }, "ExternalModule": { "title": "External Module", "description": "One of the data modules that can be requested for a monitored carrier.", "type": "string", "enum": [ "Demographics", "Authority", "Insurance", "Safety", "Reputation" ] }, "ExternalModuleBase": { "title": "External Module Base", "description": "Base schema shared by all carrier data modules.", "type": "object", "additionalProperties": false, "required": [ "status", "lastUpdated" ], "properties": { "status": { "$ref": "#/components/schemas/ExternalModuleStatus" }, "lastUpdated": { "type": "string", "format": "date-time", "description": "The date and time when this module's data was last updated. Null when status is NotFound, NotEntitled, or Unavailable, since no update time exists for the module in those cases.", "nullable": true }, "sources": { "type": "array", "description": "An array of source systems that populated this module's data.", "items": { "$ref": "#/components/schemas/ExternalSourceSystem" } } } }, "ExternalModuleStatus": { "title": "External Module Status", "description": "The status of a carrier data module. - Ok: The module's data was retrieved successfully. - NotFound: No data is on file for this carrier/module. - NotEntitled: The caller is not authorized to access this module. - Unavailable: An error occurred while retrieving this module's data.", "type": "string", "enum": [ "Ok", "NotFound", "NotEntitled", "Unavailable" ] }, "ExternalSourceSystem": { "title": "Source System", "description": "The source system that populated a carrier external module.", "type": "string", "enum": [ "DotCensus", "DotAuthority", "DotSafety", "DotInspections", "DotCrash", "DotInsurance", "DotOutOfService", "TruckstopManagedInsurance", "TruckstopInternal" ] } }, "responses": { "Standard400": { "description": "There was a problem with the data provided for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "Standard401": { "description": "Authorization was denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "Standard500": { "description": "A server side error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "Standard404": { "description": "The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "Standard499": { "description": "The request was closed by the client before the server could respond.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "servers": [ { "url": "http://api.truckstop.com/carrierhub/v1" } ], "x-readme": {}, "security": [ { "bearerAuth": [] } ] } ```