Skip to main content
POST
/
verify
Verify challenge
curl --request POST \
  --url https://api.authsignal.com/v1/verify \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "challengeId": "<string>",
  "verificationCode": "<string>"
}
'
{
  "isVerified": true,
  "verificationMethod": "SMS",
  "phoneNumber": "<string>",
  "email": "<string>",
  "failureReason": "CODE_INVALID_OR_EXPIRED"
}

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.

Body

application/json
​
challengeId
string
required

The ID of the challenge.

​
verificationCode
string
required

The verification code submitted by the user.

Response

OK

​
isVerified
boolean
required

True if the verification code is valid.

​
verificationMethod
enum<string>

The verification method used for the challenge if successful.

Available options:
SMS,
EMAIL_OTP,
WHATSAPP
​
phoneNumber
string

The phone number for which the challenge was initiated. Only present if verification is successful and the verification method is 'SMS' or 'WHATSAPP'.

​
email
string

The email address for which the challenge was initiated. Only present if verification is successful and the verification method is 'EMAIL_OTP'.

​
failureReason
enum<string>
Available options:
CODE_INVALID_OR_EXPIRED,
MAX_ATTEMPTS_EXCEEDED