GetSetupDataDTO
Package: @nauth-toolkit/core
Type: DTO (Request)
Data transfer object for requesting MFA setup data (e.g., TOTP QR code, SMS setup).
- NestJS
- Express
- Fastify
import { GetSetupDataDTO } from '@nauth-toolkit/nestjs';
import { GetSetupDataDTO } from '@nauth-toolkit/core';
import { GetSetupDataDTO } from '@nauth-toolkit/core';
Properties
| Property | Type | Required | Description |
|---|---|---|---|
session | string | Yes | Challenge session token. UUID v4 format. Trimmed and lowercased. |
method | MFAMethod | Yes | MFA method. Must be: sms, email, totp, passkey. |
setupData | Record<string, unknown> | No | Provider-specific setup input. SMS: { phoneNumber?: string, deviceName?: string }. phoneNumber (E.164) is required when the account has no phone; a different number replaces the phone on file and resets its verification. |
Example
{
"session": "a21b654c-2746-4168-acee-c175083a65cd",
"method": "sms",
"setupData": { "phoneNumber": "+14155552671" }
}