Documentation

API Reference

FAQs

Feedback

API Key

PassEntry

Dashboard

Update reader

Whether the reader is enabled for adding points. Only present for PassentryReader type.

Whether the reader is enabled for Mifare Classic NFC scanning. Only present for PassentryReader type.

Reader password. Required for PassentryReader type

Whether the reader is enabled for QR code scanning. Only present for PassentryReader type.

Whether the reader is enabled for redeeming. Only present for PassentryReader type.

Whether the reader is enabled for scanning. Only present for PassentryReader type.

Type of reader: VtapReader or PassentryReader

api key

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.

Welcome to Passentry

We value your feedback

Batch Pass Creation

Batch Notifications & Logging

Batch Wallet Notifications and Logging

PassEntry Reader App

PassEntry Reader App Configuration Guide

Learn how to enable and configure third-party validation for PassEntry readers.

Third-Party Validation

Using Third-Party Validation with PassEntry

Downloading Passes

This document outlines the implementation of geofencing and iBeacon technology to enhance customer engagement through targeted notifications based on location proximity.

Geofencing

Notifications

Design Guide

Responses

Errors

Entities

List Entities

Show Entity

Pass Templates

Retrieve a Pass Template by ID (This endpoint is deprecated)

Show Pass Template (Deprecated)

Create pass

Show Pass

Update pass

Send Notification

Readers

Create reader

Get reader

Get reader configuration

Overview of the Scans API and the two validation methods available.

Scans

Create scan

Log scan

Loyalty

Show loyalty balance

Update loyalty balance

Webhooks

Webhook triggered when a pass is added to the wallet by user

Pass Installed

Webhook triggered when a pass is removed from the wallet by user

Pass Removed

Webhook triggered when an NFC pass is tapped on a reader

Pass Tapped (Deprecated)

Webhook triggered when an NFC or barcode pass is scanned by a reader

Introduction

Entities

Pass Templates

Passes

Readers

Scans

Loyalty

Webhooks

Update reader

Authorizations

Path Parameters

Body

Response