Build high-volume Apple Wallet (.pkpass) and Google Wallet integrations. Issue, update, scan, and broadcast real-time lockscreen notifications via production-grade REST APIs.
Retrieve the canonical distribution URLs for a pass, including the hosted download page link, direct Apple Wallet (.pkpass) URL, Google Wallet save link, and QR code URL.
Headers1 required
X-API-Keystring
Required
Workspace secret API key (pi_live_... or pi_test_...). You may alternatively send Authorization: ApiKey <key>.
Resolve a public branded pass download page payload by slug (prefix-free GET /d/{slug}/info). For authenticated management lookup by slug, use GET /api/v1/download-pages/slug/{slug}.
Temporarily re-enable downloading for an already-installed pass when template re-download lock is active (defaults to a 10-minute window if enableDownloadUntil is omitted).
Headers1 required
X-API-Keystring
Required
Workspace secret API key (pi_live_... or pi_test_...). You may alternatively send Authorization: ApiKey <key>.
Example: pi_live_98a7b6c5d4e3f2a1
Path Parameters1 required
idstring (UUID)
Required
Pass UUID to unlock for download.
Example: b1d972dc-eccf-4f87-ab21-25939d9213d8
Optional timestamp specifying how long re-download remains unlocked.
Send an immediate push notification and lock-screen message to an installed Apple Wallet (.pkpass) or Google Wallet pass. For scheduled sends or custom notification headers, use POST /api/v1/push-notifications/passes/{id}.
Headers1 required
X-API-Keystring
Required
Workspace secret API key (pi_live_... or pi_test_...). You may alternatively send Authorization: ApiKey <key>.
Example: pi_live_98a7b6c5d4e3f2a1
Path Parameters1 required
idUUID
Required
Unique pass instance UUID to receive the notification.
Example: 9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d
Request payload containing message body and optional header title.
Request Body1 required • 1 optional
messagestring
Required
Text message to display on the user's lock-screen.
Example: Your reward points have been updated! You now have 250 points.