Scan

Records a scan of a pass barcode and returns the pass it belongs to.

post

/api/{tenantId}/scans

The pass is found by exact match of data against the barcode values each pass carries; when several passes carry the value, the most recently updated one wins. A pass-scanned event is emitted for that pass with the scanned data and type, for automations and connected partners. The pass itself is not changed.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

A value read from a pass by a scanner, a camera or a keyboard.

datastring · min: 3 · max: 2048Required

The decoded content, exactly as read. It must equal, character for character, one of the barcode values rendered on a pass (its Apple or Google barcode message, trimmed).

typestring · enumRequired

How data was captured. Recorded on the scan event as scannedType, in PascalCase (for example QRCode for qrcode).

Possible values:

Responses

201

Scan recorded; the body names the pass.

The pass the scanned value resolved to.

passIdstringRequired

The pass carrying the scanned value. When several passes carry it, the most recently updated one.

400

data is missing or outside 3 to 2048 characters, or type is missing or unknown.

401

The caller is not authenticated.

application/problem+json

403

The caller lacks the tenant.scan:scan scope, or the endpoint is not enabled for the tenant.

application/problem+json

404

No pass carries the scanned value.

429

Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.

application/problem+json

post/api/{tenantId}/scans

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"
}

{
  "passId": "text"
}