Skip to main content
POST
/
api
/
v1
/
passes
curl --request POST \
  --url https://api.passentry.com/api/v1/passes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pass": {
    "nfc": {
      "enabled": true
    },
    "fullName": {
      "value": "Jane Smith"
    },
    "website": "https://passentry.com",
    "barcode": {
      "enabled": true,
      "type": "qr",
      "source": "custom",
      "value": "123abcd",
      "displayText": true
    }
  },
  "locations": [
    {
      "name": "Venue",
      "latitude": 51.54321132456805,
      "longitude": -0.022901231803803924,
      "radius": 100,
      "message": "Welcome to the venue"
    }
  ]
}
'
{
  "data": {
    "id": "33b680b7a5460e6cd4646dfd2c1a8c33a6fbfa5c",
    "type": "pass",
    "attributes": {
      "downloadUrl": "https://www.example.com?pass=33b680b7a5460e6cd4646dfd2c1a8c33a6fbfa5c",
      "passType": "generic",
      "createdAt": "2022-06-05T10:06:53Z",
      "status": "issued",
      "extId": "123",
      "passTemplateUuid": "2e2d7ee8c306e8f0223dbdc1",
      "passTemplateName": "PassEntry Ticketing",
      "nfc": "33b680b7a5460e6cd4646dfd2c1a8c33a6fbfa5c",
      "barcode": {
        "enabled": true,
        "type": "qr",
        "source": "custom",
        "value": "123abcd",
        "displayText": true
      },
      "passContent": {
        "nfc": {
          "enabled": true
        },
        "fullName": {
          "value": "Jane Smith"
        },
        "website": "https://passentry.com",
        "barcode": {
          "enabled": true,
          "type": "qr",
          "source": "custom",
          "value": "123abcd",
          "displayText": true
        }
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.passentry.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
passTemplate
string
required

Identifies the pass template to use

​
extId
string

External ID used to identify the pass. Optional

​
includePassDesign
boolean

If true, includes the pass design in the response

​
includeLocations
boolean

If true, includes the locations in the response if any are present

​
includeBeacons
boolean

If true, includes the beacons in the response if any are present

​
includePassSource
enum<string>

Used when delivering the pass directly to the passholder, without using PassEntry's download page. Choose one of Apple/Google, includes the pass source in the response. The passSource object is only included if the pass is not currently 'active'

Available options:
apple,
google

Body

application/json
​
pass
object
​
passAction
enum<string>

Only available when updating the pass.

  • deactivate: Deactivates the pass, setting it to 'expired' in the wallet. When in this state, pass can receive updates but does not receive Apple notifications.
  • reactivate: Reactivates the pass, setting it to 'active' in the wallet. In the case of Apple passes, the pass will remain in the 'expired' passes section of the wallet, user will need to manually select 'unhide' to move passes to the main passes view.
Available options:
deactivate,
reactivate
​
locations
object[]

Array of locations. Maximum of 10 locations

​
beacons
object[]

Array of beacons, currently only available on Apple devices, due to Android device restrictions. Maximum of 10 beacons

​
groupTag
string

Tag used for grouping passes

Example:

"EASTER_OFFER_22"

​
groupTags
array

Tags used for grouping passes

Example:
["EASTER_OFFER_22", "SUMMER_SALE_22"]
​
binding
object

Account binding restricts the pass to a specific wallet account. This feature is in open beta. Only available on pass creation — binding cannot be added or modified via the update endpoint.

Important: To change binding details, a new pass must be created. Barcodes are prohibited on passes when binding is enabled — ensure your passes do not rely on barcodes before enabling binding.

Once a pass is bound to a platform (Apple or Google), it cannot be downloaded on the other platform.

Google Wallet: The pass is restricted to the specified email account using a SHA-256 hash.

Apple Wallet: The pass uses FIDO hardware key binding tied to the user's iCloud account, requiring Face ID or Touch ID authentication. While pass can be downloaded on a different device, binding only affects NFC. If NFC pass is created and pass is downloaded on a different device, the NFC will be disabled on the pass.

See the Pass Binding guide for full details.

Response

Successful

​
data
object