HomeAPIGuides
Documentation
General
Introduction
API Keys
Core
Checkout
Coupons
Customers
Events
Invoices
Point of Sale
Products
Purchase Intents
Price Tables
Tickets
Ticket Transfers
Transactions
Subscriptions
Vouchers
Data Fields
Sales Channels
Webhooks
Fundraise
Funds
Campaigns
Donations
Pledges
Distribution
Distribution API
Seating
Maps
Events
Objects
Reservations
Payment
Gateways
Requests
Payment Methods
Pricing
Dynamic Pricing
JS
Seating.JS
Embed.JS
Apps
Installations
Access Control & Checkin
Scans
Access Control Devices
External Access Controls
Access Lists
Scan Groups
Memberships
Transactions
Auth
SSO

Scans

Scans are created by checkin or checkout via the vivenu app or by third party systems that checkin customers and are integrated with vivenu.

Base URL: https://portier.vivenu.com/api or https://portier.vivenu.dev/api

Endpoints

The scan object

Attributes

ticketId
Required
string
eventId
Required
string
barcode
Required
string
ticketTypeId
Required
string
type
Required
string
checkincheckout
scanResult
Required
string
approveddeclined

Optional Attributes

Collapse all
_id
Optional
string
time
Optional
string date-time
parentEventId
Optional
string
name
Optional
string
ticketName
Optional
string
deviceId
Optional
string
sellerId
Optional
string
scanZoneId
Optional
string
Was this section helpful?
YesNo
Example
{
  "_id": "string",
  "ticketId": "string",
  "time": "2030-01-23T23:00:00.123Z",
  "eventId": "string",
  "parentEventId": "string",
  "barcode": "string",
  "name": "string",
  "ticketTypeId": "string",
  "ticketName": "string",
  "deviceId": "string",
  "type": "checkin",
  "scanResult": "approved",
  "sellerId": "string",
  "scanZoneId": "string"
}

Create a Scan

Payload

ticketId
Required
string
eventId
Required
string
barcode
Required
string
ticketTypeId
Required
string
type
Required
string
checkincheckout
scanResult
Required
string
approveddeclined

Optional Attributes

Collapse all
_id
Optional
string
time
Optional
string date-time
parentEventId
Optional
string
name
Optional
string
ticketName
Optional
string
deviceId
Optional
string
sellerId
Optional
string
scanZoneId
Optional
string
Responses
200
Success
400
Bad Request
401
Unauthorized

Was this section helpful?

YesNo
post
/api/scans
[
  {
    "_id": "string",
    "ticketId": "string",
    "time": "2030-01-23T23:00:00.123Z",
    "eventId": "string",
    "parentEventId": "string",
    "barcode": "string",
    "name": "string",
    "ticketTypeId": "string",
    "ticketName": "string",
    "deviceId": "string",
    "type": "checkin",
    "scanResult": "approved",
    "sellerId": "string",
    "scanZoneId": "string"
  }
]
Response
application/json
{
  "_id": "string",
  "ticketId": "string",
  "time": "2030-01-23T23:00:00.123Z",
  "eventId": "string",
  "parentEventId": "string",
  "barcode": "string",
  "name": "string",
  "ticketTypeId": "string",
  "ticketName": "string",
  "deviceId": "string",
  "type": "checkin",
  "scanResult": "approved",
  "sellerId": "string",
  "scanZoneId": "string"
}

Get Scans

Query

eventId
Optional
string
parentEventId
Optional
string
time
Optional
object

Optional Attributes

Collapse all
barcode
Optional
string
type
Optional
string
checkincheckout
scanResult
Optional
string
approveddeclined
top
Optional
number float

A limit on the number of objects to be returned

skip
Optional
number float

The number of objects to skip for the requested result

Responses
200
Success
400
Bad Request
401
Unauthorized

Was this section helpful?

YesNo
get
/api/scans
Response
application/json
{
  "docs": [
    {
      "_id": "string",
      "ticketId": "string",
      "time": "2030-01-23T23:00:00.123Z",
      "eventId": "string",
      "parentEventId": "string",
      "barcode": "string",
      "name": "string",
      "ticketTypeId": "string",
      "ticketName": "string",
      "deviceId": "string",
      "type": "checkin",
      "scanResult": "approved",
      "sellerId": "string",
      "scanZoneId": "string"
    }
  ],
  "total": 1
}