Get scan
curl --request GET \
--url https://api.passentry.com/api/v1/scans/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "019488b8-c2fc-7b5b-b5b4-deb2b7f33bdd",
"type": "scan",
"attributes": {
"scanType": "nfc",
"scanValue": "factory_scan_value",
"validationType": "internalValidation",
"status": "failed",
"statusDetail": "Pass is not active",
"scannedAt": "2025-01-13T13:00:00Z"
},
"relationships": {
"pass": {
"data": {
"id": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"type": "pass"
}
},
"reader": {
"data": {
"id": "south-gate-1",
"type": "reader"
}
}
}
},
"included": [
{
"id": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"type": "pass",
"attributes": {
"downloadUrl": "https://www.example.com?pass=7882e98b-0eba-4625-9223-5221eb8dad7f",
"passType": "generic",
"createdAt": "2022-01-01T00:00:00Z",
"status": "issued",
"extId": "4312d68fd106e3e6dd15",
"passTemplateUuid": "8e94b9ae1c7828b4d8b75fe0",
"passTemplateName": "Pass Template 9 2688",
"nfc": null,
"barcode": null,
"passContent": {
"fullName": "John Johnson"
}
}
},
{
"id": "south-gate-1",
"type": "reader",
"attributes": {
"name": "South Gate Reader",
"readerType": "PassentryReader",
"loggedIn": false,
"qrEnabled": false,
"mifareClassicNfcEnabled": false,
"scanEnabled": true,
"redeemEnabled": false,
"addPointsEnabled": false,
"ndefTagScanningEnabled": false,
"lastSeenAt": "2020-03-13T13:00:00Z"
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Scan UUID
Response
Auto-generated 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
Relationships to other resources.
Auto-generated UUID of the pass
Unique download URL of the pass
Pass Type
generic, eventTicket, storeCard android, iphone In ISO8601 format, UTC
Pass Status
issued, active, removed, deactivated Pass External ID
Tag used for grouping passes
When pass has been added to wallet by the user. In ISO8601 format, UTC
When pass has been removed from wallet by the user. In ISO8601 format, UTC
When pass has been deactivated. In ISO8601 format, UTC
Pass will expire at this time. In ISO8601 format, UTC
UUID of corresponding pass template
Name of corresponding pass template
If present, the NFC message to be conveyed when the pass is tapped
If present, the last push message sent to the pass
The templateKey identifies an individual pass field in the pass template, using the template field ID. The value is the assigned value for a specific field and is displayed on the pass. For example, {'fullName': 'Jane Smith'} corresponds to the 'fullName' template field ID.
Pass design values, present if pass template has been overridden for this pass, or if 'includePassDesign' query param is set to true
Pass background color in hex format
Pass label color in hex format. Only valid for iphone passes
Pass text color in hex format. Only valid for iphone passes
URL of pass banner image
URL of pass logo image
Locations, present if 'includeLocations' query param is set to true
Name of the location, used for display purposes only
Latitude of the location
Longitude of the location
Effective geofence radius of the location in meters. Maximum is 1000 for eventTicket passes, 100 for other pass types
10 < x < 1000Message to display when user enters geofence
Geocoded address of the location. Used for display purposes only. This is calculated automatically from the latitude and longitude values
Beacons, present if 'includeBeacons' query param is set to true
Unique identifier of the beacon
Major Value, provides additional identification for a beacon
Minor Value, provides additional identification for a beacon
Message to display on lock screen when the user is in range of the beacon
Name of the beacon, used for display purposes only
Pass source, present if 'includePassDesign' query param is present, one of Apple/Google and current pass status is not 'active'.
Apple Wallet Pass Base64 string, to generate the pass, decode the string and save as a .pkpass file. Will prompt the user to download the pass to their Apple Wallet when opened on an iPhone.
Google Wallet Pass download URL. Will prompt the user to download the pass to their Google Wallet when opened on an Android device.
Was this page helpful?
curl --request GET \
--url https://api.passentry.com/api/v1/scans/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "019488b8-c2fc-7b5b-b5b4-deb2b7f33bdd",
"type": "scan",
"attributes": {
"scanType": "nfc",
"scanValue": "factory_scan_value",
"validationType": "internalValidation",
"status": "failed",
"statusDetail": "Pass is not active",
"scannedAt": "2025-01-13T13:00:00Z"
},
"relationships": {
"pass": {
"data": {
"id": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"type": "pass"
}
},
"reader": {
"data": {
"id": "south-gate-1",
"type": "reader"
}
}
}
},
"included": [
{
"id": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"type": "pass",
"attributes": {
"downloadUrl": "https://www.example.com?pass=7882e98b-0eba-4625-9223-5221eb8dad7f",
"passType": "generic",
"createdAt": "2022-01-01T00:00:00Z",
"status": "issued",
"extId": "4312d68fd106e3e6dd15",
"passTemplateUuid": "8e94b9ae1c7828b4d8b75fe0",
"passTemplateName": "Pass Template 9 2688",
"nfc": null,
"barcode": null,
"passContent": {
"fullName": "John Johnson"
}
}
},
{
"id": "south-gate-1",
"type": "reader",
"attributes": {
"name": "South Gate Reader",
"readerType": "PassentryReader",
"loggedIn": false,
"qrEnabled": false,
"mifareClassicNfcEnabled": false,
"scanEnabled": true,
"redeemEnabled": false,
"addPointsEnabled": false,
"ndefTagScanningEnabled": false,
"lastSeenAt": "2020-03-13T13:00:00Z"
}
}
]
}