1. Docs
  2. API Reference
  3. MfaTotpEnrollStartResponseDto

MfaTotpEnrollStartResponseDto

Example

JSON
{
  "enrollment_token": "string",
  "otpauth_uri": "otpauth://totp/MFA:alice%40acme.com?secret=JBSWY3DPEHPK3PXP&issuer=MFA",
  "manual_entry_key": "JBSWY3DPEHPK3PXP"
}

Properties

3 properties 3 required

enrollment_token string Required

Opaque short-lived (5 min) sealed token carrying the provisional TOTP secret. Must be returned to the verify endpoint exactly.

otpauth_uri string Required

`otpauth://totp/...` URI for the authenticator app to import. Render as a QR code on the client.

Exampleotpauth://totp/MFA:alice%40acme.com?secret=JBSWY3DPEHPK3PXP&issuer=MFA
manual_entry_key string Required

Human-readable fallback for users who can't scan the QR. Base32-encoded secret string.

ExampleJBSWY3DPEHPK3PXP
Was this page helpful?

Tell us how we can improve this guide.