Skip to main content

VerifyMFACodeDTO

Package: @nauth-toolkit/core Type: DTO (Request/Response)

Data transfer objects for verifying MFA code using the appropriate provider.

import { VerifyMFACodeDTO, VerifyMFACodeResponseDTO } from '@nauth-toolkit/nestjs';

VerifyMFACodeDTO (Request)

PropertyTypeRequiredDescription
substringYesUser sub. UUID v4 format. Trimmed and lowercased.
methodNamestringYesMFA method name. Must be: totp, sms, email, passkey, backup. Max 50 characters. Trimmed and lowercased.
codestring | Record<string, unknown>YesVerification code or credential. For TOTP/SMS/Email/Backup: string code. For Passkey: credential object.
deviceIdnumberNoOptional device ID. Must be positive integer if provided.

VerifyMFACodeResponseDTO (Response)

PropertyTypeDescription
validbooleanTrue if verification succeeds.

Example

{
"sub": "a21b654c-2746-4168-acee-c175083a65cd",
"methodName": "totp",
"code": "123456"
}

Response:

{
"valid": true
}

Used By