Skip to main content
POST
Validate a wristband's access to a zone

Authorizations

Authorization
string
header
required

Integrator API key, issued from the VENTRY dashboard. Format vk_live_... in production and vk_test_... in test environments.

Body

application/json
wristband_code
string
required

NFC identifier read from the wristband.

zone
string
required

Zone id from GET /zones.

direction
enum<string>

Whether the check counts occupancy: entry adds to the zone and exit subtracts. Without it, access is only checked and occupancy does not change.

Available options:
entry,
exit

Response

Result of the access check.

Result of the access check.

object
enum<string>
Available options:
access_check
allowed
boolean
reason
string
attendee_name
null | string
ticket_type
null | string
wristband_status
null | string
direction
null | enum<string>

The requested direction, or null if access was only checked.

Available options:
entry,
exit,
null
counted
boolean

Whether occupancy changed. Re-entering without having left, or leaving without having been recorded inside, is logged but not counted.

occupancy
null | object

Zone occupancy after the pass. max 0 means no limit.