Get the current status of a QR Code

Get the current status of a QR Code pairing request.

get

Possible statuses: pending, approved, expired, rejected. This endpoint is usually polled every few seconds by the initiating device until the QR Code is approved or expired.

Path parameters

qrCodeIdstring · uuidRequired

The unique identifier of the QR Code session.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/users/auth/passwordless/qrcode/{qrCodeId} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "4c387924-0df1-4e53-af9e-156fad3d1351",
    "status": "New",
    "approvedAt": null
  },
  "errors": []
}