This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

toolsTools

Utility endpoints that support common operational tasks: generating barcodes, managing the tenant cache, verifying email addresses, and querying the analytics database with KQL.

Utility endpoints that support common operational tasks: generating barcodes, managing the tenant cache, verifying email addresses, and querying the analytics database with KQL.

Barcode

Generate barcode and QR code images server-side. Useful when you need to embed a scannable code in a PDF, email, receipt, or printed document — without relying on the client to render it.

Supported symbologies include QR Code, Code 128, PDF417, EAN-13, and Data Matrix. The response is an image in the requested format (PNG, SVG, or base64).

Cache

The Wallet Crew caches rendered pass content to reduce latency at scale. The Cache endpoints let you invalidate cached content for a tenant or a specific pass when data changes outside the normal update flow.

Operation
Description

Flush tenant cache

Force re-render of all passes on next request.

Flush pass cache

Force re-render of a specific pass.

Use cache flush sparingly. Normal pass updates via the Pass API already invalidate the relevant cache entries automatically.

EmailVerifier

Validate an email address in real time — before creating a customer profile or issuing a pass. The verifier checks:

  • Syntax validity (RFC 5321).

  • Domain existence and MX record resolution.

  • Optionally, mailbox-level verification against the mail server.

This helps prevent duplicate or invalid profiles caused by typos at enrolment time.

Insights

The Insights endpoint runs Kusto Query Language (KQL) queries against the tenant's analytics database. This is the programmatic access point for custom dashboards, BI pipelines, scheduled reports, and data exports.

Database tables

Table
Retention
Description

Events

Indefinite

Page views, API requests, pass lifecycle events, scan events, customer events.

Metrics

Indefinite

Hourly snapshots of system state (active passes, install counts, etc.).

Logs

45 days

Platform traces and error logs for debugging.

Common queries

Key event types

Category
Event types

Pass lifecycle

Pass:Created, Pass:Updated, Pass:Installed, Pass:Uninstalled

Customer

Customer:Upserted

Wallet actions

action:addToAppleWallet, action:addToGoogleWallet

Social sign-in

action:loginWithGoogle, action:loginWithApple

Tracking

Request, PageView, Redirect:Redirected

Authentication and limits

Requirement
Value

Scope

Insights.Read

Rate limit

60 requests / minute

Query access

Single-tenant only — you cannot query another tenant's data

Further reading

Last updated