Skip to main content
POST
/
challenge
/
qr-code
Start QR Code Challenge
curl --request POST \
  --url https://api.authsignal.com/v1/client/challenge/qr-code \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "<string>",
  "custom": {}
}
'
{
  "challengeId": "<string>",
  "deviceCode": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use a short-lived token obtained from the Server API's Track Action endpoint. The token is valid for 10 minutes and should be passed in the Authorization header as 'Bearer {token}'.

Body

application/json
​
action
string

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.

​
custom
object

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

OK

​
challengeId
string
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).

​
deviceCode
string
required

The device code used to check the challenge status.