08The ORN API · Build on the journey record
The journey record, opened to your software.
The ORN API is the same structured journey infrastructure that powers the platform — journeys, checkpoints, safety signals, route context and ORION intelligence — served over HTTPS for the software you build around your operation.
01What the API is
One interface to the records your operation already runs on.
Every operation in the ORN API works on the same structured records the platform itself keeps: journey records with routes and checkpoints, passengers checked in by QR code, safety signals, and the journey stage as it changes. Nothing is re-modelled for the API — your software reads and writes the same shape of truth the network runs on.
Calls go to /api/v1 with a bearer key. Responses are JSON. Operation names say what they do — create_journey, retrieve_journey_timeline, request_operational_safety_assessment — so an endpoint list reads like an operations ledger, not a puzzle.
02Key capabilities
Sixty-one operations across six capability families.
Each operation is priced, scoped and recorded. Build a fleet dashboard, a booking front-end, a checkpoint mirror for your control room, or an analytics layer — on the same records your operation runs on.
Journeys · 20 operations
Create, update, activate, cancel, monitor and summarise journeys — the full lifecycle, from draft to analysed.
Checkpoints · 6 operations
Planned points between pickup and destination: state, ETA, history and evidence summaries, with authorized observations.
Safety · 8 operations
Safety context, events, evidence and authorized escalation — structured so a fast response stays an accountable one.
Route · 9 operations
Route summaries, ETA, traffic context, delay and condition analysis — the road as structured context for the journey.
Intelligence · 13 operations
ORION-grounded analysis over the journey record, from basic contextual reads to enterprise specialized intelligence.
Passengers · 5 operations
Participation summaries, experience and sentiment insight — the passenger side of the record, aggregated.
03Journey Intelligence
ORION, reachable over HTTP.
The intelligence family exposes ORION's analysis of a journey — risk context, multi-signal reads, specialized assessments — grounded in the records behind the question. Outputs are structured: a level, a rationale, contributing factors. Safety context is there where the record supports it.
Thirteen operations, tiered from basic contextual analysis to deep specialized intelligence — the depth available to an application follows the operation's subscription tier. And the guardrail holds over the API too: consequential suggestions resolve to a human decision, never silent execution.
Grounded
Analysis cites the journey records behind it
Tiered
Basic to specialized, matched to the subscription
Human-approved
The API returns the recommendation — people decide
04API access model
An access model with edges.
Access starts with the operation: ride owners register, get verified with the ORN team, and choose a subscription — the API extends that operation to partner software through a linked API organization. From the Developer Console you create applications, one per integration, each in a named environment: sandbox first, production when it is ready.
Scopes are granted at the application level and credentials inherit them — a key can never carry privileges its application does not already hold.
Applications
One per integration — sandbox or production
Scopes
Nine capabilities, fail-closed, granted at the application
Credentials
Environment-encoded keys, shown once, revocable
05Pricing & usage
Metered like a utility. Itemized like a ledger.
Usage is priced per operation from a versioned register — every operation has a known price, and the register itself carries a version, so changes are explicit rather than silent. Calls draw from a prepaid wallet: you fund it once through Paystack, the API draws it down per call, and every charge lands on an itemized ledger you can audit from the console.
Wallet packages start at ₦15,000, scale with the size of the operation, and funding is idempotent — a retried payment funds the wallet exactly once.
Per operation
Price set by a versioned register — explicit, never silent
Prepaid wallet
Fund from ₦15,000; each call draws the register price
Itemized ledger
Every charge on the record — usage you can audit
06Security
Keys with edges. Operations with receipts.
The API assumes its keys will travel: they are environment-scoped, hashed at rest, shown exactly once, and revocable the moment you want them gone.
Environment separation
Encoded in the key itself — an orn_test_ key never touches production data, by construction
No standing secrets
Only a hash is stored. The raw key exists at creation, is copied once, and never again
Fail-closed authorization
No matching scope, no operation — unknown scopes deny by default, so privilege is never assumed
07Getting started
From console to first call.
Once your operation is registered and verified, the path from an empty console to a working integration is four steps — and the sandbox exists so the first call costs nothing but attention.
Create an application
Sandbox first, with the scopes it needs — no more.
Issue a key
Shown once. Copy it — it will not be displayed again.
Fund the wallet
From ₦15,000. Charged per call, itemized per charge.
Make the first call
Read a journey you own. Then build from there.
The documentation walks the whole path — authentication, environments, scopes, and every operation with its purpose, pricing and permissions. Questions about access or integration go to the support desk — a person answers.
Build on the record.
The ORN API is open to ride owners and partner operations on the network. Open the Developer Console to create your first application — or read the documentation first.