# Shakewell Wallet

> Apple Wallet and Google Wallet pass platform for loyalty, membership and event cards. A visual builder, hosted signup forms, push notifications and a REST API, on flat monthly plans.

## Developer docs
- [Overview](https://shakewellwallet.com/docs): Base URL, authentication summary and resources.
- [Authentication](https://shakewellwallet.com/docs/authentication): Authenticate to the Shakewell Wallet REST API with an API key sent as a Bearer token or an X-API-Key header. How to create, scope and revoke keys.
- [Quickstart](https://shakewellwallet.com/docs/quickstart): Issue an Apple Wallet and Google Wallet pass with the Shakewell Wallet API in four steps, with cURL, Node, PHP and Python examples you can paste.
- [Templates](https://shakewellwallet.com/docs/templates): List, create, update and delete wallet card templates with the Shakewell Wallet API. Fields, image uploads, status values and the errors you can hit.
- [Passes](https://shakewellwallet.com/docs/passes): Create, list, fetch, update and delete Apple Wallet and Google Wallet passes with the Shakewell Wallet API, including identifiers, statuses and pagination.
- [Push notifications](https://shakewellwallet.com/docs/push-notifications): Send lock-screen messages to one wallet pass or to many with the Shakewell Wallet API. Message limits, targeting by template and the errors returned.
- [Webhooks](https://shakewellwallet.com/docs/webhooks): The Shakewell Wallet API does not yet push webhooks to your endpoint. See how to track installs by polling, and how inbound integration webhooks are verified.
- [Hosted signup links](https://shakewellwallet.com/docs/signup-links): Give customers a hosted signup page for any template. How the link is built, when a form is live, what limits apply and how to handle the errors.
- [Apple Wallet setup](https://shakewellwallet.com/docs/apple-wallet): What you need for Apple Wallet passes on Shakewell Wallet: who holds the signing certificate, what Apple requires, and how passes reach an iPhone.
- [Google Wallet setup](https://shakewellwallet.com/docs/google-wallet): How Google Wallet passes work on Shakewell Wallet: who manages the issuer credentials, how customers add a pass on Android, and how updates are delivered.
- [Rate limits and errors](https://shakewellwallet.com/docs/rate-limits-and-errors): The 60 requests a minute API limit, the JSON error envelope and every status and error_code the Shakewell Wallet public API returns, with fixes.
- [API reference](https://shakewellwallet.com/docs/api-reference): Download the Shakewell Wallet OpenAPI 3 spec and a Postman collection for the public REST API: wallet passes, card templates and push notifications.
- [OpenAPI spec](https://shakewellwallet.com/docs/openapi.json): OpenAPI 3 description of the public API.
- [Postman collection](https://shakewellwallet.com/docs/postman_collection.json): Importable collection for the public API.

## Troubleshooting
- [401 Unauthorized](https://shakewellwallet.com/docs/troubleshooting/401-unauthorized): Why the Shakewell Wallet API returns 401 Unauthorized, the difference between a missing and an invalid API key, and how to fix both in minutes.
- [403 feature_required](https://shakewellwallet.com/docs/troubleshooting/403-feature-required): feature_required with feature_key has_api_access means your plan has no API access. See what the error means and how to unlock API keys.
- [403 template_limit_exceeded](https://shakewellwallet.com/docs/troubleshooting/403-template-limit-exceeded): template_limit_exceeded means your account has reached its plan's template cap. How to check usage, free a slot or upgrade, and retry the create.
- [403 card_limit_exceeded](https://shakewellwallet.com/docs/troubleshooting/403-card-limit-exceeded): Customers see an error on your signup form when the account hits its card limit. What card_limit_exceeded means and how to restore signups quickly.
- [403 UNAUTHORIZED_ACCESS](https://shakewellwallet.com/docs/troubleshooting/403-unauthorized-access): UNAUTHORIZED_ACCESS on the templates API means the key lacks write access or the template belongs to another account. How to diagnose and fix it.
- [404 WALLET_PASS_NOT_FOUND](https://shakewellwallet.com/docs/troubleshooting/404-wallet-pass-not-found): WALLET_PASS_NOT_FOUND means no pass with that ID exists on your account. Check the ID format, the account and whether the pass was deleted.
- [400 PASS_NOT_INSTALLED](https://shakewellwallet.com/docs/troubleshooting/400-pass-not-installed): PASS_NOT_INSTALLED means the customer has not added the pass to a wallet yet, so there is no device to notify. Why it happens and how to proceed.
- [422 VALIDATION_ERROR](https://shakewellwallet.com/docs/troubleshooting/422-validation-error): How to read a 422 VALIDATION_ERROR from the Shakewell Wallet API, including the per-template person fields that make a create-pass call fail.
- [409 WALLET_PASS_TEMPLATE_MISSING](https://shakewellwallet.com/docs/troubleshooting/409-wallet-pass-template-missing): WALLET_PASS_TEMPLATE_MISSING means the pass's template no longer exists, so an update cannot be applied. What to do with the orphaned pass.
- [429 Too Many Attempts](https://shakewellwallet.com/docs/troubleshooting/429-too-many-requests): The Shakewell Wallet API allows 60 requests a minute per IP address. How to spot a 429, add backoff and avoid it with bulk calls.
- [422 sign-up form not accepting registrations](https://shakewellwallet.com/docs/troubleshooting/422-signup-form-not-live): Customers see this on a hosted signup link when the form is not live. How to switch it on and what else produces a 404 on the same link.
- [500 WALLET_PASS_*_FAILED](https://shakewellwallet.com/docs/troubleshooting/500-wallet-pass-failed): What 500 responses such as WALLET_PASS_CREATE_FAILED and NOTIFICATION_SEND_FAILED mean, which are safe to retry and what to send support.

## Help centre
- [Do my customers need to download an app?](https://shakewellwallet.com/help/do-customers-need-an-app): No app needed. Customers add your card to the Apple Wallet or Google Wallet already on their phone from a link or QR code in about two taps.
- [How much does Shakewell Wallet cost?](https://shakewellwallet.com/help/how-much-does-it-cost): Shakewell Wallet uses flat monthly plans with no per-pass fees. See what Starter, Growth, Scale and Enterprise include and how active passes are counted.
- [Is there a free trial?](https://shakewellwallet.com/help/is-there-a-free-trial): Sign up and design your card with no credit card. Your 14-day trial of the plan you choose starts when you publish your first card, and you can cancel any time.
- [Do I need an Apple Developer account?](https://shakewellwallet.com/help/apple-developer-account): No. Passes are signed with Shakewell's own Apple certificate, so you do not need an Apple Developer account of your own.
- [What is the difference between a wallet pass and a loyalty app?](https://shakewellwallet.com/help/wallet-pass-vs-loyalty-app): A wallet pass sits in Apple Wallet or Google Wallet with nothing to install. A loyalty app needs a download. Compare how each reaches customers.
- [How do I create my first wallet pass?](https://shakewellwallet.com/help/create-your-first-pass): Create your first Apple Wallet and Google Wallet pass in the visual builder: pick a type, brand it, build the signup form and share the link.
- [How do customers get their pass?](https://shakewellwallet.com/help/how-customers-get-their-pass): Customers get a pass from a hosted signup link, a QR code, an embedded form, or an install link your system sends after using the API.
- [Can I update a pass after customers have installed it?](https://shakewellwallet.com/help/update-a-pass-after-install): Yes. Edit a template or update a pass from the dashboard or API and installed passes get the new version without customers adding the card again.
- [How do push notifications work?](https://shakewellwallet.com/help/how-push-notifications-work): Send lock-screen messages to customers who added your pass. Choose one customer, a segment or everyone on a template. No charge per notification.
- [Does it work on both iPhone and Android?](https://shakewellwallet.com/help/iphone-and-android): One template produces Apple Wallet passes for iPhone and Google Wallet passes for Android. Samsung Wallet is not supported yet.
- [What counts as an active pass?](https://shakewellwallet.com/help/what-is-an-active-pass): Active passes are installed and being updated. A pass sent but never added, or one the customer deleted, does not count toward your plan limit.
- [What happens if I go over my plan's pass limit?](https://shakewellwallet.com/help/exceeding-pass-limit): Nothing breaks if you exceed your plan's pass count. We talk to you about a larger plan and never auto-charge overage or interrupt service mid-month.
- [Can I change or cancel my plan?](https://shakewellwallet.com/help/change-or-cancel-plan): Upgrade or downgrade at any time. Upgrades apply immediately and are pro-rated; downgrades apply at the end of your billing period.
- [Where is my customers' data stored?](https://shakewellwallet.com/help/where-is-data-stored): Customer data is stored in Australia or the United States by default. Scale and Enterprise customers can set residency requirements in their contract.
- [Can I export my customers' data?](https://shakewellwallet.com/help/export-customer-data): Every plan includes a CSV export of your passholders, so you can take your customer list into other tools or to another provider.
- [Can I move over from PassKit?](https://shakewellwallet.com/help/switch-from-passkit): Yes. Pass templates and customer data export cleanly and we help rebuild templates in the visual builder. Most teams migrate in one to two weeks.
- [Does Shakewell Wallet have an API?](https://shakewellwallet.com/help/do-you-have-an-api): Yes. Use the REST API to create and update wallet passes, manage templates and send push notifications from your own systems. Docs and OpenAPI included.

## Optional
- [Pricing](https://shakewellwallet.com/pricing): Plans and what each includes.
- [Free pkpass validator](https://shakewellwallet.com/tools/pkpass-validator): Checks an Apple Wallet .pkpass file in the browser.
- [Changelog](https://shakewellwallet.com/changelog): Product changes.
- [Glossary](https://shakewellwallet.com/glossary): Wallet pass terms.