Getting Started | QwikLive Digital API

Prerequisites

Sandbox credentials — a client_id, client_secret, and partnerId issued to your organization.
An HTTPS client capable of sending JSON request bodies.
The path version segment — use v1.

Base URL

All endpoints are relative to the digital experience base path:

Base path

https://<your-qwiklive-host>/api/digital/v1

Authentication

Every request carries client credentials plus a partner identifier as headers:

Header	Required	Description
`X-Client-Id`	Required	Your QwikLive client identifier.
`X-Client-Secret`	Required	Your client secret. Never log or expose this value.
`partnerId`	Required	Partner identifier issued to your organization.
`X-Correlation-Id`	Optional	Client-supplied trace id, echoed back for end-to-end tracing.
`Content-Type`	Conditional	`application/json` on requests that send a body.

See the Authentication guide for full detail.

Your First Call — Redeem a Token

Redeem tokenized funds back to a linked account. Adjust the credentials, accounts, and amounts for your integration — sandbox values are illustrative.

cURL

curl -X POST "https://<host>/api/digital/v1/token-redemptions" \
  -H "X-Client-Id: your-sandbox-client-id" \
  -H "X-Client-Secret: $CLIENT_SECRET" \
  -H "partnerId: QWIKLIVE" \
  -H "X-Correlation-Id: 7c3e1b90-2a44-4c8e-9b1a-0f5d2a6e8c10" \
  -H "Content-Type: application/json" \
  -d '{
    "transaction": { "ref": "123456700112", "type": "TOKEN_REDEMPTION" },
    "channelInfo": { "type": "MOBILE_APP" },
    "tokenAmount": { "currency": "USD", "tokens": 1000.12, "tokenType": "TOKENIZED_DEPOSIT" }
  }'

💡

Always check the response body, not just the status

A 200 confirms the request was accepted. Read the returned resource for the authoritative state, and inspect the error envelope on any non-2xx.

Next Steps

⚡

Quick Start

Tokenized deposit to redemption in minutes.

📄

API Reference

All 19 endpoints across 9 domains.

🧩

Common Objects

transaction, originator, tokenAmount, institution.