Entry V1 API (1.0.0)

Download OpenAPI specification:Download

Entry V1 API Documentation for device communication and scanning operations

User Flow

This section describes the complete flow for the Entry V1 scanner system.

Flow Diagram

Entry Scanner Flow

Auth

Authentication

Most API calls require an Authorization: Bearer <bearer token> header, which is obtained by calling the session creation endpoint.
The session creation endpoint itself is secured using a manually issued API-Authorization-Key, provided to integrators during onboarding.

Create Session

Initializes a new device session and returns a bearer token (JWT) used for authentication on all subsequent API calls. This also registers device context including serial number, venue, and model details.

header Parameters

PAC-Request-Id required	string The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.
API-Authorization-Key required	string The api-authorization-key to identify the client.
Content-Type required	string Default: application/json The only supported request type for this endpoint is application/json.

Request Body schema: application/json

venueCode required	string Venue code from venue profile
dataAccountId required	string 3-digit client identifier
serialNumber required	string Device serial number
make required	string Device maker
model required	string Device model
firmwareVersion	string Firmware version of the device
softwareVersion	string Software version of the device
macAddress	string MAC address of the device
networkType	string or null Enum: "Wifi" "Mobile" "Wired" Device connected to internet.
wifiSSID	string or null If connected through Wifi, what is the ssid.
wifiBSSID	string or null If connected through Wifi, what is the bssid.
wifiChannel	integer or null If connected through Wifi, what is the channel.
mobileProvider	string or null If connected through Mobile, what is the provider.
networkSignal	string or null Networking signal level on the reader device at the time of scan. Wifi: dBm (decibel-milliwatts) Mobile: Signal quality value (0 = No Signal/Unknown, 1 = Poor, 2 = Moderate, 3 = Good, 4 = Great) Wired: Always 999
localIPAddress	string or null Local IP address of the device.
softwareMode	string or null Enum: "Handheld" "Pedestal" Software mode of the device.
accessorySerialNumber	string or null Serial number of the accessory.
accessoryFirmware	string or null Firmware version of the accessory.
accessoryModel	string or null Model of the accessory.
accessoryMake	string or null Maker of the accessory.
deviceTimestamp	string <date> Device date time in ISO format.

Responses

Request samples

Payload
curl

Content type

application/json

{"venueCode": "TS",
"dataAccountId": "390",
"serialNumber": "123456789",
"make": "Janam",
"model": "Model X",
"firmwareVersion": "1.0.0",
"softwareVersion": "android 2.0.0",
"macAddress": "00:11:22:33:44:55",
"networkType": "Wifi",
"wifiSSID": "string",
"wifiBSSID": "string",
"wifiChannel": 0,
"mobileProvider": "string",
"networkSignal": "string",
"localIPAddress": "string",
"softwareMode": "Handheld",
"accessorySerialNumber": "string",
"accessoryFirmware": "string",
"accessoryModel": "string",
"accessoryMake": "string",
"deviceTimestamp": "2019-08-24"
}

Response samples

Content type

application/json

{"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"deviceId": 67904,
"deviceName": "test",
"deviceNumber": 1,
"venueName": "",
"venueCode": "BH",
"checkpointLayoutId": 12843,
"checkpointLayoutName": "Main Layout",
"checkpointLayoutCode": "CL.1",
"specialAreaId": 0,
"specialAreaName": "string",
"checkpointId": 26452,
"checkpointName": "Gate A",
"partnerId": "string",
"deviceType": "handheld",
"dataAccountId": "111",
"accessorySerialNumber": "string",
"accessoryNumber": 0,
"serialNumber": "string",
"iat": 1746740378,
"exp": 1746826778
}

Device Communication Service

Endpoints for device management and communication
Includes event retrieval, venue information, and device status updates

Get Events

Retrieves a list of today's events available for scanning, along with critical configuration data such as barcode masks and NFC encryption keys used for offline validation.

header Parameters

PAC-Request-Id required	string The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.
Authorization required	string Example: Bearer dGVzdDp0ZXN0 Authorization with Bearer Auth
Content-Type required	string Default: application/json The only supported request type for this endpoint is application/json.

Request Body schema: application/json

networkType	string or null Enum: "Wifi" "Mobile" "Wired" Device connected to internet.
wifiSSID	string or null If connected through Wifi, what is the ssid.
wifiBSSID	string or null If connected through Wifi, what is the bssid.
wifiChannel	integer or null If connected through Wifi, what is the channel.
mobileProvider	string or null If connected through Mobile, what is the provider.
networkSignal	string or null Networking signal level on the reader device at the time of scan. Wifi: dBm (decibel-milliwatts) Mobile: Signal quality value (0 = No Signal/Unknown, 1 = Poor, 2 = Moderate, 3 = Good, 4 = Great) Wired: Always 999
localIPAddress	string or null Local IP address of the device.
softwareMode	string or null Enum: "Handheld" "Pedestal" Software mode of the device.
accessorySerialNumber	string or null Serial number of the accessory.
accessoryFirmware	string or null Firmware version of the accessory.
accessoryModel	string or null Model of the accessory.
accessoryMake	string or null Maker of the accessory.
deviceTimestamp	string <date> Device date time in ISO format.

Responses

Request samples

Payload
curl

Content type

application/json

{"networkType": "Wifi",
"wifiSSID": "string",
"wifiBSSID": "string",
"wifiChannel": 0,
"mobileProvider": "string",
"networkSignal": "string",
"localIPAddress": "string",
"softwareMode": "Handheld",
"accessorySerialNumber": "string",
"accessoryFirmware": "string",
"accessoryModel": "string",
"accessoryMake": "string",
"deviceTimestamp": "2019-08-24"
}

Response samples

Content type

application/json

{"nfcKeys": {"apple": [{"ID": "string",
"private_key": "string",
"passTypeId": "string"
}
],
"google": [{"ID": "string",
"private_key": "string",
"collectorId": "string",
"version": "string"
}
]
},
"events": [{"eventName": "Event to test deploy",
"eventId": "390:DEPLOY:TEST",
"startDateTime": "2025-01-01T10:00:00",
"endDateTime": "2025-01-02T10:00:00",
"scanStartDateTime": "2025-05-01T10:00:00",
"scanEndDateTime": "2025-07-01T10:00:00",
"barcodeMasks": ["mask1",
"mask2"
]
}
]
}

Get Venues

Retrieves all venues configured for a given dataAccountId. Devices can use this to fetch newly-configured venues not present in the venue profile.

header Parameters

PAC-Request-Id required	string The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.
API-Authorization-Key required	string The api-authorization-key to identify the client.
Content-Type required	string Default: application/json The only supported request type for this endpoint is application/json.

Request Body schema: application/json

dataAccountId required	string 3-digit client identifier
serialNumber required	string Device serial number
make required	string Device maker
model required	string Device model
networkType	string or null Enum: "Wifi" "Mobile" "Wired" Device connected to internet.
wifiSSID	string or null If connected through Wifi, what is the ssid.
wifiBSSID	string or null If connected through Wifi, what is the bssid.
wifiChannel	integer or null If connected through Wifi, what is the channel.
mobileProvider	string or null If connected through Mobile, what is the provider.
networkSignal	string or null Networking signal level on the reader device at the time of scan. Wifi: dBm (decibel-milliwatts) Mobile: Signal quality value (0 = No Signal/Unknown, 1 = Poor, 2 = Moderate, 3 = Good, 4 = Great) Wired: Always 999
localIPAddress	string or null Local IP address of the device.
softwareMode	string or null Enum: "Handheld" "Pedestal" Software mode of the device.
accessorySerialNumber	string or null Serial number of the accessory.
accessoryFirmware	string or null Firmware version of the accessory.
accessoryModel	string or null Model of the accessory.
accessoryMake	string or null Maker of the accessory.
deviceTimestamp	string <date> Device date time in ISO format.

Responses

Request samples

Payload
curl

Content type

application/json

{"dataAccountId": "129",
"serialNumber": "0000000999",
"make": "Janam",
"model": "XT3",
"networkType": "Wifi",
"wifiSSID": "string",
"wifiBSSID": "string",
"wifiChannel": 0,
"mobileProvider": "string",
"networkSignal": "string",
"localIPAddress": "string",
"softwareMode": "Handheld",
"accessorySerialNumber": "string",
"accessoryFirmware": "string",
"accessoryModel": "string",
"accessoryMake": "string",
"deviceTimestamp": "2019-08-24"
}

Response samples

Content type

application/json

{"venues": [{"facilityCode": "AAF",
"title": "AAF FACILITY",
"venueTimezone": "America/Los_Angeles"
}
]
}

Ping

Verifies connectivity between the device and the Entry API. Often used by the device to test network reachability, API availability, and basic request/response formatting.

header Parameters

PAC-Request-Id required	string The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.
Authorization required	string Example: Bearer dGVzdDp0ZXN0 Authorization with Bearer Auth
Content-Type required	string Default: application/json The only supported request type for this endpoint is application/json.

Request Body schema: application/json

geoLocation	string GPS location data from device OS
batteryPercentage	number Battery percentage from 0 to 100
accessoryBatteryPercentage	number Accessory battery percentage from 0 to 100
testMode	boolean Default: false If true, the scan will be processed in test mode
networkType	string or null Enum: "Wifi" "Mobile" "Wired" Device connected to internet.
wifiSSID	string or null If connected through Wifi, what is the ssid.
wifiBSSID	string or null If connected through Wifi, what is the bssid.
wifiChannel	integer or null If connected through Wifi, what is the channel.
mobileProvider	string or null If connected through Mobile, what is the provider.
networkSignal	string or null Networking signal level on the reader device at the time of scan. Wifi: dBm (decibel-milliwatts) Mobile: Signal quality value (0 = No Signal/Unknown, 1 = Poor, 2 = Moderate, 3 = Good, 4 = Great) Wired: Always 999
localIPAddress	string or null Local IP address of the device.
softwareMode	string or null Enum: "Handheld" "Pedestal" Software mode of the device.
accessorySerialNumber	string or null Serial number of the accessory.
accessoryFirmware	string or null Firmware version of the accessory.
accessoryModel	string or null Model of the accessory.
accessoryMake	string or null Maker of the accessory.
deviceTimestamp	string <date> Device date time in ISO format.

Responses

Request samples

Payload
curl

Content type

application/json

{"geoLocation": "37.7749,-122.4194",
"batteryPercentage": "85",
"accessoryBatteryPercentage": "35",
"testMode": false,
"networkType": "Wifi",
"wifiSSID": "string",
"wifiBSSID": "string",
"wifiChannel": 0,
"mobileProvider": "string",
"networkSignal": "string",
"localIPAddress": "string",
"softwareMode": "Handheld",
"accessorySerialNumber": "string",
"accessoryFirmware": "string",
"accessoryModel": "string",
"accessoryMake": "string",
"deviceTimestamp": "2019-08-24"
}

Response samples

Content type

application/json

{"error": {"message": ["string"
],
"error": "string",
"statusCode": 400
}
}

Scan Service

Endpoints for ticket validation and lookup
Handles barcode, NFC, and other ticket scanning operations

Validate Scan

Validates a ticket or token scanned at a checkpoint and returns admit/stop status, reason codes, and event/ticket context. This is the primary entry/exit validation endpoint used during live operations.

header Parameters

PAC-Request-Id required	string The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.
Authorization required	string Example: Bearer dGVzdDp0ZXN0 Authorization with Bearer Auth
Content-Type required	string Default: application/json The only supported request type for this endpoint is application/json.

Request Body schema: application/json

token required	string Barcode, access id, etc
inputType required	string Enum: "NFC" "Barcode" "Key" "Swipe" Method used to read the ticket/token
scanMode required	string Enum: "Entry" "Exit" Scanning operation mode
nfcType	string Enum: "Apple" "Google" If inputType is NFC, which wallet
barcodeType	string Enum: "Barcode" "QRCode" If inputType is barcode, which barcode symbology
testMode	boolean Default: false If true, the scan will be processed in test mode
networkType	string or null Enum: "Wifi" "Mobile" "Wired" Device connected to internet.
wifiSSID	string or null If connected through Wifi, what is the ssid.
wifiBSSID	string or null If connected through Wifi, what is the bssid.
wifiChannel	integer or null If connected through Wifi, what is the channel.
mobileProvider	string or null If connected through Mobile, what is the provider.
networkSignal	string or null Networking signal level on the reader device at the time of scan. Wifi: dBm (decibel-milliwatts) Mobile: Signal quality value (0 = No Signal/Unknown, 1 = Poor, 2 = Moderate, 3 = Good, 4 = Great) Wired: Always 999
localIPAddress	string or null Local IP address of the device.
softwareMode	string or null Enum: "Handheld" "Pedestal" Software mode of the device.
accessorySerialNumber	string or null Serial number of the accessory.
accessoryFirmware	string or null Firmware version of the accessory.
accessoryModel	string or null Model of the accessory.
accessoryMake	string or null Maker of the accessory.
deviceTimestamp	string <date> Device date time in ISO format.

Responses

Request samples

Payload
curl

Content type

application/json

{"token": "39000000000001",
"inputType": "Barcode",
"scanMode": "Entry",
"nfcType": "Apple",
"barcodeType": "Barcode",
"testMode": false,
"networkType": "Wifi",
"wifiSSID": "string",
"wifiBSSID": "string",
"wifiChannel": 0,
"mobileProvider": "string",
"networkSignal": "string",
"localIPAddress": "string",
"softwareMode": "Handheld",
"accessorySerialNumber": "string",
"accessoryFirmware": "string",
"accessoryModel": "string",
"accessoryMake": "string",
"deviceTimestamp": "2019-08-24"
}

Response samples

Content type

application/json

{"status": "Admit",
"reasonCode": "OK",
"reasonMessage": "Good Ticket",
"eventId": "390:DEPLOY:TEST",
"eventName": "Event to test deploy",
"token": "39000000000001",
"ticket": "TBD",
"patronId": "3773396",
"firstName": "John",
"lastName": "Doe",
"testMode": false,
"seatInfo": {"level": "UPPER",
"section": "05",
"row": "6",
"seat": "7",
"altSeatLocationText": "Alternate Seat Location"
}
}

Ticket Lookup

Performs a lookup of ticket details using a token or barcode, often used by support or admin tools. Returns full ticket info, seating details, and scan history for troubleshooting purposes.

path Parameters

barcode

required

string

The ticket token to look up

header Parameters

PAC-Request-Id required	string The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.
Authorization required	string Example: Bearer dGVzdDp0ZXN0 Authorization with Bearer Auth
Content-Type required	string Default: application/json The only supported request type for this endpoint is application/json.

Request Body schema: application/json

inputType required	string Enum: "NFC" "Barcode" "Key" "Swipe" Method used to read the ticket/token
nfcType	string Enum: "Apple" "Google" If inputType is NFC, which wallet
barcodeType	string Enum: "Barcode" "QRCode" If inputType is barcode, which barcode symbology
networkType	string or null Enum: "Wifi" "Mobile" "Wired" Device connected to internet.
wifiSSID	string or null If connected through Wifi, what is the ssid.
wifiBSSID	string or null If connected through Wifi, what is the bssid.
wifiChannel	integer or null If connected through Wifi, what is the channel.
mobileProvider	string or null If connected through Mobile, what is the provider.
networkSignal	string or null Networking signal level on the reader device at the time of scan. Wifi: dBm (decibel-milliwatts) Mobile: Signal quality value (0 = No Signal/Unknown, 1 = Poor, 2 = Moderate, 3 = Good, 4 = Great) Wired: Always 999
localIPAddress	string or null Local IP address of the device.
softwareMode	string or null Enum: "Handheld" "Pedestal" Software mode of the device.
accessorySerialNumber	string or null Serial number of the accessory.
accessoryFirmware	string or null Firmware version of the accessory.
accessoryModel	string or null Model of the accessory.
accessoryMake	string or null Maker of the accessory.
deviceTimestamp	string <date> Device date time in ISO format.

Responses

Request samples

Payload
curl

Content type

application/json

{"inputType": "Barcode",
"nfcType": "Apple",
"barcodeType": "Barcode",
"networkType": "Wifi",
"wifiSSID": "string",
"wifiBSSID": "string",
"wifiChannel": 0,
"mobileProvider": "string",
"networkSignal": "string",
"localIPAddress": "string",
"softwareMode": "Handheld",
"accessorySerialNumber": "string",
"accessoryFirmware": "string",
"accessoryModel": "string",
"accessoryMake": "string",
"deviceTimestamp": "2019-08-24"
}

Response samples

Content type

application/json

{"eventId": "390:DEPLOY:TEST",
"eventName": "Event to test deploy",
"token": "39000000000001",
"ticket": "39000000000001",
"patronId": "3773396",
"firstName": "John",
"lastName": "Doe",
"seatInfo": {"level": "UPPER",
"section": "05",
"row": "6",
"seat": "7",
"altSeatLocationText": "Alternate Seat Location"
},
"scanHistory": [{"deviceType": "handheld",
"serialNumber": "123456789",
"checkpointName": "Gate A",
"reasonMessage": "Scan is valid",
"barcodeType": "Barcode",
"scanMode": "Entry",
"testMode": false,
"deviceNumber": 6,
"deviceName": "Device for deploy validation",
"checkpointLayoutName": "Layout for deploy validation",
"venueName": "Titan Stadium",
"nfcType": "Apple",
"specialAreaName": "string",
"checkpointLayoutCode": "CL.1",
"scanTimestamp": "2025-05-19T10:00:00Z",
"venueCode": "TS",
"inputType": "Barcode",
"reasonCode": "OK",
"tokenType": "Barcode",
"status": "Admit",
"accessorySerialNumber": "123456789",
"accessoryMake": "123456789",
"accessoryModel": "Model X",
"accessoryFirmware": "1.0.0",
"deviceStatus": "Online",
"softwareMode": "Handheld"
}
]
}