Skip to content
Livstick Developers

Livstick Client API v3.1

API v3.1

The complete surface of the Livstick client API v3.1, generated from the OpenAPI specification the service publishes — what you read here is what the service accepts today, not a transcription of it. v3.1 is served under its own base path, beside v3, for the platforms on the V3 user app. Each operation has its own page, carrying its required scope, its parameters, its request body, every response it can return, and a call you can copy. The schemas they reference are gathered on a single page, and every schema name links to its definition.

Version
3.1.0
Base URL
https://<client-api-host>/api/v3.1
Authentication
Bearer token

Use Authorization: Bearer liv_<prefix>_<secret>. The key must belong to a platform served by the V3 pipeline; otherwise every route answers 403 PLATFORM_NOT_V3.

health

Service health endpoints.

containers

Container lifecycle (one container per order or savings pot).

delivery

Recipient notification, unlock, QR code and printed card.

messages

Message reads, release and deletion by your own reference (mrid).

tokens

Short-lived tokens for the Livstick widget.

webhooks

Outgoing webhook delivery journal.

Schemas — API v3.1