POST
/
verify
/
sms
Verify SMS Challenge
curl --request POST \
  --url https://api.authsignal.com/v1/client/verify/sms \
  --header 'Content-Type: application/json' \
  --data '{
  "verificationCode": "<string>"
}'
{
  "isVerified": true,
  "accessToken": "<string>",
  "failureReason": "CODE_INVALID_OR_EXPIRED"
}

Body

application/json
​
verificationCode
string
required

The OTP code inputted by the user.

Response

OK

​
isVerified
boolean
required

True if the inputted OTP code matches the code which was sent.

​
accessToken
string

A new short-term token with scopes to manage authenticators (e.g. add secondary authenticators, remove authenticators, view or regenerate recovery codes). Only present if the challenge succeeded.

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