Scan

Record a pass barcode scan event

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/scans

Records scan events when pass barcodes/QR codes are scanned. Scans are correlated to passes and generate scan completion events for downstream systems (redemption, attendance tracking, etc.).

Authorization

Requires PassScan.Scan scope

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

datastring · min: 3 · max: 2048Required

Raw Data of the scan value

typestring · enumRequiredPossible values:

Responses

201

Scan successfully recorded; pass identifier returned

text/plainapplication/jsontext/json

400

Invalid scan request (data too short/long, missing type)

text/plainapplication/jsontext/json

401

Not authorized or invalid credentials

text/plainapplication/jsontext/json

404

No pass found with matching scan data

text/plainapplication/jsontext/json

500

Processing error during scan event generation

post

/api/{tenantId}/scans

HTTPcURLJavaScriptPython

POST /api/{tenantId}/scans HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "data": "text",
  "type": "manual"
}

application/jsontext/jsonapplication/*+json

{
  "passId": null
}