Welcome to
QwikLive Developer Docs

QwikLive exposes its capabilities through two families of APIs. They solve different problems, and knowing which is which is the fastest way to start building. Most teams end up using both. Read the short guide below, then open whichever fits what you're building.

Experience APIs: build one channel, fast.

Experience APIs are purpose-built for a single channel — a mobile app, web banking, an ATM, a teller terminal, or the contact centre. Each endpoint returns data already shaped for the screen it serves, so you make one call instead of stitching several together. Reach for these when you're delivering a specific channel end to end and want to move fast: Self-Service Banking, Platform Administration, and Digital Assets Banking.

Canonical APIs: the reusable core.

Canonical APIs are channel-agnostic building blocks organized by banking domain — accounts, payments, transfers, and lending. Each does one thing well and behaves identically wherever it's called, from a mobile app, a batch job, or a partner system. Reach for these when you're building something custom, or reusing the same capability across several channels.

How they fit together.

Experience APIs are built on top of Canonical APIs. Canonical is the core banking logic; Experience is a channel-tuned layer over it. If a ready-made Experience API covers your channel, start there — if you need something it doesn't offer, drop down to the Canonical APIs underneath.