Skip to main content
This feature is in open beta and available via custom plan subscription to get access - let us know if you encounter any issues or have feedback.
Pass binding ties a digital pass to a specific wallet account, ensuring that only the intended recipient can use it. This is useful for preventing pass sharing, securing NFC-based access, and ensuring passes are only transactable by the verified holder.

​
How it works

Binding works differently on each platform, but the setup is the same - you provide a binding object when creating a pass via the API.
Google Wallet uses email-based restrictions. When a pass with binding is downloaded on an Android device, PassEntry generates a SHA-256 hash of the provided email and stores it in the pass. Only the Google account matching that email can save the pass. Any other user who tries to save the pass will see an error message.Google Wallet pass restricted error

​
Prerequisites

Before using account binding, ensure the following:
  • Your organisation has the pass binding feature enabled. Contact PassEntry if you need access.
  • You have a learnMoreUrl ready - this is a page on your website where pass holders can get help if their pass enters an invalid state (e.g., a support or FAQ page).
  • Your passes do not rely on barcodes. Barcodes are prohibited on passes with binding enabled. If your use case requires visual identification, consider using NFC instead.
Barcodes are prohibited on all passes (both Apple and Google) when binding is enabled. This is enforced at pass creation time and also during pass updates - the API will reject requests that include both a barcode and binding.

​
Creating a pass with binding

Add the binding object to your pass creation request. Binding can only be set at creation time and cannot be added, changed, or removed later.
Create pass with binding
POST /api/v1/passes?passTemplate=YOUR_TEMPLATE_UUID

{
  "pass": {
    "fullName": {
      "value": "Jane Smith"
    },
    "nfc": {
      "enabled": true
    }
  },
  "binding": {
    "email": "[email protected]",
    "learnMoreUrl": "https://support.example.com/pass-help"
  }
}
ParameterRequiredDescription
binding.emailYesEmail address of the pass holder. For Google Wallet, this must match the user’s Google account.
binding.learnMoreUrlYesHTTPS URL to a page on your website where the pass holder can get help resolving issues. Must be 255 characters or less.
The response will include the binding status:
Response (after creation, before download)
{
  "data": {
    "id": "33b680b7a5460e6cd4646dfd2c1a8c33a6fbfa5c",
    "type": "pass",
    "attributes": {
      "downloadUrl": "https://download.passentry.com?pass=33b680b7...",
      "status": "issued",
      "binding": {
        "platform": null,
        "bound": false,
        "bindingEmail": "u***@gmail.com",
        "learnMoreUrl": "https://support.example.com/pass-help"
      }
    }
  }
}
At this stage, the pass has a binding marker but is not yet bound to a platform. The platform and bound fields are set when the pass is downloaded.

​
Binding lifecycle

A pass with binding goes through the following states:
StateplatformboundDescription
CreatednullfalsePass created with binding, not yet downloaded
Google bound"google"truePass downloaded on Android, restricted to the specified Google account
Apple pending"apple"falseApple binding initiated, waiting for device authentication
Apple bound"apple"trueDevice authenticated via Face ID/Touch ID, binding complete

​
Platform lock

Once a pass is downloaded and bound to a platform, it cannot be downloaded on the other platform. For example, if a pass is bound to Apple Wallet, attempting to download it on an Android device will return an error. This also applies to the PassEntry download page - the page will detect the platform mismatch and display an appropriate message to the user.

​
What the user sees

When a user with the correct Google account opens the download link, the pass is saved to their wallet normally. If a different user tries to save the same pass, they will see an error:Google Wallet pass restricted error

​
Important limitations

Binding cannot be updated or removed after the pass is created. To change binding details, you must create a new pass. Plan your binding configuration carefully before issuing passes.
  • No barcodes: Barcodes are prohibited on all passes with binding enabled. The API will reject creation requests that include both binding and a barcode.
  • No retroactive binding: You cannot add binding to an existing pass via the update endpoint. Binding must be set at pass creation time.
  • Platform lock: Once bound to Apple or Google, the pass cannot be downloaded on the other platform.
  • Apple device requirements: Apple binding requires iOS 16.4+ or watchOS 9.4+ with Face ID, Touch ID, or a passcode configured.
  • Email handling: For Google-bound passes, the email is stored encrypted and masked in API responses. For Apple-bound passes, the email is purged after the binding is initiated (it is not needed for FIDO authentication).

​
Checking binding status

Binding data is automatically included in single pass responses (create, show, update). For the list endpoint, add ?includeBinding=true to include binding data. 
GET /api/v1/passes/PASS_UUID
Google-bound pass response
{
  "binding": {
    "platform": "google",
    "bound": true,
    "bindingEmail": "u***@gmail.com",
    "learnMoreUrl": "https://support.example.com/pass-help"
  }
}
Apple-bound pass response
{
  "binding": {
    "platform": "apple",
    "bound": true,
    "bindingEmail": null,
    "learnMoreUrl": "https://support.example.com/pass-help"
  }
}
Note that bindingEmail is null for Apple-bound passes because the email is purged after binding initiation.

​
Troubleshooting

IssueCauseSolution
400 when creating pass with binding and barcodeBarcodes are prohibited with bindingRemove the barcode from the request
Google user sees “pass is intended for another account”Email doesn’t match the user’s Google accountEnsure the binding.email matches the intended recipient’s Google account
Apple pass shows “Pass Disabled”User signed out of iCloud or moved pass to a device with a different Apple IDDirect user to sign back into their iCloud account. The learnMoreUrl is shown on the pass for support.
Pass cannot be downloaded on the other platformPlatform lock is activeThis is expected. Create a new pass if the user needs it on a different platform.
422 when trying to add binding via updateBinding can only be set at creationCreate a new pass with the binding object