Skip to main content
POST
/
v1
/
scans
Record a scan
curl --request POST \
  --url https://api.passlet.io/v1/scans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "qrPayload": "<string>",
  "passId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scanContextKey": "<string>",
  "validityDate": "<string>",
  "scannedAt": "2023-11-07T05:31:56Z",
  "deviceId": "<string>",
  "externalRef": "<string>",
  "context": {
    "gate": "<string>",
    "lane": "<string>",
    "location": "<string>",
    "sessionId": "<string>",
    "note": "<string>"
  }
}
'
import requests

url = "https://api.passlet.io/v1/scans"

payload = {
    "qrPayload": "<string>",
    "passId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scanContextKey": "<string>",
    "validityDate": "<string>",
    "scannedAt": "2023-11-07T05:31:56Z",
    "deviceId": "<string>",
    "externalRef": "<string>",
    "context": {
        "gate": "<string>",
        "lane": "<string>",
        "location": "<string>",
        "sessionId": "<string>",
        "note": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    qrPayload: '<string>',
    passId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    scanContextKey: '<string>',
    validityDate: '<string>',
    scannedAt: '2023-11-07T05:31:56Z',
    deviceId: '<string>',
    externalRef: '<string>',
    context: {
      gate: '<string>',
      lane: '<string>',
      location: '<string>',
      sessionId: '<string>',
      note: '<string>'
    }
  })
};

fetch('https://api.passlet.io/v1/scans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.passlet.io/v1/scans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'qrPayload' => '<string>',
    'passId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'projectId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'scanContextKey' => '<string>',
    'validityDate' => '<string>',
    'scannedAt' => '2023-11-07T05:31:56Z',
    'deviceId' => '<string>',
    'externalRef' => '<string>',
    'context' => [
        'gate' => '<string>',
        'lane' => '<string>',
        'location' => '<string>',
        'sessionId' => '<string>',
        'note' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.passlet.io/v1/scans"

	payload := strings.NewReader("{\n  \"qrPayload\": \"<string>\",\n  \"passId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scanContextKey\": \"<string>\",\n  \"validityDate\": \"<string>\",\n  \"scannedAt\": \"2023-11-07T05:31:56Z\",\n  \"deviceId\": \"<string>\",\n  \"externalRef\": \"<string>\",\n  \"context\": {\n    \"gate\": \"<string>\",\n    \"lane\": \"<string>\",\n    \"location\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"note\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.passlet.io/v1/scans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"qrPayload\": \"<string>\",\n  \"passId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scanContextKey\": \"<string>\",\n  \"validityDate\": \"<string>\",\n  \"scannedAt\": \"2023-11-07T05:31:56Z\",\n  \"deviceId\": \"<string>\",\n  \"externalRef\": \"<string>\",\n  \"context\": {\n    \"gate\": \"<string>\",\n    \"lane\": \"<string>\",\n    \"location\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"note\": \"<string>\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.passlet.io/v1/scans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"qrPayload\": \"<string>\",\n  \"passId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scanContextKey\": \"<string>\",\n  \"validityDate\": \"<string>\",\n  \"scannedAt\": \"2023-11-07T05:31:56Z\",\n  \"deviceId\": \"<string>\",\n  \"externalRef\": \"<string>\",\n  \"context\": {\n    \"gate\": \"<string>\",\n    \"lane\": \"<string>\",\n    \"location\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"note\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "scan": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "passId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "templateVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redemptionSnapshot": {
      "windows": [
        {
          "start": "<string>",
          "end": "<string>",
          "maxUses": 50000
        }
      ],
      "maxUses": 50000,
      "perPeriod": {
        "count": 50000,
        "timezone": "<string>"
      },
      "minIntervalMinutes": 263520,
      "activation": {
        "basis": "<string>",
        "validForHours": 43920
      }
    },
    "scanContextKey": "<string>",
    "scannedAt": "2023-11-07T05:31:56Z",
    "recordedAt": "2023-11-07T05:31:56Z",
    "reversesScanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deviceId": "<string>",
    "context": {},
    "externalRef": "<string>",
    "reason": "<string>",
    "matchedCount": 4503599627370495,
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "pass": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalPassId": "<string>",
    "label": "<string>",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectName": "<string>",
    "templateVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "templateName": "<string>",
    "templateVersionNumber": 4503599627370495,
    "expiresAt": "2023-11-07T05:31:56Z",
    "acceptedScanCount": 4503599627370495,
    "lastAcceptedScanAt": "2023-11-07T05:31:56Z",
    "scanContextKey": "<string>",
    "contextAcceptedScanCount": 4503599627370495,
    "contextLastAcceptedScanAt": "2023-11-07T05:31:56Z",
    "photoUrl": "<string>",
    "variables": {}
  },
  "message": "<string>",
  "priorScanCount": 0,
  "isFirstScan": false,
  "idempotentReplay": false,
  "candidates": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalPassId": "<string>",
      "label": "<string>",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectName": "<string>",
      "templateVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "templateName": "<string>",
      "templateVersionNumber": 4503599627370495,
      "expiresAt": "2023-11-07T05:31:56Z",
      "acceptedScanCount": 4503599627370495,
      "lastAcceptedScanAt": "2023-11-07T05:31:56Z",
      "scanContextKey": "<string>",
      "contextAcceptedScanCount": 4503599627370495,
      "contextLastAcceptedScanAt": "2023-11-07T05:31:56Z",
      "photoUrl": "<string>",
      "variables": {}
    }
  ]
}
{
  "message": "<string>",
  "correlationId": "<string>",
  "details": {}
}
{
  "message": "<string>",
  "correlationId": "<string>",
  "details": {}
}
{
  "message": "<string>",
  "correlationId": "<string>",
  "details": {}
}
{
  "message": "<string>",
  "correlationId": "<string>",
  "details": {}
}
{
  "message": "<string>",
  "correlationId": "<string>",
  "details": {}
}
{
  "message": "<string>",
  "correlationId": "<string>",
  "details": {}
}
{
  "message": "<string>",
  "correlationId": "<string>",
  "details": {}
}
{
  "message": "<string>",
  "correlationId": "<string>",
  "details": {}
}

Authorizations

​
Authorization
string
header
required

Passlet access token (plt_*) sent as Authorization: Bearer <token> or X-API-Key. Authorized scopes are listed per operation under x-required-scopes.

Body

application/json
​
qrPayload
string
Required string length: 1 - 2048
​
passId
string<uuid>

Pass identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
projectId
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
scanContextKey
string
Required string length: 1 - 128
​
validityDate
string
Pattern: ^\d{4}-\d{2}-\d{2}$
​
scannedAt
string<date-time>

ISO 8601 timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
deviceId
string
Maximum string length: 128
​
externalRef
string
Required string length: 1 - 255
​
context
object

Response

OK

​
result
enum<string>
required
Available options:
accepted,
duplicate,
unknown,
ambiguous,
denied,
reversal
​
reasonCode
enum<string> | null
required
Available options:
valid,
stale_identifier,
already_scanned,
not_active,
expired,
revoked,
wrong_scope,
not_valid_context,
out_of_window,
quota_exhausted,
cooldown,
no_match,
multiple_matches
​
scan
object | null
required
​
pass
object | null
required
​
message
string
required
​
priorScanCount
integer
default:0
required
Required range: 0 <= x <= 9007199254740991
​
isFirstScan
boolean
default:false
required
​
idempotentReplay
boolean
default:false
required
​
candidates
object[]