Create scan
curl --request POST \
--url https://api.passentry.com/api/v1/scans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"scan": {
"readerId": "south-gate-1",
"passId": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"scanType": "barcode",
"loyalty": {
"balance": 10
}
}
}'{
"validationResponse": {
"status": "successful",
"statusDetail": "",
"readerInstructions": {
"message": "10 points added to your balance. Current balance: 25"
},
"loyalty": {
"balanceChange": "10",
"updatedBalance": "25",
"operation": "add"
}
},
"scanInfo": {
"scanId": "019488b8-c2fc-7b5b-b5b4-deb2b7f33bdd",
"scanType": "barcode",
"scanValue": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"validationType": "internalValidation",
"status": "successful",
"statusDetail": "",
"scannedAt": "2025-01-21T11:56:37Z",
"passId": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"passExtId": "4312d68fd106e3e6dd15",
"readerId": "south-gate-1"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
UUID of the reader that scanned the pass
ID (uuid or ext_id) of the pass that was scanned
Type of scan: nfc or barcode
nfc, barcode Response
Status of the validation: 'successful' or 'failed'
successful, failed Detailed status of the validation including error details
Message to be displayed by the reader.
UUID of the scan
Type of scan: nfc or barcode
nfc, barcode The raw value read by the reader during the scan. For NFC, this is the encoded NFC message. For barcodes, this is the encoded barcode value.
Type of validation: 'internal' for PassEntry Validation or 'external' for Third-Party Validation.
internalValidation, externalValidation Status of the validation: 'successful' or 'failed'
successful, failed Detailed status of the validation including error details
ISO8601 timestamp of the scan
UUID of the pass that was scanned
External ID of the pass that was scanned
UUID of the reader that scanned the pass
curl --request POST \
--url https://api.passentry.com/api/v1/scans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"scan": {
"readerId": "south-gate-1",
"passId": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"scanType": "barcode",
"loyalty": {
"balance": 10
}
}
}'{
"validationResponse": {
"status": "successful",
"statusDetail": "",
"readerInstructions": {
"message": "10 points added to your balance. Current balance: 25"
},
"loyalty": {
"balanceChange": "10",
"updatedBalance": "25",
"operation": "add"
}
},
"scanInfo": {
"scanId": "019488b8-c2fc-7b5b-b5b4-deb2b7f33bdd",
"scanType": "barcode",
"scanValue": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"validationType": "internalValidation",
"status": "successful",
"statusDetail": "",
"scannedAt": "2025-01-21T11:56:37Z",
"passId": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"passExtId": "4312d68fd106e3e6dd15",
"readerId": "south-gate-1"
}
}