Custom API
Live pass
Reference only. Not a decision unless cited in product/DECISIONS.md.
Live pass
Day-of admission is a rotating code on the ticket page, not a static barcode from checkout or email. This page is the partner contract for that pass.
Who this is for
Venue engineers on headless or Web SDK who need to know what guests see and which APIs power the pass. Prefer hosted delivery or the Web SDK ticket UI unless you are building a custom pass surface.
What guests experience
- After pay, email CTA is Open Live Pass (hosted bearer link by default). Wallet is last: Saves the event in Wallet. Show this page at the door.
- Opening the pass binds the phone and downloads a pre-signed slot pack to that surface. The rotating door code keeps working after they lose cell if they opened once after the code turned on, with signal. A later cold open (tab kill) reads the cached lookup,
arm_at, and pack from IndexedDB. No service worker is required. Pack window is event end + 2h (cap 72h). KEEP_ROTATE 45s. - At doors minus 6 hours, a branded organizer email says Your {event} entry code is live. Open it now. That mail does not remint a bearer. It opens the same public Live Pass (
/p/{share_code}) as the purchase email. If that share code is not on file, AXYN skips the mail instead of sending the you-paid confirmation page or My Tickets. - An additional phone or browser may require email confirmation (step-up) before it can mint. Safari (in-app sheets never mint; they send the guest to Open in Safari) and a Home Screen icon saved from the Add to Home Screen how-to share one device id. Home Screen is not a second phone. The device id never rides in a shared or copied Live Pass link: forwarding the link means a new device (ENG-2166).
- Confirm links land on the same ticket URL with a
sidquery param. The guest confirms (or requests a resend) without creating an AXYN account. - Laptop confirmation does not bind a device. Copy: Open this on the phone you are bringing.
- Gmail / Instagram in-app sheets show Open in Safari (iOS) or Open in Chrome (Android). The pack is stored in that browser, not the mail sheet.
- If there is no current slot, guests see ticket ID plus Need a moment of signal, or see staff with your name. Never a frozen QR.
- Private browsing does not promise offline.
- Add to Home Screen is the door icon (Share → Add to Home Screen). The icon name is the event. Live Activity is later: web cannot start ActivityKit.
Do not promise a forever screenshotable admit code in confirmation copy, PDFs, or wallet art that bypasses the live pass.
Residual: dumping the pack
A guest who opens Live Pass with signal receives pre-signed HMACs for the pack window. Copying that pack (devtools export, screen-record every frame) can show current slots until the window ends. That is accepted. Blast radius is the pack window (event end + 2h, cap 72h). First-scan / re-entry still caps admissions. Transfer revokes the session. Do not market this as unstealable.
Auth model
| Surface | Credential |
|---|---|
| Hosted ticket page / guest embed | Ticket-url bearer in the path |
| Signed-in My Tickets | Buyer JWT |
| Tenant secret API key | Not used for live pass mint |
There is no secret-key “mint pass for this email” API.
Public routes (guest bearer)
Confirm request/response bodies in
Full API list (openapi.json).
| Method | Path |
|---|---|
POST | /v1/ticket-url/{token}/live-qr/mint |
POST | /v1/ticket-url/{token}/live-qr/extend |
POST | /v1/ticket-url/{token}/live-qr/confirm-step-up |
POST | /v1/ticket-url/{token}/live-qr/resend-step-up |
Mint may return 403 with error: "step_up_required" and data.sid.
That starts the email confirm flow. Confirm requires the HMAC confirm
secret from the holder-email URL in addition to sid. The requesting
client cannot confirm with only the 403 sid plus bearer. Request bodies
are in OpenAPI.
Owned routes (buyer JWT)
| Method | Path |
|---|---|
POST | /v1/me/tickets/{ticketId}/live-qr/mint |
POST | /v1/me/tickets/{ticketId}/live-qr/extend |
POST | /v1/me/tickets/{ticketId}/live-qr/confirm-step-up |
POST | /v1/me/tickets/{ticketId}/live-qr/resend-step-up |
Same step-up behavior as the guest bearer path.
Embed vs hosted
| Mode | What you do |
|---|---|
| Hosted (default) | Rely on AXYN email + /tickets/{token}. No custom mint UI. |
| Embed | Mount Web SDK BearerTicketScreen (or equivalent) with a bearer you already have. The SDK handles mint, rotate, and step-up. |
Email still points at the hosted URL unless you replace that link in your own product. Custom ticket domains are not available yet.
Do / do not
Do
- Design post-pay UI as order success + open pass.
- Keep Wallet last: Saves the event in Wallet. Show this page at the door. No static door bypass.
- Use OpenAPI field names exactly when calling mint/extend/confirm/resend.
Do not
- Email or PDF a scannable admit barcode for door entry.
- Build a public email→tickets or “re-fetch raw bearer later” API.
- Put the tenant secret key in the browser to drive the pass.
- Skip step-up UX if you reimplement mint yourself.
- Document or depend on door scanner Live QR rules that are not in OpenAPI as partner GA.
Related
| Page | Role |
|---|---|
| Ticket delivery | Buy vs see; email honesty |
| Transfer | Send a pass; claim → new live pass |
| Upgrade | Same URL after a paid type change |
| Headless API | Checkout architecture |
| Full API list | Machine contract |