Skip to main content
GET
/
authenticators
Get authenticator configurations
curl --request GET \
  --url https://api.authsignal.com/v1/authenticators
[
  {
    "authenticatorId": "authenticator_123",
    "isActive": true,
    "verificationMethod": "SMS",
    "smsChannel": "WHATSAPP"
  }
]

Response

OK

​
authenticatorId
string
required

The ID of the authenticator configuration.

​
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
​
isActive
boolean
required

Determines whether the authenticator configuration is currently active/enabled.

​
isEditableByUser
boolean

Determines whether the user is able to edit the authenticator in the pre-built UI.

​
isHiddenToUser
boolean

Determines whether the authenticator in hidden in the pre-built UI.

​
smsChannel
enum<string>

For SMS authenticator configurations only. If set to DEFAULT, only regular SMS is allowed. If set to WHATSAPP, both regular SMS and WhatsApp messages are allowed.

Available options:
DEFAULT,
WHATSAPP
⌘I