Generate a new QR code

Generate a new QR Code for pairing authentication between two devices.

post

This endpoint is called by the initiating device (Admin or Client) to start the pairing process. The generated QR Code contains a link with pairing session ID as a parameter. If the callbackUrl is not provide, we generate new URL payload base on Brand-URL header or Client Domain request. The format is: {SECOND_LEVEL_DOMAIN}://pair/{QR_ID} Example Flow:

1. Device A calls this endpoint to get QR Code data.
2. Device B scans the QR Code and calls POST api/v1/users/auth/passwordless/qrcode/:qrCodeId/approve to approve.

Query parameters

callbackUrlstringOptional

Optional URL for the QR Code link. If provided, the QR Code will encode this URL with a query id for the pairing 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

post

/api/v1/users/auth/passwordless/qrcode/generate

HTTPcURLJavaScriptPython

POST /api/v1/users/auth/passwordless/qrcode/generate HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "qrCodeBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAl4AAAJeAQAAAABNW...",
    "expiryDate": "0001-01-01T00:00:00",
    "id": "18f64908-14ac-498a-a228-fe9e27b5eba3",
    "status": "New",
    "approvedAt": null
  },
  "errors": []
}