# PassEntry - [Getting Started with PassEntry](https://docs.passentry.com/index.md): Learn how to create templates, issue digital passes and add them to Apple Wallet & Google Wallet using the PassEntry dashboard. - [Pass template types: layouts, fields, and use cases](https://docs.passentry.com/documentation/pass-template-types-explained.md): Understand PassEntry pass template types, how they differ in layout and supported fields and why they do not restrict your use case. - [Adding an Apple Pass Certificate](https://docs.passentry.com/documentation/adding-an-apple-pass-certificate.md): Set up an Apple Pass Type Identifier and certificate in PassEntry to issue Apple Wallet passes, plus certificate expiration, renewal and pass grouping. - [PassEntry Reader App Configuration Guide](https://docs.passentry.com/documentation/guides/passentry-reader-app/guide.md): Learn how to set up and configure the PassEntry Reader app to scan, validate and redeem Apple Wallet and Google Wallet passes using NFC or QR codes, including reader creation, login and available reader modes. - [Using Third-Party Validation with PassEntry](https://docs.passentry.com/documentation/guides/validation-options/guide.md): Learn how to configure third-party validation so your own system can control how passes are validated during scans, including custom validation logic, reader behaviour and optional loyalty updates in a single request. - [Custom Pass Issuance Forms](https://docs.passentry.com/documentation/guides/custom-download-forms/guide.md): Design customer-facing pass issuance forms on a pass template so users can enter their details and download passes themselves, without an API integration. - [VTAP Automatic Reader Setup](https://docs.passentry.com/documentation/guides/vtap-reader/guide.md): Learn how to automatically configure VTAP NFC readers from the PassEntry Dashboard without using a VTAP Cloud account, including network setup and activation steps. - [Connecting Your POS to a PassEntry Terminal](https://docs.passentry.com/documentation/guides/pos-integration/guide.md): Learn how to connect your point-of-sale system to a PassEntry terminal so customers can tap or scan their wallet pass for loyalty points, membership and event access, while you keep your existing payment hardware. - [Integrating with PassEntry via Zapier](https://docs.passentry.com/documentation/guides/zapier/guide.md): Connect CRM, e-commerce, and marketing tools to PassEntry with Zapier to automate pass issuance, updates, loyalty balances, and wallet events. - [Batch wallet notifications and logging](https://docs.passentry.com/documentation/bulk-operations/batch-notifications/guide.md): Send wallet notifications in bulk using pass IDs, segments, or CSV uploads, and track delivery status and errors for large-scale messaging. - [Batch pass creation: issue passes at scale via CSV upload](https://docs.passentry.com/documentation/bulk-operations/batch-pass-creation/guide.md): Create passes at scale in the PassEntry Dashboard by uploading a CSV, mapping template fields, and reviewing batch results to fix any errors. - [Batch Pass Update](https://docs.passentry.com/documentation/bulk-operations/batch-pass-update/guide.md): Update existing passes in bulk with CSV uploads in the PassEntry Dashboard, map template fields, track batch progress and resolve row errors. - [Pass Identifiers](https://docs.passentry.com/documentation/passes/identifiers/guide.md): UUID vs extId - when to use each, and how to map passes to records in your own system. - [Downloading Passes](https://docs.passentry.com/documentation/passes/downloading-passes/guide.md): Deliver passes with PassEntry's hosted download page or direct Apple Wallet and Google Wallet pass source delivery, and customise the download page. - [Pass Binding](https://docs.passentry.com/documentation/passes/pass-binding/guide.md): Restrict digital passes to a specific wallet account, preventing sharing and unauthorized use on both Apple Wallet and Google Wallet. - [Geofencing and iBeacons for wallet pass notifications](https://docs.passentry.com/documentation/passes/geofencing/guide.md): Learn how to use geofencing and iBeacons to trigger location-based behaviour for Apple Wallet and Google Wallet passes, including platform-specific limitations. - [Notifications](https://docs.passentry.com/documentation/passes/notifications/guide.md): Learn how to send wallet-native notifications to Apple Wallet and Google Wallet passes, including platform limits, best practices and how to include links and dynamic data in notifications. - [Pass lifecycle: statuses, deactivation, and reactivation](https://docs.passentry.com/documentation/passes/lifecycle/guide.md): Understand PassEntry pass statuses and what happens in Apple Wallet and Google Wallet when a pass is issued, deactivated, expired, or reactivated. - [Pass nullification: GDPR-compliant data removal](https://docs.passentry.com/documentation/passes/nullification/guide.md): Permanently remove passholder data from a PassEntry pass while keeping a tombstone record for billing, and reuse the External ID afterwards. - [Apple Poster Designs](https://docs.passentry.com/documentation/passes/apple-poster-designs/guide.md): Give Apple Wallet passes a full-bleed poster face, with the generic poster design, its artwork and field layout, and up to two featured action buttons. - [Design Guide](https://docs.passentry.com/documentation/passes/design/guide.md): Learn how to design high-quality Apple Wallet and Google Wallet passes with the right image formats, sizes and platform-specific best practices to ensure your passes look sharp and consistent across devices. - [Translating passes: localisation](https://docs.passentry.com/documentation/passes/localisation/guide.md): Localise Apple Wallet and Google Wallet passes so labels and values automatically appear in the user's device language, and configure it with PassEntry. - [Welcome to PassEntry API](https://docs.passentry.com/api-reference/v1/introduction/welcome.md): PassEntry API is an OpenAPI 3.1.0 compliant REST API with predictable URLs, JSON request bodies, standard HTTP response codes, authentication, and verbs. This documentation describes the functionality of our system available for integration with your business. - [Authentication](https://docs.passentry.com/api-reference/v1/introduction/authentication.md) - [Rate Limiting](https://docs.passentry.com/api-reference/v1/introduction/rate-limiting.md) - [Responses](https://docs.passentry.com/api-reference/v1/introduction/responses.md) - [Errors](https://docs.passentry.com/api-reference/v1/introduction/errors.md) - [Deprecation](https://docs.passentry.com/api-reference/v1/introduction/deprecation.md) - [Entities](https://docs.passentry.com/api-reference/v1/entities/guide.md) - [List Entities](https://docs.passentry.com/api-reference/v1/entities/list-entities.md): Lists all entities - [Show Entity](https://docs.passentry.com/api-reference/v1/entities/show-entity.md): Retrieve an entity by ID - [Pass templates guide: create, update, and manage designs](https://docs.passentry.com/api-reference/v1/pass-templates/guide.md): Learn how to create, update, and manage PassEntry pass templates from the Dashboard or API, including fields, colours, images, and value keys. - [Show Pass Template (Deprecated)](https://docs.passentry.com/api-reference/v1/pass-templates/deprecated-show-pass-template.md): Retrieve a Pass Template by ID (This endpoint is deprecated) - [Create Pass Template](https://docs.passentry.com/api-reference/v1/pass-templates/create-pass-template.md): Pass Templates are created asynchronously and the response will return a 202 status code. Use the URL returned in the response to check the status of the pass template. - [Update Pass Template](https://docs.passentry.com/api-reference/v1/pass-templates/update-pass-template.md): Supports partial updates.
Response may either be a 200 or 202 status code. Use the URL returned in the response to check the status of the pass template. - [List Pass Templates](https://docs.passentry.com/api-reference/v1/pass-templates/list-pass-templates.md): List Pass Templates - [Show Pass Template](https://docs.passentry.com/api-reference/v1/pass-templates/show-pass-template.md): Show a Pass Template - [Create pass](https://docs.passentry.com/api-reference/v1/passes/create-pass.md) - [Show Pass](https://docs.passentry.com/api-reference/v1/passes/show-pass.md) - [Update pass](https://docs.passentry.com/api-reference/v1/passes/update-pass.md) - [List passes](https://docs.passentry.com/api-reference/v1/passes/list-passes.md) - [Send Notification](https://docs.passentry.com/api-reference/v1/passes/send-notification.md) - [Nullify Pass](https://docs.passentry.com/api-reference/v1/passes/nullify-pass.md): Irreversibly nullifies a pass, removing all dynamic data (fields, images, barcode, NFC, localisation) while preserving the tombstone record for billing and auditability. - [Readers](https://docs.passentry.com/api-reference/v1/readers/guide.md) - [Create reader](https://docs.passentry.com/api-reference/v1/readers/create-reader.md) - [Get reader](https://docs.passentry.com/api-reference/v1/readers/get-reader.md) - [Update reader](https://docs.passentry.com/api-reference/v1/readers/update-reader.md) - [Get reader configuration](https://docs.passentry.com/api-reference/v1/readers/get-reader-configuration.md) - [Reader login](https://docs.passentry.com/api-reference/v1/readers/reader-login.md): Sign in as a PassEntry Reader using its Reader ID and password, exactly as the PassEntry Reader app does. Returns a session token, a refresh token and the reader's NFC configuration. A reader holds one session at a time: logging in again invalidates the previous session's tokens. Keep the session al… - [Reader heartbeat](https://docs.passentry.com/api-reference/v1/readers/reader-heartbeat.md): Keep a reader session alive and mark the reader as online in the Dashboard. Call it every 5 minutes with the current session token. Each successful heartbeat returns a new token and refresh token and invalidates the previous ones, so switch to the returned token immediately. - [Refresh reader token](https://docs.passentry.com/api-reference/v1/readers/refresh-reader-token.md): Exchange a refresh token for a new session token and refresh token without the reader password. Use it when an API call returns 401 because the session token expired. The previous tokens are invalidated. - [Reader logout](https://docs.passentry.com/api-reference/v1/readers/reader-logout.md): End the reader session. The session token and refresh token are invalidated and the reader is marked as logged out in the Dashboard. - [Scans](https://docs.passentry.com/api-reference/v1/scans/guide.md): Overview of the Scans API and the two validation methods available. - [Create scan](https://docs.passentry.com/api-reference/v1/scans/create-scan.md) - [Log scan](https://docs.passentry.com/api-reference/v1/scans/log-scan.md) - [Get scan](https://docs.passentry.com/api-reference/v1/scans/get-scan.md) - [List scans](https://docs.passentry.com/api-reference/v1/scans/get-scans.md) - [Image Assets](https://docs.passentry.com/api-reference/v1/image-assets/guide.md): Upload images once and reference them by ID across multiple passes - [Create Image Asset](https://docs.passentry.com/api-reference/v1/image-assets/create-image-asset.md): Create a new image asset - [List Image Assets](https://docs.passentry.com/api-reference/v1/image-assets/list-image-assets.md): List all image assets - [Show Image Asset](https://docs.passentry.com/api-reference/v1/image-assets/show-image-asset.md): Show an image asset by ID - [Loyalty](https://docs.passentry.com/api-reference/v1/loyalty/guide.md) - [Show loyalty balance](https://docs.passentry.com/api-reference/v1/loyalty/show-loyalty-balance.md) - [Update loyalty balance](https://docs.passentry.com/api-reference/v1/loyalty/update-loyalty-balance.md) - [Webhook Subscriptions](https://docs.passentry.com/api-reference/v1/webhook-subscriptions/guide.md) - [Create Webhook Subscription](https://docs.passentry.com/api-reference/v1/webhook-subscriptions/create-webhook-subscription.md): Create a new webhook subscription to notify your specified target URL about events happening within PassEntry. - [Update Webhook Subscription](https://docs.passentry.com/api-reference/v1/webhook-subscriptions/update-webhook-subscription.md): Update an existing webhook subscription configuration. - [List Webhook Subscriptions](https://docs.passentry.com/api-reference/v1/webhook-subscriptions/list-webhook-subscriptions.md): Get a list of all webhook subscriptions with pagination and filtering options - [Show Webhook Subscription](https://docs.passentry.com/api-reference/v1/webhook-subscriptions/show-webhook-subscription.md): Get details of a specific webhook subscription based on ID. - [Delete Webhook Subscription](https://docs.passentry.com/api-reference/v1/webhook-subscriptions/delete-webhook-subscription.md): Delete an existing webhook subscription. - [Test Webhook Subscription](https://docs.passentry.com/api-reference/v1/webhook-subscriptions/test-webhook-subscription.md): Send a test webhook to verify endpoint configuration and webhook handling. - [Rotate Secret Key](https://docs.passentry.com/api-reference/v1/webhook-subscriptions/rotate-secret-key.md): Generate a new secret key for webhook signature verification. The old key becomes invalid immediately. - [Receiving webhooks from PassEntry](https://docs.passentry.com/api-reference/v1/webhooks/guide.md): Set up an HTTPS endpoint to receive PassEntry webhook events, verify the X-Webhook-Signature HMAC-SHA256 header, and handle retries. - [Pass Created](https://docs.passentry.com/api-reference/v1/webhooks/pass-created.md): Webhook triggered when a pass is created - [Pass Installed](https://docs.passentry.com/api-reference/v1/webhooks/pass-installed.md): Webhook triggered when a pass is added to the wallet by user - [Pass Removed](https://docs.passentry.com/api-reference/v1/webhooks/pass-removed.md): Webhook triggered when a pass is removed from the wallet by user - [Pass Tapped (Deprecated)](https://docs.passentry.com/api-reference/v1/webhooks/pass-tapped.md): Webhook triggered when an NFC pass is tapped on a reader (This webhook is deprecated, please use the passScanned webhook instead) - [Pass Scanned](https://docs.passentry.com/api-reference/v1/webhooks/pass-scanned.md): Webhook triggered when an NFC or barcode pass is scanned by a reader - [Batches](https://docs.passentry.com/api-reference/v1/batches/guide.md) - [Show Batch](https://docs.passentry.com/api-reference/v1/batches/show-batch.md): Retrieve a Batch by ID - [List Batches](https://docs.passentry.com/api-reference/v1/batches/list-batches.md): Retrieve a list of Batches - [Cancel Batch](https://docs.passentry.com/api-reference/v1/batches/cancel-batch.md): Cancel a Batch. Can only be used on scheduled batches. - [Send Batch Now](https://docs.passentry.com/api-reference/v1/batches/send-now-batch.md): Override a scheduled wallet messaging batch's `scheduledAt` time and start sending immediately. Only valid for batches currently in `scheduled` status. - [Create Wallet Messaging Batch](https://docs.passentry.com/api-reference/v1/batches/create-wallet-messaging-batch.md): Create a new wallet messaging batch using segments, recipients, or a CSV file (via multipart/form-data). - [Create Passes Batch](https://docs.passentry.com/api-reference/v1/batches/create-passes-batch.md): Create passes in bulk via a CSV file. - [Update Passes Batch](https://docs.passentry.com/api-reference/v1/batches/update-passes-batch.md): Update passes in bulk via a CSV file. - [PassEntry FAQs: API keys, NFC, templates, and limits](https://docs.passentry.com/faq/guide.md): Answers to common PassEntry questions on API keys, NFC approval, team roles, app linking, field line breaks, trial passes, and resource limits. - [Product updates](https://docs.passentry.com/changelog/updates.md): Follow release notes for the PassEntry Dashboard, API, and SDKs, including SSO improvements, new endpoints, and pass template features. - [We value your feedback](https://docs.passentry.com/feedback/guide.md) ## OpenAPI Specs - [openapi](/api-reference/v1/openapi.json) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.