Guides

Practical, step-by-step tutorials for common workflows. Each guide uses real API responses and production-ready code you can copy into your project.

Your First Carrier Lookup

Beginner5 min

Go from zero to a working API integration in 5 minutes. Look up a carrier by DOT number, parse 280+ response fields, search by company name, and handle errors gracefully.

Monitor Carrier Authority

Intermediate15 min

Build a monitoring pipeline that tracks authority status, insurance lapses, and safety changes across your carrier portfolio. Includes a complete daily-check script with alerting patterns.

Build a Carrier Vetting View

Advanced20 min

Combine authority verification, insurance validation, safety scoring, fleet analysis, and fraud detection into a single carrier vetting function. The complete underwriter and broker workflow.

Build an Insurance Underwriting Risk Check

Advanced20 min

Turn one /v2/profile call into a tiered underwriting determination — disqualifiers, crash-predictive BASIC alerts, ISS, safety rating, and CarrierOk's composite risk score — in about 60 lines of Python.

CarrierOk API vs FMCSA Data Sources

Beginner10 min

What SAFER, the QCMobile API, SMS, and L&I each give you — and withhold — versus one /v2/profile call. Includes an honest when-free-sources-are-enough section and a capability matrix.

Get All 7 BASIC Percentiles

Intermediate10 min

Retrieve every FMCSA BASIC percentile by API — including Crash Indicator and Hazmat Compliance, which FMCSA doesn't display publicly. Covers the six field families, the 0–1 scale, real spellings, and data-sufficiency rules.

Migrate from the Legacy API

Beginner10 min

On the gateway.dev host with an X-Api-Key header? Move to api.carrierok.com and Bearer keys — same endpoints, same response shape, two lines change. Includes the full endpoint mapping table.

Reference

Already know what you're looking for? Jump straight to the endpoint reference.