v1

latestOpenAPI 3.1.02026-07-268342124.0 KB

SMS

Verify SMS Challenge

Verify a challenge when enrolling a new SMS authenticator or when re-authenticating with an existing SMS authenticator.

post/verify/sms

Request body

verificationCodestring required

The OTP code inputted by the user.

Response

isVerifiedboolean required

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

accessTokenstring

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'CODE_INVALID_OR_EXPIRED' | 'MAX_ATTEMPTS_EXCEEDED'