---
title: supertokens-auth-react/recipe/multifactorauth/types
description: References documentation for the supertokens-auth-react/recipe/multifactorauth/types package
sidebar:
  order: 80
---

## Type Aliases

### ComponentOverrideMap

```ts check=false reason="Generated API signature"
type ComponentOverrideMap = object;
```

Defined in: [recipe/multifactorauth/types.ts:32](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L32)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="mfafactorchooserfooter_override"></a> `MFAFactorChooserFooter_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index#supertokenswrapper-1)\> | [recipe/multifactorauth/types.ts:33](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L33) |
| <a id="mfafactorchooserheader_override"></a> `MFAFactorChooserHeader_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index#supertokenswrapper-1)\> | [recipe/multifactorauth/types.ts:34](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L34) |
| <a id="mfafactorlist_override"></a> `MFAFactorList_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index#supertokenswrapper-1)\> | [recipe/multifactorauth/types.ts:35](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L35) |
| <a id="mfafactoroption_override"></a> `MFAFactorOption_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index#supertokenswrapper-1)\> | [recipe/multifactorauth/types.ts:36](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L36) |

***

### Config

```ts check=false reason="Generated API signature"
type Config = UserInput & RecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/multifactorauth/types.ts:58](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L58)

***

### FactorChooserThemeProps

```ts check=false reason="Generated API signature"
type FactorChooserThemeProps = object;
```

Defined in: [recipe/multifactorauth/types.ts:112](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L112)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="availablefactors"></a> `availableFactors` | [`SecondaryFactorRedirectionInfo`](#secondaryfactorredirectioninfo)[] | [recipe/multifactorauth/types.ts:114](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L114) |
| <a id="config-1"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/multifactorauth/types.ts:119](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L119) |
| <a id="mfainfo"></a> `mfaInfo` | [`LoadedMFAInfo`](#loadedmfainfo) | [recipe/multifactorauth/types.ts:113](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L113) |
| <a id="navigatetofactor"></a> `navigateToFactor` | (`factorId`) => `void` | [recipe/multifactorauth/types.ts:117](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L117) |
| <a id="onbackbuttonclicked"></a> `onBackButtonClicked` | () => `void` | [recipe/multifactorauth/types.ts:116](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L116) |
| <a id="onlogoutclicked"></a> `onLogoutClicked` | () => `void` | [recipe/multifactorauth/types.ts:118](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L118) |
| <a id="showbackbutton"></a> `showBackButton` | `boolean` | [recipe/multifactorauth/types.ts:115](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L115) |
| <a id="usercontext"></a> `userContext?` | [`UserContext`](types#usercontext) | [recipe/multifactorauth/types.ts:120](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L120) |

***

### GetRedirectionURLContext

```ts check=false reason="Generated API signature"
type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<
  | {
  action: "FACTOR_CHOOSER";
  nextFactorOptions?: string[];
  stepUp?: boolean;
}
  | {
  action: "GO_TO_FACTOR";
  factorId: string;
  forceSetup?: boolean;
  stepUp?: boolean;
}>;
```

Defined in: [recipe/multifactorauth/types.ts:78](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L78)

***

### LoadedMFAInfo

```ts check=false reason="Generated API signature"
type LoadedMFAInfo = object;
```

Defined in: [recipe/multifactorauth/types.ts:106](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L106)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emails"></a> `emails` | `Record`\<`string`, `string`[] \| `undefined`\> | [recipe/multifactorauth/types.ts:108](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L108) |
| <a id="factors"></a> `factors` | [`SuperTokensWrapper`](index#supertokenswrapper-1) | [recipe/multifactorauth/types.ts:107](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L107) |
| <a id="phonenumbers"></a> `phoneNumbers` | `Record`\<`string`, `string`[] \| `undefined`\> | [recipe/multifactorauth/types.ts:109](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L109) |

***

### NormalisedConfig

```ts check=false reason="Generated API signature"
type NormalisedConfig = object & NormalisedRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/multifactorauth/types.ts:61](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L61)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI` | `boolean` | [recipe/multifactorauth/types.ts:67](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L67) |
| `factorChooserScreen` | [`FeatureBaseConfig`](types#featurebaseconfig) | [recipe/multifactorauth/types.ts:68](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L68) |
| `firstFactors?` | `string`[] | [recipe/multifactorauth/types.ts:62](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L62) |
| `getSecondaryFactorInfo()` | (`builtInFactors`, `userContext`) => [`SecondaryFactorRedirectionInfo`](#secondaryfactorredirectioninfo)[] | [recipe/multifactorauth/types.ts:63](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L63) |
| `override` | `object` | [recipe/multifactorauth/types.ts:70](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L70) |
| `override.functions()` | (`originalImplementation`, `builder?`) => [`SuperTokensWrapper`](index#supertokenswrapper-1) | [recipe/multifactorauth/types.ts:71](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L71) |

***

### OnHandleEventContext

```ts check=false reason="Generated API signature"
type OnHandleEventContext = object;
```

Defined in: [recipe/multifactorauth/types.ts:101](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L101)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action"></a> `action` | `"FACTOR_CHOOSEN"` | [recipe/multifactorauth/types.ts:102](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L102) |
| <a id="factorid"></a> `factorId` | `string` | [recipe/multifactorauth/types.ts:103](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L103) |

***

### PreAndPostAPIHookAction

```ts check=false reason="Generated API signature"
type PreAndPostAPIHookAction = "GET_MFA_INFO";
```

Defined in: [recipe/multifactorauth/types.ts:92](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L92)

***

### PreAPIHookContext

```ts check=false reason="Generated API signature"
type PreAPIHookContext = object;
```

Defined in: [recipe/multifactorauth/types.ts:94](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L94)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action-1"></a> `action` | [`PreAndPostAPIHookAction`](#preandpostapihookaction) | [recipe/multifactorauth/types.ts:95](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L95) |
| <a id="requestinit"></a> `requestInit` | `RequestInit` | [recipe/multifactorauth/types.ts:96](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L96) |
| <a id="url"></a> `url` | `string` | [recipe/multifactorauth/types.ts:97](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L97) |
| <a id="usercontext-1"></a> `userContext` | [`UserContext`](types#usercontext) | [recipe/multifactorauth/types.ts:98](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L98) |

***

### SecondaryFactorRedirectionInfo

```ts check=false reason="Generated API signature"
type SecondaryFactorRedirectionInfo = object;
```

Defined in: [recipe/multifactorauth/types.ts:123](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L123)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="description"></a> `description` | `string` | [recipe/multifactorauth/types.ts:126](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L126) |
| <a id="id"></a> `id` | `string` | [recipe/multifactorauth/types.ts:124](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L124) |
| <a id="logo"></a> `logo` | `FC` | [recipe/multifactorauth/types.ts:127](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L127) |
| <a id="name"></a> `name` | `string` | [recipe/multifactorauth/types.ts:125](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L125) |
| <a id="path"></a> `path` | `string` | [recipe/multifactorauth/types.ts:128](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L128) |

***

### UserInput

```ts check=false reason="Generated API signature"
type UserInput = object & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/multifactorauth/types.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L40)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI?` | `boolean` | [recipe/multifactorauth/types.ts:46](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L46) |
| `factorChooserScreen?` | [`FeatureBaseConfig`](types#featurebaseconfig) | [recipe/multifactorauth/types.ts:47](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L47) |
| `firstFactors?` | `string`[] | [recipe/multifactorauth/types.ts:41](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L41) |
| `getSecondaryFactorInfo()?` | (`builtInFactors`, `userContext`) => [`SecondaryFactorRedirectionInfo`](#secondaryfactorredirectioninfo)[] | [recipe/multifactorauth/types.ts:42](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L42) |
| `override?` | `object` | [recipe/multifactorauth/types.ts:49](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L49) |
| `override.functions()?` | (`originalImplementation`, `builder?`) => [`SuperTokensWrapper`](index#supertokenswrapper-1) | [recipe/multifactorauth/types.ts:50](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L50) |

## Variables

### FactorIds

```ts check=false reason="Generated API signature"
const FactorIds: object;
```

Defined in: [recipe/multifactorauth/types.ts:131](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L131)

#### Type Declaration

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="emailpassword"></a> `EMAILPASSWORD` | `"emailpassword"` | `"emailpassword"` | [recipe/multifactorauth/types.ts:132](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L132) |
| <a id="link_email"></a> `LINK_EMAIL` | `"link-email"` | `"link-email"` | [recipe/multifactorauth/types.ts:135](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L135) |
| <a id="link_phone"></a> `LINK_PHONE` | `"link-phone"` | `"link-phone"` | [recipe/multifactorauth/types.ts:136](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L136) |
| <a id="otp_email"></a> `OTP_EMAIL` | `"otp-email"` | `"otp-email"` | [recipe/multifactorauth/types.ts:133](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L133) |
| <a id="otp_phone"></a> `OTP_PHONE` | `"otp-phone"` | `"otp-phone"` | [recipe/multifactorauth/types.ts:134](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L134) |
| <a id="thirdparty"></a> `THIRDPARTY` | `"thirdparty"` | `"thirdparty"` | [recipe/multifactorauth/types.ts:137](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L137) |
| <a id="totp"></a> `TOTP` | `"totp"` | `"totp"` | [recipe/multifactorauth/types.ts:138](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L138) |
| <a id="webauthn"></a> `WEBAUTHN` | `"webauthn"` | `"webauthn"` | [recipe/multifactorauth/types.ts:139](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L139) |