Korti Docs

How Korti works

There are three things to know about.

• A card is the design: your colours, logo, picture and fields. You make it in the dashboard and publish it. Publishing freezes a version, so the cards people already have don’t change by accident.
• A pass is one customer’s copy of a card. It has its own serial number, its own values (stamps, points, balance) and its own link that adds it to the right wallet.
• An event is anything that happens to a pass: it was issued, saved, scanned, stamped, redeemed or voided. You see events in the dashboard, in the API and as webhooks.

When a pass changes, Korti pushes the new version to every phone that saved it. On iPhone that takes a few seconds. You never send anything to Apple or Google yourself.

Without writing code

Most businesses never need the API. In the dashboard you can design a card, hand it out with a link or a QR code, scan it at the counter and send updates to everyone who has it. Start with Your first card.

With the API

The API is for when your own systems should do it: a booking system that issues a membership when someone signs up, a till that adds a stamp with each coffee, or a website that tops up a gift card. Everything the API does is plain HTTPS and JSON, so any language works.

• Quickstart: create a key, issue a pass and add a stamp in about five minutes.
• Issue a pass: the details, with a live Try it panel.
• Webhooks: get told when something happens instead of asking.
• API reference: every endpoint. There’s also an OpenAPI spec for generating clients, and an interactive explorer.