# PassEntry ## Docs - [Cancel Batch](https://docs.passentry.com/api-reference/v1/batches/cancel-batch.md): Cancel a Batch. Can only be used on scheduled batches. - [Create Passes Batch](https://docs.passentry.com/api-reference/v1/batches/create-passes-batch.md): Create passes in bulk via a CSV file. - [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). - [Batches](https://docs.passentry.com/api-reference/v1/batches/guide.md) - [List Batches](https://docs.passentry.com/api-reference/v1/batches/list-batches.md): Retrieve a list of Batches - [Show Batch](https://docs.passentry.com/api-reference/v1/batches/show-batch.md): Retrieve a Batch by ID - [Update Passes Batch](https://docs.passentry.com/api-reference/v1/batches/update-passes-batch.md): Update passes in bulk via a CSV file. - [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 - [Create Image Asset](https://docs.passentry.com/api-reference/v1/image-assets/create-image-asset.md): Create a new image asset - [Image Assets](https://docs.passentry.com/api-reference/v1/image-assets/guide.md): Upload images once and reference them by ID across multiple passes - [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 - [Authentication](https://docs.passentry.com/api-reference/v1/introduction/authentication.md) - [Deprecation](https://docs.passentry.com/api-reference/v1/introduction/deprecation.md) - [Errors](https://docs.passentry.com/api-reference/v1/introduction/errors.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) - [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. - [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) - [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. - [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) - [Pass Templates](https://docs.passentry.com/api-reference/v1/pass-templates/guide.md) - [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 - [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. - [Create pass](https://docs.passentry.com/api-reference/v1/passes/create-pass.md) - [List passes](https://docs.passentry.com/api-reference/v1/passes/list-passes.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. - [Send Notification](https://docs.passentry.com/api-reference/v1/passes/send-notification.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) - [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) - [Get reader configuration](https://docs.passentry.com/api-reference/v1/readers/get-reader-configuration.md) - [Readers](https://docs.passentry.com/api-reference/v1/readers/guide.md) - [Update reader](https://docs.passentry.com/api-reference/v1/readers/update-reader.md) - [Create scan](https://docs.passentry.com/api-reference/v1/scans/create-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) - [Scans](https://docs.passentry.com/api-reference/v1/scans/guide.md): Overview of the Scans API and the two validation methods available. - [Log scan](https://docs.passentry.com/api-reference/v1/scans/log-scan.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. - [Delete Webhook Subscription](https://docs.passentry.com/api-reference/v1/webhook-subscriptions/delete-webhook-subscription.md): Delete an existing webhook subscription. - [Webhook Subscriptions](https://docs.passentry.com/api-reference/v1/webhook-subscriptions/guide.md) - [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 - [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. - [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. - [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. - [Update Webhook Subscription](https://docs.passentry.com/api-reference/v1/webhook-subscriptions/update-webhook-subscription.md): Update an existing webhook subscription configuration. - [Webhooks](https://docs.passentry.com/api-reference/v1/webhooks/guide.md) - [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 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 - [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) - [Changelog](https://docs.passentry.com/changelog/2025/updates.md) - [Adding an Apple Pass Certificate](https://docs.passentry.com/documentation/adding-an-apple-pass-certificate.md): Learn how to set up and manage an Apple Pass Type Identifier certificate to issue and update Apple Wallet passes with PassEntry, including whether you need your own certificate, Apple Developer Program requirements and renewal. - [Batch Wallet Notifications and Logging](https://docs.passentry.com/documentation/bulk-operations/batch-notifications/guide.md): Learn how to send wallet notifications in bulk by grouping recipients into batches, using pass IDs, segments or CSV uploads and how to track delivery status and errors for large-scale messaging. - [Batch Pass Creation](https://docs.passentry.com/documentation/bulk-operations/batch-pass-creation/guide.md): Learn how to create large numbers of passes in bulk using CSV uploads in the PassEntry Dashboard, including template mapping, dynamic fields and how to review results and fix errors. - [Batch Pass Update](https://docs.passentry.com/documentation/bulk-operations/batch-pass-update/guide.md): Learn how to update existing passes in bulk using CSV uploads in the PassEntry Dashboard, including partial updates, template field mapping and how to track progress and resolve errors. - [Custom Pass Issuance Forms](https://docs.passentry.com/documentation/guides/custom-download-forms/guide.md): Learn how to design custom, customer-facing pass issuance forms that collect user input and automatically generate passes that can be added to Apple Wallet or Google Wallet, without requiring API integration. - [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. - [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. - [Integrating with PassEntry via Zapier](https://docs.passentry.com/documentation/guides/zapier/guide.md): Learn how to use the **PassEntry Zapier app** to connect your CRM, e-commerce or marketing tools and automate pass issuance, updates, loyalty actions and real-time wallet events without writing code. - [Pass Template Types Explained](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. - [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. - [Downloading Passes](https://docs.passentry.com/documentation/passes/downloading-passes/guide.md): Learn how to deliver digital passes using PassEntry’s hosted download page or by directly delivering Apple Wallet and Google Wallet passes in device-aware flows. - [Geofencing](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. - [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. - [Translating Passes: Localisation](https://docs.passentry.com/documentation/passes/localisation/guide.md): Learn how to localise digital passes so labels and values automatically appear in the user’s device language on Apple Wallet and Google Wallet, and how to configure localisation with PassEntry. - [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 Nullification](https://docs.passentry.com/documentation/passes/nullification/guide.md): Learn how to permanently remove passholder data from a pass while keeping a tombstone record for billing and compliance, and how to reuse External IDs after nullification. - [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. - [FAQs](https://docs.passentry.com/faq/guide.md): Frequently Asked Questions - [We value your feedback](https://docs.passentry.com/feedback/guide.md) - [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. ## OpenAPI Specs - [openapi](https://docs.passentry.com/api-reference/v1/openapi.json)