---
title: supertokens-web-js/recipe/emailverification/types
description: References documentation for the supertokens-web-js/recipe/emailverification/types package
sidebar:
  order: 60
---

## Type Aliases

### InputType

```ts check=false reason="Generated API signature"
type InputType = RecipeConfig<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:43](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L43)

***

### InputTypeOverride

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

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:29](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L29)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="functions"></a> `functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:30](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L30) |

***

### NormalisedInputType

```ts check=false reason="Generated API signature"
type NormalisedInputType = NormalisedRecipeConfig<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:45](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L45)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:46](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L46) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:47](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L47) |

***

### PostAPIHookContext

```ts check=false reason="Generated API signature"
type PostAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:27](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L27)

***

### PreAndPostAPIHookAction

```ts check=false reason="Generated API signature"
type PreAndPostAPIHookAction = "VERIFY_EMAIL" | "SEND_VERIFY_EMAIL" | "IS_EMAIL_VERIFIED";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:24](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L24)

***

### PreAPIHookContext

```ts check=false reason="Generated API signature"
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:26](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L26)

***

### RecipeInterface

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

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:54](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L54)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="getemailverificationtokenfromurl"></a> `getEmailVerificationTokenFromURL` | (`input`) => `string` | Reads and returns the email verification token from the current URL | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:113](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L113) |
| <a id="gettenantidfromurl"></a> `getTenantIdFromURL` | (`input`) => `string` \| `undefined` | Reads and returns the tenant id from the current URL | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:122](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L122) |
| <a id="isemailverified"></a> `isEmailVerified` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `isVerified`: `boolean`; `status`: `"OK"`; \}\> | Check if an email has been verified **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:100](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L100) |
| <a id="sendverificationemail"></a> `sendVerificationEmail` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `status`: `"EMAIL_ALREADY_VERIFIED_ERROR"` \| `"OK"`; \}\> | Send an email to the user for verification. **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:84](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L84) |
| <a id="verifyemail"></a> `verifyEmail` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `status`: `"OK"` \| `"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`; \}\> | Verify an email **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:67](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L67) |

***

### UserInput

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

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:36](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L36)

#### Type Declaration

| Name | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `override?` | [`InputTypeOverride`](#inputtypeoverride) | Refer to [the documentation](https://supertokens.com/docs/references/frontend-sdks/function-overrides) | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:40](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L40) |