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

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/users/auth/passwordless/qrcode/{qrCodeId}

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": "0cc24305-392b-435f-ac0e-dabf9b0c2b0b",
    "status": "New",
    "approvedAt": null
  },
  "errors": []
}