Scans
Create scan
Scans
Create scan
POST
/
api
/
v1
/
scans
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"
}
}'{
"validationResponse": {
"status": "failed",
"statusDetail": "Pass is not active",
"readerInstructions": {
"message": "Sorry, your pass is not active. Please contact the venue for assistance."
}
},
"scanInfo": {
"scanId": "019488b8-c2fc-7b5b-b5b4-deb2b7f33bdd",
"scanType": "barcode",
"scanValue": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"validationType": "internalValidation",
"status": "failed",
"statusDetail": "Pass is not active",
"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
application/json
Response
200
application/json
OK
Status of the validation: 'success' or 'failed'
Available options:
success, failed Detailed status of the validation including error details
UUID of the scan
Type of scan: nfc or barcode
Available options:
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.
Available options:
internalValidation, externalValidation Status of the validation: 'successful' or 'failed'
Available options:
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"
}
}'{
"validationResponse": {
"status": "failed",
"statusDetail": "Pass is not active",
"readerInstructions": {
"message": "Sorry, your pass is not active. Please contact the venue for assistance."
}
},
"scanInfo": {
"scanId": "019488b8-c2fc-7b5b-b5b4-deb2b7f33bdd",
"scanType": "barcode",
"scanValue": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"validationType": "internalValidation",
"status": "failed",
"statusDetail": "Pass is not active",
"scannedAt": "2025-01-21T11:56:37Z",
"passId": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"passExtId": "4312d68fd106e3e6dd15",
"readerId": "south-gate-1"
}
}