Skip to main content
GET
Get Authenticators

Authorizations

Authorization
string
header
required

Use a short-lived token obtained from the Server API's Track Action endpoint. The token is valid for 10 minutes and should be passed in the Authorization header as 'Bearer {token}'.

Response

OK

userAuthenticatorId
string
required
authenticatorType
enum<string>
required
Available options:
OOB,
OTP,
SECURITY_KEY,
PASSKEY,
PUSH,
DEVICE,
PROVIDER
createdAt
string<date-time>
required
verificationMethod
enum<string>
required
Available options:
SMS,
AUTHENTICATOR_APP,
EMAIL_MAGIC_LINK,
EMAIL_OTP,
PUSH,
DEVICE,
SECURITY_KEY,
PASSKEY,
VERIFF,
IPROOV,
PALM_BIOMETRICS_RR,
IDVERSE
email
string

A masked version of the user's email.

phoneNumber
string

A masked version of the user's phone number.

verifiedAt
string<date-time>
lastVerifiedAt
string<date-time>
oobChannel
enum<string>
Available options:
EMAIL_MAGIC_LINK,
EMAIL_OTP,
SMS
previousSmsChannel
enum<string>

The channel that was last used by the user to complete an SMS challenge.

Available options:
DEFAULT,
WHATSAPP
erroredAt
string<date-time>

When this authenticator was last found to be unusable. Set when sending a push notification to this authenticator fails during Start Push Challenge, and cleared once it is used successfully again.

errorCode
string

Why this authenticator was last found to be unusable, passed through as-is from the underlying provider. Set and cleared alongside erroredAt.

webauthnCredential
object