QR code verification

Check out our end-to-end guide on how to implement QR code verification using Authsignal.

Start a QR code challenge

const { data } = await authsignal.qrCode.challenge({
  action: "kiosk-login",
  onStateChange: (state: ChallengeState, token?: string) => {
    if (state === "approved" && token) {
      // Validate the challenge on your backend
    }
  },
});

Parameters

string

required

The action being performed.

function

required

A function that is called when the challenge state changes.

Show parameters

string

The current state of the challenge.Possible values are: unclaimed, claimed, approved, rejected.

string

A token which can be used for server-side validation.

function

A function that is called when the challenge should be refreshed.

Show parameters

string

The ID of the Authsignal challenge. The value of this should be rendered as a QR code.

string

The timestamp in ISO 8601 format at which the challenge will expire.

object

A JSON object which can include any key/value pairs. Can be used to provide additional context to the challenge which can be reviewed on the user’s mobile device.

number

The interval in milliseconds at which the challenge should be refreshed. Defaults to 540000 (9 minutes). This should be set to a value lower than your token’s expiry time to allow a tolerance for the challenge to be completed.

boolean

Whether to poll for the challenge result using RESTful API endpoints. Should only be used if you are unable to use WebSocket connections.Defaults to false and uses WebSockets.

number

The interval in milliseconds at which the challenge should be polled. Defaults to 3000 (3 seconds).Only relevant when polling is set to true.

Response

AuthsignalResponse<QrCodeChallengeResponse>

Show properties

QrCodeChallengeResponse

Show properties

string

The ID of the Authsignal challenge. The value of this should be rendered as a QR code.

string

The timestamp in ISO 8601 format at which the challenge will expire.

string

A short code which can be entered manually on the user’s mobile device as a fallback to scanning the QR code. Only available when polling is set to true.

string

See the Error handling section for more details.

string

Refresh a QR code challenge

await authsignal.qrCode.refresh();

This can only be called after a QR code challenge has been initiated. The callback functions passed to the challenge method will be re-used.

Parameters

object

A JSON object which can include any key/value pairs. Can be used to update context to the challenge which can be reviewed on the user’s mobile device.

Disconnect a QR code challenge

Call disconnect to tear down the active challenge. This closes the WebSocket connection (or stops polling) and clears any refresh timers. Call it when the QR code is no longer displayed, for example when the user navigates away.

authsignal.qrCode.disconnect();

Server

Client

Call Connect

QR code verification

Start a QR code challenge

Parameters

Response

Refresh a QR code challenge

Parameters

Disconnect a QR code challenge

​Start a QR code challenge

​Parameters

​Response

​Refresh a QR code challenge

​Parameters

​Disconnect a QR code challenge

Start a QR code challenge

Parameters

Response

Refresh a QR code challenge

Parameters

Disconnect a QR code challenge