Generate Apple Wallet Pass (PKPASS)

This endpoint delivers an Apple Wallet Pass (PKPASS) file. The response format depends on the Accept header:

  • application/vnd.apple.pkpass: Delivers the PKPASS file directly as a binary download.
  • application/json: Provides a JSON object with a download URL for the PKPASS file.

Integrating the Pass into Apple Wallet:

In your app or App Clip, add a PKAddPassButton to show that a pass is available. When the user taps the button, show a PKAddPassesViewController for the pass.

For comprehensive guidance, refer to Apple's documentation on Distributing and Updating a Pass.

Path Params
uuid
required
string
required
Headers
string
enum
Defaults to application/json
Allowed:
Responses

404

Not Found

Language
Credentials
Bearer
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/vnd.apple.pkpass
application/vnd.apple.pkpasses