Enroll Verified Authenticator

Path Parameters

userId

string

required

The ID of the user.

Body

application/json

verificationMethod

enum<string>

required

The verification method of the authenticator being enrolled.

Available options:

EMAIL_MAGIC_LINK,

EMAIL_OTP,

SMS,

AUTHENTICATOR_APP

string

The user's email address. Required for EMAIL_MAGIC_LINK and EMAIL_OTP.

oobChannel

enum<string>

Deprecated - use 'verificationMethod' instead.

Available options:

EMAIL_MAGIC_LINK,

EMAIL_OTP,

SMS

otpUri

string

The formatted OTP URI. Required for AUTHENTICATOR_APP.

phoneNumber

string

The user's phone number in E.164 format. Required for SMS.

Response

200 - application/json

authenticator

object

authenticator.createdAt

string

required

authenticator.userAuthenticatorId

string

required

authenticator.verificationMethod

enum<string>

required

Available options:

SMS,

AUTHENTICATOR_APP,

EMAIL_MAGIC_LINK,

EMAIL_OTP,

PUSH,

SECURITY_KEY,

PASSKEY,

VERIFF,

IPROOV,

PALM_BIOMETRICS_RR,

IDVERSE

authenticator.displayName

string

authenticator.email

string

authenticator.lastVerifiedAt

string

authenticator.phoneNumber

string

authenticator.previousSmsChannel

enum<string>

The channel that was last used by the user to complete an SMS challenge. Only defined if the verification method is SMS.

Available options:

DEFAULT,

WHATSAPP

authenticator.username

string

authenticator.verifiedAt

string

authenticator.webauthnCredential

object

authenticator.webauthnCredential.aaguid

string

authenticator.webauthnCredential.aaguidMapping

object

authenticator.webauthnCredential.authenticatorAttachment

enum<string>

Available options:

cross-platform,

platform

authenticator.webauthnCredential.credentialBackedUp

boolean

authenticator.webauthnCredential.credentialDeviceType

enum<string>

Available options:

singleDevice,

multiDevice

authenticator.webauthnCredential.credentialId

string

authenticator.webauthnCredential.deviceId

string

authenticator.webauthnCredential.name

string

The name of the passkey. Defaults to aaguidMapping.name if available.

authenticator.webauthnCredential.parsedUserAgent

object

recoveryCodes

string[]

API Reference

Server API

Client API

Management API

Terminal API

Enroll Verified Authenticator

Path Parameters

Body

Response