v1

latestOpenAPI 3.1.02026-07-268342124.0 KB

QR Code

Start QR Code Challenge

Start an anonymous QR code challenge to be completed by a user's mobile device. This is called an anonymous challenge because it is not associated with a user.

post/challenge/qr-code

Request body

actionstring required

The action code used to identify the challenge in the Authsignal Portal. Only relevant when initiating anonymous QR code challenges, otherwise uses the values from the tracked action.

customobject

A JSON object which can include any key/value pairs. Should be provided when using rules based on custom data points from your own app. Only relevant when initiating anonymous QR code challenges, otherwise uses the values from the tracked action.

Response

challengeIdstring required

The ID of the challenge which has been initiated. Use this ID to lookup whether the challenge has been approved or rejected by the user on their mobile device (e.g. via polling).

deviceCodestring

The device code used to check the challenge status. Only returned when polling mode is used.

expiresAtstring date-time required

The timestamp at which the challenge will expire.