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": "df9ad600-ffb4-4fdf-b59a-1dff79d4f993",
  "verificationCode": "123456"
}'
{
  "isVerified": true,
  "phoneNumber": "<string>",
  "email": "<string>"
}

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 inputted by the user.

Response

OK

isVerified
boolean
required

True if the verification code is valid.

phoneNumber
string

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

email
string

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