Skip to main content
GET
/
challenges
Get challenge
curl --request GET \
  --url https://api.authsignal.com/v1/challenges \
  --header 'Authorization: Basic <encoded-value>'
{
  "challengeId": "<string>",
  "verificationMethod": "SMS",
  "phoneNumber": "<string>",
  "email": "<string>",
  "smsChannel": "<string>",
  "expiresAt": 123,
  "action": 123
}

Authorizations

​
Authorization
string
header
required

Use your Authsignal secret key as the username and leave the password empty. The secret key can be found in the API Keys section of the Authsignal Portal settings page.

Query Parameters

​
challengeId
string

The ID of the challenge.

Response

OK

​
challengeId
string

The ID of the challenge.

​
verificationMethod
enum<string>

The verification method used to complete the challenge. This field can be used to determine if the challenge has been successfully completed and which method was used.

Available options:
SMS,
EMAIL_OTP
​
phoneNumber
string
​
email
string
​
smsChannel
string
​
expiresAt
number
​
action
number