[**Documentation**](index.md)

***

[Documentation](packages.md) / Vonage Verify v2

# Vonage Verify V2 SDK for Node.js

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vonage/vonage-node-sdk/ci.yml?branch=3.x) [![Codecov](https://img.shields.io/codecov/c/github/vonage/vonage-node-sdk?label=Codecov&logo=codecov&style=flat-square)](https://codecov.io/gh/Vonage/vonage-server-sdk) ![Latest Release](https://img.shields.io/npm/v/@vonage/verify2?label=%40vonage%2Fverify2&style=flat-square) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](../../CODE_OF_CONDUCT.md) [![License](https://img.shields.io/npm/l/@vonage/accounts?label=License&style=flat-square)][license]

<img src="https://developer.nexmo.com/images/logos/vbc-logo.svg" height="48px" alt="Vonage" />

This is the Vonage Verify (for version 2) SDK for Node.js for use with [Vonage APIs](https://www.vonage.com/). To use it you will need a Vonage account. Sign up [for free at vonage.com][signup].

For full API documentation refer to [developer.vonage.com](https://developer.vonage.com/).

-   [Installation](#installation)
-   [Usage](#usage)
-   [Promises](#promises)
-   [Testing](#testing)

## Installation

We recommend using this SDK as part of the overall [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk). Please see the main package for installation.

You can also use this SDK standalone if you only need access to just the Verify API.

### With NPM

```bash
npm install @vonage/verify2
```

### With Yarn

```bash
yarn add @vonage/verify2
```

## Usage

If you are using this SDK as part of the Vonage Server SDK, you can access it as the `verify2` property off of the client that you instantiate.

```js
const { Vonage } = require('@vonage/server-sdk')

const credentials = {
  apiKey: API_KEY,
  apiSecret: API_SECRET,
}
const options = {}
const vonage = new Vonage(credentials, options)

vonage.verify2
  .newRequest()
  .then((resp) => console.log(resp))
  .catch((err) => console.error(err))
```

### Standalone

The SDK can be used standalone from the main [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) if you only need to use the Verify V2 API. All you need to do is `require('@vonage/verify2')`, and use the returned object to create your own client.

```js
const { Auth } = require('@vonage/auth')
const { Verify2 } = require('@vonage/verify2')

const credentials = new Auth({
  applicationId: APP_ID,
  privateKey: PRIAVTE_KEY,
})
const options = {}
const verifyClient = new Verify2(credentials, options)
```

Where `credentials` is any option from [`@vonage/auth`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/auth/README.md#options), and `options` is any option from [`@vonage/server-client`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/server-client/README.md#options)

## Promises

Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use `await` to wait for a response.

```js
const resp = await verifyClient.checkCode(VERIFY_REQUEST_ID, CODE)

vonage.verify2
  .checkCode(VERIFY_REQUEST_ID, CODE)
  .then((resp) => console.log(resp))
  .catch((err) => console.error(err))
```

## Testing

Run:

```bash
npm run test
```

[signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk
[license]: _media/LICENSE.txt

## Enumerations

### Channels

Defined in: [verify2/lib/enums/channels.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/channels.ts#L4)

Enum representing different communication channels for verification.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="email"></a> `EMAIL` | `"email"` | Email channel for verification. | [verify2/lib/enums/channels.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/channels.ts#L28) |
| <a id="sms"></a> `SMS` | `"sms"` | SMS channel for verification. | [verify2/lib/enums/channels.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/channels.ts#L8) |
| <a id="voice"></a> `VOICE` | `"voice"` | Voice channel for verification. | [verify2/lib/enums/channels.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/channels.ts#L23) |
| <a id="whatsapp"></a> `WHATSAPP` | `"whatsapp"` | WhatsApp channel for verification. | [verify2/lib/enums/channels.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/channels.ts#L13) |
| <a id="whatsapp_interactive"></a> `WHATSAPP_INTERACTIVE` | `"whatsapp_interactive"` | Interactive WhatsApp channel for verification. | [verify2/lib/enums/channels.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/channels.ts#L18) |

***

### EventStatus

Defined in: [verify2/lib/enums/eventStatus.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/eventStatus.ts#L4)

Enum representing the status of an event in the verification process.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="completed"></a> `COMPLETED` | `"completed"` | The event has been completed successfully. | [verify2/lib/enums/eventStatus.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/eventStatus.ts#L8) |
| <a id="failed"></a> `FAILED` | `"failed"` | The event has failed. | [verify2/lib/enums/eventStatus.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/eventStatus.ts#L13) |
| <a id="rejected"></a> `REJECTED` | `"rejected"` | The event has been rejected. | [verify2/lib/enums/eventStatus.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/eventStatus.ts#L23) |
| <a id="user_rejected"></a> `USER_REJECTED` | `"user_rejected"` | The user has rejected the event. | [verify2/lib/enums/eventStatus.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/eventStatus.ts#L18) |

***

### RequestStatus

Defined in: [verify2/lib/enums/requestStatus.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/requestStatus.ts#L4)

Enum representing the status of a verification request.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="completed-1"></a> `COMPLETED` | `"completed"` | The verification request has been completed successfully. | [verify2/lib/enums/requestStatus.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/requestStatus.ts#L8) |
| <a id="expired"></a> `EXPIRED` | `"expired"` | The verification request has expired. | [verify2/lib/enums/requestStatus.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/requestStatus.ts#L18) |
| <a id="failed-1"></a> `FAILED` | `"failed"` | The verification request has failed. | [verify2/lib/enums/requestStatus.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/requestStatus.ts#L13) |

***

### RequestWorkflowStatus

Defined in: [verify2/lib/enums/requestWorkflowsStatus.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/requestWorkflowsStatus.ts#L4)

Enum representing the status of a verification request workflow step.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="completed-2"></a> `COMPLETED` | `"completed"` | The workflow step has been completed successfully. | [verify2/lib/enums/requestWorkflowsStatus.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/requestWorkflowsStatus.ts#L13) |
| <a id="expired-1"></a> `EXPIRED` | `"expired"` | The workflow step has expired. | [verify2/lib/enums/requestWorkflowsStatus.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/requestWorkflowsStatus.ts#L23) |
| <a id="failed-2"></a> `FAILED` | `"failed"` | The workflow step has failed. | [verify2/lib/enums/requestWorkflowsStatus.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/requestWorkflowsStatus.ts#L18) |
| <a id="unused"></a> `UNUSED` | `"unused"` | The workflow step is unused. | [verify2/lib/enums/requestWorkflowsStatus.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/requestWorkflowsStatus.ts#L8) |
| <a id="user_rejected-1"></a> `USER_REJECTED` | `"user_rejected"` | The user has rejected the workflow step. | [verify2/lib/enums/requestWorkflowsStatus.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/requestWorkflowsStatus.ts#L28) |

***

### SilentAuthChannel

Defined in: [verify2/lib/enums/channels.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/channels.ts#L34)

Enum representing the Silent Authentication channel.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="silent_auth"></a> `SILENT_AUTH` | `"silent_auth"` | Silent Authentication channel for verification. | [verify2/lib/enums/channels.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/channels.ts#L38) |

***

### SilentAuthStatus

Defined in: [verify2/lib/enums/silentAuthStatus.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/silentAuthStatus.ts#L4)

Enum representing the status of Silent Authentication.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="action_pending"></a> `ACTION_PENDING` | `"action_pending"` | An action is pending for Silent Authentication. | [verify2/lib/enums/silentAuthStatus.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/silentAuthStatus.ts#L28) |
| <a id="completed-3"></a> `COMPLETED` | `"completed"` | Silent Authentication has been completed successfully. | [verify2/lib/enums/silentAuthStatus.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/silentAuthStatus.ts#L8) |
| <a id="expired-2"></a> `EXPIRED` | `"expired"` | Silent Authentication has expired. | [verify2/lib/enums/silentAuthStatus.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/silentAuthStatus.ts#L23) |
| <a id="failed-3"></a> `FAILED` | `"failed"` | Silent Authentication has failed. | [verify2/lib/enums/silentAuthStatus.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/silentAuthStatus.ts#L13) |
| <a id="user_rejected-2"></a> `USER_REJECTED` | `"user_rejected"` | The user has rejected Silent Authentication. | [verify2/lib/enums/silentAuthStatus.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/silentAuthStatus.ts#L18) |

***

### VerifyLocale

Defined in: [verify2/lib/enums/verifyLocale.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L4)

Enum representing different locales for verification.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="de_de"></a> `DE_DE` | `"de-de"` | German (Germany) locale. | [verify2/lib/enums/verifyLocale.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L43) |
| <a id="en_gb"></a> `EN_GB` | `"en-gb"` | English (United Kingdom) locale. | [verify2/lib/enums/verifyLocale.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L13) |
| <a id="en_us"></a> `EN_US` | `"en-us"` | English (United States) locale. | [verify2/lib/enums/verifyLocale.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L8) |
| <a id="es_es"></a> `ES_ES` | `"es-es"` | Spanish (Spain) locale. | [verify2/lib/enums/verifyLocale.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L18) |
| <a id="es_mx"></a> `ES_MX` | `"es-mx"` | Spanish (Mexico) locale. | [verify2/lib/enums/verifyLocale.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L23) |
| <a id="es_us"></a> `ES_US` | `"es-us"` | Spanish (United States) locale. | [verify2/lib/enums/verifyLocale.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L28) |
| <a id="fr_fr"></a> `FR_FR` | `"fr-fr"` | French (France) locale. | [verify2/lib/enums/verifyLocale.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L38) |
| <a id="hi_in"></a> `HI_IN` | `"hi-in"` | Hindi (India) locale. | [verify2/lib/enums/verifyLocale.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L53) |
| <a id="id_id"></a> `ID_ID` | `"id-id"` | Indonesian (Indonesia) locale. | [verify2/lib/enums/verifyLocale.ts:68](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L68) |
| <a id="it_it"></a> `IT_IT` | `"it-it"` | Italian (Italy) locale. | [verify2/lib/enums/verifyLocale.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L33) |
| <a id="pt_br"></a> `PT_BR` | `"pt-br"` | Portuguese (Brazil) locale. | [verify2/lib/enums/verifyLocale.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L58) |
| <a id="pt_pt"></a> `PT_PT` | `"pt-pt"` | Portuguese (Portugal) locale. | [verify2/lib/enums/verifyLocale.ts:63](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L63) |
| <a id="ru_ru"></a> `RU_RU` | `"ru-ru"` | Russian (Russia) locale. | [verify2/lib/enums/verifyLocale.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyLocale.ts#L48) |

## Classes

### Verify2

Defined in: [verify2/lib/verify2.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L22)

A class for interacting with the Vonage Verify API (Version 2).

#### Extends

- [`Client`](Vonage-Server-Client.md#client)

#### Constructors

##### Constructor

```ts
new Verify2(credentials, options?): Verify2;
```

Defined in: server-client/dist/lib/client.d.ts:35

Creates a new instance of the Client.

###### Parameters

###### credentials

The authentication credentials or an authentication instance.

[`AuthInterface`](Vonage-Auth.md#authinterface) | [`AuthParams`](Vonage-Auth.md#authparams)

###### options?

[`ConfigParams`](Vonage-Server-Client.md#configparams)

Optional configuration settings for the client.

###### Returns

[`Verify2`](#verify2)

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`constructor`](Vonage-Server-Client.md#client#constructor)

#### Properties

##### auth

```ts
protected auth: AuthInterface;
```

Defined in: server-client/dist/lib/client.d.ts:24

The authentication instance responsible for generating authentication headers and query parameters.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`auth`](Vonage-Server-Client.md#client#auth)

##### authType

```ts
protected authType: AuthenticationType = AuthenticationType.JWT;
```

Defined in: [verify2/lib/verify2.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L26)

The authentication type used for this client (JWT).

###### Overrides

[`Client`](Vonage-Server-Client.md#client).[`authType`](Vonage-Server-Client.md#client#authtype)

##### config

```ts
protected config: ConfigParams;
```

Defined in: server-client/dist/lib/client.d.ts:28

Configuration settings for the client, including default hosts for various services and other request settings.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`config`](Vonage-Server-Client.md#client#config)

##### transformers

```ts
static transformers: object;
```

Defined in: server-client/dist/lib/client.d.ts:11

Static property containing utility transformers.

###### camelCaseObjectKeys

```ts
camelCaseObjectKeys: PartialTransformFunction;
```

###### kebabCaseObjectKeys

```ts
kebabCaseObjectKeys: PartialTransformFunction;
```

###### omit()

```ts
omit: (keys, obj) => TransformedObject;
```

###### Parameters

###### keys

`string`[]

###### obj

[`ObjectToTransform`](Vonage-Server-Client.md#objecttotransform)

###### Returns

[`TransformedObject`](Vonage-Server-Client.md#transformedobject)

###### snakeCaseObjectKeys

```ts
snakeCaseObjectKeys: PartialTransformFunction;
```

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`transformers`](Vonage-Server-Client.md#client#transformers)

#### Methods

##### addAuthenticationToRequest()

```ts
addAuthenticationToRequest(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:43

Adds the appropriate authentication headers or parameters to the request based on the authentication type.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options to which authentication needs to be added.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The request options with the added authentication.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`addAuthenticationToRequest`](Vonage-Server-Client.md#client#addauthenticationtorequest)

##### addBasicAuthToRequest()

```ts
protected addBasicAuthToRequest(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:71

Adds basic authentication headers to the request.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options to which authentication needs to be added.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The request options with the added authentication.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`addBasicAuthToRequest`](Vonage-Server-Client.md#client#addbasicauthtorequest)

##### addJWTToRequest()

```ts
protected addJWTToRequest(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:64

Adds a JWT to the request.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options to which authentication needs to be added.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The request options with the added authentication.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`addJWTToRequest`](Vonage-Server-Client.md#client#addjwttorequest)

##### addQueryKeySecretToRequest()

```ts
protected addQueryKeySecretToRequest(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:57

Adds API key and secret to the request.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options to which authentication needs to be added.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The request options with the added authentication.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequest`](Vonage-Server-Client.md#client#addquerykeysecrettorequest)

##### addQueryKeySecretToRequestBody()

```ts
protected addQueryKeySecretToRequestBody(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:50

Adds API key and secret to the request body.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options to which authentication needs to be added.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The request options with the added authentication.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequestBody`](Vonage-Server-Client.md#client#addquerykeysecrettorequestbody)

##### cancel()

```ts
cancel(requestId): Promise<boolean>;
```

Defined in: [verify2/lib/verify2.ts:69](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L69)

Cancels a verification request.

###### Parameters

###### requestId

`string`

The ID of the verification request to cancel.

###### Returns

`Promise`\<`boolean`\>

`true` if the cancellation was successful.

##### checkCode()

```ts
checkCode(requestId, code): Promise<string>;
```

Defined in: [verify2/lib/verify2.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L53)

Checks a verification code against a verification request.

###### Parameters

###### requestId

`string`

The ID of the verification request.

###### code

`string`

The verification code to check.

###### Returns

`Promise`\<`string`\>

The status of the verification code check.

##### createTemplate()

```ts
createTemplate(template): Promise<Template>;
```

Defined in: [verify2/lib/verify2.ts:182](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L182)

Creates a new template with the provided details.

###### Parameters

###### template

[`Template`](#template)

The template details to be created.

###### Returns

`Promise`\<[`Template`](#template)\>

- A promise resolving to the created template in camelCase format.

###### Example

Create a new template:
```ts
const newTemplate = await templateClient.createTemplate({
  name: 'My New Template',
});
console.log(newTemplate.name);
```

##### createTemplateFragment()

```ts
createTemplateFragment(templateId, fragment): Promise<TemplateFragment>;
```

Defined in: [verify2/lib/verify2.ts:397](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L397)

Creates a new template fragment with the provided details.

###### Parameters

###### templateId

`string`

The unique identifier of the template to which the fragment belongs.

###### fragment

[`TemplateFragment`](#templatefragment)

The details of the template fragment to be created.

###### Returns

`Promise`\<[`TemplateFragment`](#templatefragment)\>

- A promise resolving to the created template fragment in camelCase format.

###### Example

Create a new template fragment:
```ts
const newFragment = await templateClient.createTemplateFragment(
  '22f571c1-f41a-4db2-bba7-f23a069200c1',
  {
    channel: 'sms',
    locale: 'en-us',
    text: 'Your verification code is ${code}',
  },
);
console.log(newFragment.text);
```

##### deleteTemplate()

```ts
deleteTemplate(templateId): Promise<true>;
```

Defined in: [verify2/lib/verify2.ts:227](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L227)

Deletes a template by its unique identifier.

###### Parameters

###### templateId

`string`

The unique identifier of the template to delete.

###### Returns

`Promise`\<`true`\>

- A promise that resolves when the template is successfully deleted.

###### Example

Delete a template by ID:
```ts
await templateClient.deleteTemplate('22f571c1-f41a-4db2-bba7-f23a069200c1');
console.log('Template deleted successfully');
```

##### deleteTemplateFragment()

```ts
deleteTemplateFragment(templateId, fragmentId): Promise<true>;
```

Defined in: [verify2/lib/verify2.ts:430](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L430)

Deletes a template fragment by its unique identifier.

###### Parameters

###### templateId

`string`

The unique identifier of the template to delete.

###### fragmentId

`string`

The unique identifier of the template to delete.

###### Returns

`Promise`\<`true`\>

- A promise that resolves when the template is successfully deleted.

###### Example

Delete a template by ID:
```ts
await templateClient.deleteTemplateFragment(
  '22f571c1-f41a-4db2-bba7-f23a069200c1'
  'c70f446e-997a-4313-a081-60a02a31dc19',
);
console.log('Template Fragment deleted successfully');
```

##### getConfig()

```ts
getConfig(): ConfigParams;
```

Defined in: server-client/dist/lib/client.d.ts:36

###### Returns

[`ConfigParams`](Vonage-Server-Client.md#configparams)

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`getConfig`](Vonage-Server-Client.md#client#getconfig)

##### getTemplate()

```ts
getTemplate(templateId): Promise<Template>;
```

Defined in: [verify2/lib/verify2.ts:206](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L206)

Retrieves a single template by its unique identifier.

###### Parameters

###### templateId

`string`

The unique identifier of the template to retrieve.

###### Returns

`Promise`\<[`Template`](#template)\>

- A promise resolving to the retrieved template in camelCase format.

###### Example

Get a template by ID:
```ts
const template = await templateClient.getTemplate('22f571c1-f41a-4db2-bba7-f23a069200c1');
console.log(template.name);
```

##### getTemplateFragment()

```ts
getTemplateFragment(templateId, fragmentId): Promise<TemplateFragment>;
```

Defined in: [verify2/lib/verify2.ts:364](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L364)

Retrieves a single template fragment by its unique identifier.

###### Parameters

###### templateId

`string`

The unique identifier of the template.

###### fragmentId

`string`

The unique identifier of the template fragment.

###### Returns

`Promise`\<[`TemplateFragment`](#templatefragment)\>

- A promise resolving to the retrieved template fragment in snake_case format.

###### Example

Get a template fragment by ID:
```ts
const fragment = await templateClient.getTemplateFragment('22f571c1-f41a-4db2-bba7-f23a069200c1', 'c70f446e-997a-4313-a081-60a02a31dc19');
console.log(fragment.text);
```

##### getTemplateFragmentPage()

```ts
getTemplateFragmentPage(params): Promise<TemplateFragmentPage>;
```

Defined in: [verify2/lib/verify2.ts:286](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L286)

Retrieves a page of template fragments based on the provided pagination and filter parameters.

###### Parameters

###### params

[`ListAllTemplateFragmentsParams`](#listalltemplatefragmentsparams)

The filter parameters for pagination (e.g., page number, page size, template ID).

###### Returns

`Promise`\<[`TemplateFragmentPage`](#templatefragmentpage)\>

- A promise resolving to a page of template fragments.

###### Example

Get a page of template fragments:
```ts
const fragmentPage = await templateClient.getTemplateFragmentPage({
  templateId: '22f571c1-f41a-4db2-bba7-f23a069200c1',
  page: 1,
  pageSize: 10,
});
fragmentPage._embedded.template_fragments.forEach(fragment => {
  console.log(fragment.text);
});
```

##### getTemplatePage()

```ts
getTemplatePage(params): Promise<TemplatePage>;
```

Defined in: [verify2/lib/verify2.ts:142](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L142)

Retrieves a single page of templates based on the provided pagination parameters.

###### Parameters

###### params

[`ListAllTemplatesParams`](#listalltemplatesparams) = `{}`

The filter parameters for pagination (e.g., page number, page size).

###### Returns

`Promise`\<[`TemplatePage`](#templatepage)\>

- A promise resolving to a page of templates.

###### Example

Get a single page of templates:

```ts
const templatePage = await templateClient.getTemplatePage({
  page: 1,
  pageSize: 10
});

templatePage.templates.forEach(template => {
  console.log(template.name);
});
```

##### listAllTemplateFragments()

```ts
listAllTemplateFragments(params?): AsyncGenerator<TemplateFragment, void, undefined>;
```

Defined in: [verify2/lib/verify2.ts:337](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L337)

Generator function to list all templates across multiple pages.

###### Parameters

###### params?

[`ListAllTemplateFragmentsParams`](#listalltemplatefragmentsparams)

Optional filter parameters, including pagination.

###### Returns

`AsyncGenerator`\<[`TemplateFragment`](#templatefragment), `void`, `undefined`\>

###### Remarks

This will continue calling the API to retrieve all templates until there are no more pages left.
The function yields each template in camelCase format.

###### Yields

- Yields each template object in camelCase format.

###### Examples

List all templates using pagination:
```ts
for await (const template of templateClient.listAllTemplateFragments({ pageSize: 5 })) {
  console.log(template.name);
}
```

List all templates without pagination:
```ts
for await (const template of templateClient.listAllTemplateFragments()) {
  console.log(template.name);
}
```

##### listAllTemplates()

```ts
listAllTemplates(params?): AsyncGenerator<Template, void, undefined>;
```

Defined in: [verify2/lib/verify2.ts:108](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L108)

Generator function to list all templates across multiple pages.

###### Parameters

###### params?

[`ListAllTemplatesParams`](#listalltemplatesparams) = `{}`

Optional filter parameters, including pagination.

###### Returns

`AsyncGenerator`\<[`Template`](#template), `void`, `undefined`\>

###### Remarks

This will continue calling the API to retrieve all templates until there are no more pages left.
The function yields each template in camelCase format.

###### Yields

- Yields each template object in camelCase format.

###### Examples

List all templates using pagination:
```ts
for await (const template of templateClient.listAllTemplates({ pageSize: 5 })) {
  console.log(template.name);
}
```

List all templates without pagination:
```ts
for await (const template of templateClient.listAllTemplates()) {
  console.log(template.name);
}
```

##### newRequest()

```ts
newRequest(params): Promise<Request>;
```

Defined in: [verify2/lib/verify2.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L35)

Creates a new verification request.

###### Parameters

###### params

[`VerificationRequestParams`](#verificationrequestparams)

The parameters for the
 verification request.

###### Returns

`Promise`\<[`Request`](#request)\>

A `Request` object containing the request ID.

##### parseResponse()

```ts
protected parseResponse<T>(request, response): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:168

Parses the response based on its content type.

###### Type Parameters

###### T

`T`

The expected type of the parsed response data.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options.

###### response

`Response`

The raw response from the request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The parsed response.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`parseResponse`](Vonage-Server-Client.md#client#parseresponse)

##### prepareBody()

```ts
protected prepareBody(request): undefined | string;
```

Defined in: server-client/dist/lib/client.d.ts:158

Prepares the body for the request based on the content type.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options.

###### Returns

`undefined` \| `string`

- The prepared request body as a string or undefined.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`prepareBody`](Vonage-Server-Client.md#client#preparebody)

##### prepareRequest()

```ts
protected prepareRequest(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:151

Prepares the request with necessary headers, authentication, and query parameters.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The initial request options.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The modified request options.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`prepareRequest`](Vonage-Server-Client.md#client#preparerequest)

##### sendDeleteRequest()

```ts
sendDeleteRequest<T>(url): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:78

Sends a DELETE request to the specified URL.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the DELETE request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the DELETE request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendDeleteRequest`](Vonage-Server-Client.md#client#senddeleterequest)

##### sendFormSubmitRequest()

```ts
sendFormSubmitRequest<T>(url, payload?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:86

Sends a POST request with form data to the specified URL.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the POST request.

###### payload?

`Record`\<`string`, `undefined` \| `string`\>

Optional payload containing form data to send with the POST request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the POST request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendFormSubmitRequest`](Vonage-Server-Client.md#client#sendformsubmitrequest)

##### sendGetRequest()

```ts
sendGetRequest<T>(url, queryParams?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:94

Sends a GET request to the specified URL with optional query parameters.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the GET request.

###### queryParams?

Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the GET request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendGetRequest`](Vonage-Server-Client.md#client#sendgetrequest)

##### sendPatchRequest()

```ts
sendPatchRequest<T>(url, payload?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:104

Sends a PATCH request to the specified URL with an optional payload.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the PATCH request.

###### payload?

Optional payload to be sent as the body of the PATCH request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the PATCH request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendPatchRequest`](Vonage-Server-Client.md#client#sendpatchrequest)

##### sendPostRequest()

```ts
sendPostRequest<T>(url, payload?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:114

Sends a POST request to the specified URL with an optional payload.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the POST request.

###### payload?

Optional payload to be sent as the body of the POST request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the POST request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendPostRequest`](Vonage-Server-Client.md#client#sendpostrequest)

##### sendPutRequest()

```ts
sendPutRequest<T>(url, payload?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:124

Sends a PUT request to the specified URL with an optional payload.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the PUT request.

###### payload?

Optional payload to be sent as the body of the PUT request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the PUT request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendPutRequest`](Vonage-Server-Client.md#client#sendputrequest)

##### sendRequest()

```ts
sendRequest<T>(request): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:144

Sends a request adding necessary headers, handling authentication, and parsing the response.

###### Type Parameters

###### T

`T`

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The options defining the request, including URL, method, headers, and data.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The parsed response from the request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendRequest`](Vonage-Server-Client.md#client#sendrequest)

##### sendRequestWithData()

```ts
sendRequestWithData<T>(
   method, 
   url, 
payload?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:135

Sends a request with JSON-encoded data to the specified URL using the provided HTTP method.

###### Type Parameters

###### T

`T`

###### Parameters

###### method

The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable).

[`POST`](Vonage-Vetch.md#httpmethods#post) | [`PUT`](Vonage-Vetch.md#httpmethods#put) | [`PATCH`](Vonage-Vetch.md#httpmethods#patch)

###### url

`string`

The URL endpoint for the request.

###### payload?

Optional payload to be sent as the body of the request, JSON-encoded.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendRequestWithData`](Vonage-Server-Client.md#client#sendrequestwithdata)

##### updateTemplate()

```ts
updateTemplate(template): Promise<Template>;
```

Defined in: [verify2/lib/verify2.ts:251](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L251)

Updates an existing template with the provided details.

###### Parameters

###### template

[`Template`](#template)

The full template object with updated details. The template must include its ID.

###### Returns

`Promise`\<[`Template`](#template)\>

- A promise resolving to the updated template in camelCase format.

###### Example

Update a template:
```ts
const updatedTemplate = await templateClient.updateTemplate({
  templateId: '22f571c1-f41a-4db2-bba7-f23a069200c1',
  name: 'Updated Template Name',
  isDefault: false,
});
console.log(updatedTemplate.name);
```

##### updateTemplateFragment()

```ts
updateTemplateFragment(templateId, fragment): Promise<Template>;
```

Defined in: [verify2/lib/verify2.ts:461](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/verify2.ts#L461)

Updates an existing template with the provided details.

###### Parameters

###### templateId

`string`

The ID of the template this fragment belongs to.

###### fragment

[`TemplateFragment`](#templatefragment)

The full template fragment object with updated details.

###### Returns

`Promise`\<[`Template`](#template)\>

- A promise resolving to the updated template fragment in camelCase format.

###### Example

Update a template:
```ts
const updatedTemplateFragment = await templateClient.updateTemplateFragment(
 '22f571c1-f41a-4db2-bba7-f23a069200c1',
  {
    templateId: '22f571c1-f41a-4db2-bba7-f23a069200c1',
    name: 'Updated Template Name',
    isDefault: false,
  }
);
console.log(updatedTemplateFragment.name);
```

## Interfaces

### ListAllTemplatesParams

Defined in: [verify2/lib/types/params/listAllTemplateParams.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/listAllTemplateParams.ts#L4)

Query parameters for listing all templates in the Verify API.

#### Properties

##### page?

```ts
optional page: number;
```

Defined in: [verify2/lib/types/params/listAllTemplateParams.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/listAllTemplateParams.ts#L15)

The page number to retrieve.

###### Example

```ts
2
```

##### pageSize?

```ts
optional pageSize: number;
```

Defined in: [verify2/lib/types/params/listAllTemplateParams.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/listAllTemplateParams.ts#L9)

The number of templates to return per page.

###### Example

```ts
10
```

## Type Aliases

### CheckCodeRequest

```ts
type CheckCodeRequest = object;
```

Defined in: [verify2/lib/types/requests/checkCodeRequest.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/checkCodeRequest.ts#L4)

Represents a request to check a code against a verification request.

#### Properties

##### code

```ts
code: string;
```

Defined in: [verify2/lib/types/requests/checkCodeRequest.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/checkCodeRequest.ts#L8)

The code to be checked against the verification request.

***

### CheckRequestResponse

```ts
type CheckRequestResponse = object;
```

Defined in: [verify2/lib/types/responses/checkRequestResponse.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/checkRequestResponse.ts#L4)

Represents the response for checking a code against a verification request.

#### Properties

##### request\_id

```ts
request_id: string;
```

Defined in: [verify2/lib/types/responses/checkRequestResponse.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/checkRequestResponse.ts#L8)

The ID of the verification request.

##### status

```ts
status: string;
```

Defined in: [verify2/lib/types/responses/checkRequestResponse.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/checkRequestResponse.ts#L13)

The status of the verification request.

***

### CreateTemplateFragmentRequest

```ts
type CreateTemplateFragmentRequest = object;
```

Defined in: [verify2/lib/types/requests/createTemplateFragmentRequest.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/createTemplateFragmentRequest.ts#L4)

Represents the request body for creating a template fragment.

#### Properties

##### channel

```ts
channel: "sms" | "voice";
```

Defined in: [verify2/lib/types/requests/createTemplateFragmentRequest.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/createTemplateFragmentRequest.ts#L9)

The communication channel for the fragment (e.g., sms, voice, email).

###### Example

```ts
"sms"
```

##### locale

```ts
locale: string;
```

Defined in: [verify2/lib/types/requests/createTemplateFragmentRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/createTemplateFragmentRequest.ts#L15)

Locale in IETF BCP 47 format.

###### Example

```ts
"en-us"
```

##### text

```ts
text: string;
```

Defined in: [verify2/lib/types/requests/createTemplateFragmentRequest.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/createTemplateFragmentRequest.ts#L21)

Text content of the template fragment.

###### Example

```ts
"Text content of the template. May contain 4 reserved variables: `${code}`, `${brand}`, `${time-limit}` and `${time-limit-unit}`"
```

***

### EmailWorkflow

```ts
type EmailWorkflow = object;
```

Defined in: [verify2/lib/types/workflows/emailWorkflow.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/emailWorkflow.ts#L6)

Represents a workflow for sending a verification code via email.

#### Properties

##### channel

```ts
channel: EMAIL;
```

Defined in: [verify2/lib/types/workflows/emailWorkflow.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/emailWorkflow.ts#L10)

The communication channel for sending the verification code.

##### from?

```ts
optional from: string;
```

Defined in: [verify2/lib/types/workflows/emailWorkflow.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/emailWorkflow.ts#L20)

(Optional) The sender's email address for the verification email.

##### to

```ts
to: string;
```

Defined in: [verify2/lib/types/workflows/emailWorkflow.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/emailWorkflow.ts#L15)

The recipient's email address where the verification code will be sent.

***

### EventCallback

```ts
type EventCallback = object;
```

Defined in: [verify2/lib/types/eventCallback.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/eventCallback.ts#L6)

Represents an event callback received for a verification request.

#### Properties

##### channel

```ts
channel: Channels;
```

Defined in: [verify2/lib/types/eventCallback.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/eventCallback.ts#L25)

The communication channel for the verification request.

##### client\_ref?

```ts
optional client_ref: string;
```

Defined in: [verify2/lib/types/eventCallback.ts:41](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/eventCallback.ts#L41)

(Optional) The client reference given in the original Verify request.

##### finalized\_at

```ts
finalized_at: string;
```

Defined in: [verify2/lib/types/eventCallback.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/eventCallback.ts#L36)

The date and time when the verification request was completed
in ISO 8601 format.

##### request\_id

```ts
request_id: string;
```

Defined in: [verify2/lib/types/eventCallback.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/eventCallback.ts#L10)

The ID of the verification request associated with the event.

##### status

```ts
status: EventStatus;
```

Defined in: [verify2/lib/types/eventCallback.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/eventCallback.ts#L30)

The status of the event.

##### triggered\_at

```ts
triggered_at: string;
```

Defined in: [verify2/lib/types/eventCallback.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/eventCallback.ts#L15)

The date and time when the event was triggered in ISO 8601 format.

##### type

```ts
type: string;
```

Defined in: [verify2/lib/types/eventCallback.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/eventCallback.ts#L20)

The type of response for the event.

***

### ListAllTemplateFragmentsParams

```ts
type ListAllTemplateFragmentsParams = object & ListAllTemplatesParams;
```

Defined in: [verify2/lib/types/params/listAllTemplateFragmentsParams.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/listAllTemplateFragmentsParams.ts#L6)

Query parameters for listing all template fragments, including pagination.

#### Type declaration

##### templateId

```ts
templateId: string;
```

The template ID to retrieve fragments for.

###### Example

```ts
"22f571c1-f41a-4db2-bba7-f23a069200c1"
```

***

### ListAllTemplateFragmentsResponse

```ts
type ListAllTemplateFragmentsResponse = object;
```

Defined in: [verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts#L7)

The response when listing all template fragments, including pagination.

#### Properties

##### \_embedded

```ts
_embedded: object;
```

Defined in: [verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts#L35)

The list of template fragments.

###### template\_fragments

```ts
template_fragments: TemplateFragmentResponse[];
```

##### \_links

```ts
_links: APILinks["_links"];
```

Defined in: [verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts#L42)

Pagination links in HAL format.

##### page

```ts
page: number;
```

Defined in: [verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts#L18)

The current page number.

###### Example

```ts
2
```

##### page\_size

```ts
page_size: number;
```

Defined in: [verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts#L12)

The number of fragments returned in the current page.

###### Example

```ts
10
```

##### total\_items

```ts
total_items: number;
```

Defined in: [verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts#L30)

Total number of template fragments available.

###### Example

```ts
25
```

##### total\_pages

```ts
total_pages: number;
```

Defined in: [verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplateFragmentsResponse.ts#L24)

Total number of pages available.

###### Example

```ts
5
```

***

### ListAllTemplatesResponse

```ts
type ListAllTemplatesResponse = object;
```

Defined in: [verify2/lib/types/responses/listAllTemplatesResponse.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplatesResponse.ts#L8)

The response when listing all templates, including pagination.

#### Properties

##### \_embedded

```ts
_embedded: object;
```

Defined in: [verify2/lib/types/responses/listAllTemplatesResponse.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplatesResponse.ts#L36)

The list of templates.

###### templates

```ts
templates: TemplateResponse[];
```

##### \_links

```ts
_links: APILinks["_links"];
```

Defined in: [verify2/lib/types/responses/listAllTemplatesResponse.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplatesResponse.ts#L43)

Pagination links in HAL format.

##### page

```ts
page: number;
```

Defined in: [verify2/lib/types/responses/listAllTemplatesResponse.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplatesResponse.ts#L19)

The current page number.

###### Example

```ts
2
```

##### page\_size

```ts
page_size: number;
```

Defined in: [verify2/lib/types/responses/listAllTemplatesResponse.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplatesResponse.ts#L13)

The number of templates returned in the current page.

###### Example

```ts
1
```

##### templates

```ts
templates: Template[];
```

Defined in: [verify2/lib/types/responses/listAllTemplatesResponse.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplatesResponse.ts#L48)

The list of templates transformed into the SDK format.

##### total\_items

```ts
total_items: number;
```

Defined in: [verify2/lib/types/responses/listAllTemplatesResponse.ts:31](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplatesResponse.ts#L31)

Total number of templates available.

###### Example

```ts
25
```

##### total\_pages

```ts
total_pages: number;
```

Defined in: [verify2/lib/types/responses/listAllTemplatesResponse.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/listAllTemplatesResponse.ts#L25)

Total number of pages available.

###### Example

```ts
10
```

***

### Request

```ts
type Request = object;
```

Defined in: [verify2/lib/types/request.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/request.ts#L4)

Represents a request object with a unique request ID.

#### Properties

##### checkUrl?

```ts
optional checkUrl: string;
```

Defined in: [verify2/lib/types/request.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/request.ts#L13)

The URL to check the status of the request.

##### requestId

```ts
requestId: string;
```

Defined in: [verify2/lib/types/request.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/request.ts#L8)

The unique identifier for the request.

***

### RequestStatusCallback

```ts
type RequestStatusCallback = object;
```

Defined in: [verify2/lib/types/requestStatusCallback.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requestStatusCallback.ts#L8)

Represents a callback received for the status update of a
verification request.

#### Properties

##### channel\_timeout

```ts
channel_timeout: number;
```

Defined in: [verify2/lib/types/requestStatusCallback.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requestStatusCallback.ts#L34)

The number of seconds before the current step in the verification
request times out.

##### request\_id

```ts
request_id: string;
```

Defined in: [verify2/lib/types/requestStatusCallback.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requestStatusCallback.ts#L12)

The ID of the verification request associated with the callback.

##### status

```ts
status: RequestStatus;
```

Defined in: [verify2/lib/types/requestStatusCallback.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requestStatusCallback.ts#L23)

The status of the verification request.

##### submitted\_at

```ts
submitted_at: string;
```

Defined in: [verify2/lib/types/requestStatusCallback.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requestStatusCallback.ts#L18)

The date and time when the verification request was submitted
in ISO 8601 format.

##### type

```ts
type: string;
```

Defined in: [verify2/lib/types/requestStatusCallback.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requestStatusCallback.ts#L28)

The type of response for the callback.

##### workflow

```ts
workflow: RequestStatusCallbackWorkflow[];
```

Defined in: [verify2/lib/types/requestStatusCallback.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requestStatusCallback.ts#L39)

An array of workflow details for the verification request.

***

### RequestStatusCallbackWorkflow

```ts
type RequestStatusCallbackWorkflow = object;
```

Defined in: [verify2/lib/types/workflows/requestStatusCallbackWorkflow.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/requestStatusCallbackWorkflow.ts#L6)

Represents a workflow step within a verification request's status callback.

#### Properties

##### channel

```ts
channel: Channels;
```

Defined in: [verify2/lib/types/workflows/requestStatusCallbackWorkflow.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/requestStatusCallbackWorkflow.ts#L10)

The communication channel associated with this workflow step.

##### initiated\_at

```ts
initiated_at: string;
```

Defined in: [verify2/lib/types/workflows/requestStatusCallbackWorkflow.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/requestStatusCallbackWorkflow.ts#L15)

The date and time when this workflow step was initiated in ISO 8601 format.

##### status

```ts
status: RequestWorkflowStatus;
```

Defined in: [verify2/lib/types/workflows/requestStatusCallbackWorkflow.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/requestStatusCallbackWorkflow.ts#L20)

The status of this workflow step within the verification request.

***

### SilentAuthCallback

```ts
type SilentAuthCallback = object;
```

Defined in: [verify2/lib/types/silentAuthCallback.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/silentAuthCallback.ts#L6)

Represents a callback received for Silent Authentication.

#### Properties

##### action

```ts
action: object;
```

Defined in: [verify2/lib/types/silentAuthCallback.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/silentAuthCallback.ts#L36)

Information about the action in the Silent Authentication event.

###### check\_url

```ts
check_url: string;
```

The URL for Silent Authentication Verify workflow completion.

###### type

```ts
type: "check";
```

The type of action, which is 'check' for Silent Authentication.

##### channel

```ts
channel: SILENT_AUTH;
```

Defined in: [verify2/lib/types/silentAuthCallback.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/silentAuthCallback.ts#L26)

The communication channel for Silent Authentication (always 'silent_auth').

##### request\_id

```ts
request_id: string;
```

Defined in: [verify2/lib/types/silentAuthCallback.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/silentAuthCallback.ts#L10)

The ID of the Silent Authentication request associated with the callback.

##### status

```ts
status: SilentAuthStatus;
```

Defined in: [verify2/lib/types/silentAuthCallback.ts:31](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/silentAuthCallback.ts#L31)

The status of the Silent Authentication event.

##### triggered\_at

```ts
triggered_at: string;
```

Defined in: [verify2/lib/types/silentAuthCallback.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/silentAuthCallback.ts#L16)

The date and time when the Silent Authentication event was triggered
in ISO 8601 format.

##### type

```ts
type: string;
```

Defined in: [verify2/lib/types/silentAuthCallback.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/silentAuthCallback.ts#L21)

The type of response for the Silent Authentication event.

***

### SilentAuthWorkflow

```ts
type SilentAuthWorkflow = object;
```

Defined in: [verify2/lib/types/workflows/silentAuthWorkflow.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/silentAuthWorkflow.ts#L6)

Represents a workflow for Silent Authentication.

#### Properties

##### channel

```ts
channel: SilentAuthChannel;
```

Defined in: [verify2/lib/types/workflows/silentAuthWorkflow.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/silentAuthWorkflow.ts#L10)

The communication channel for Silent Authentication.

##### redirectUrl

```ts
redirectUrl: string;
```

Defined in: [verify2/lib/types/workflows/silentAuthWorkflow.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/silentAuthWorkflow.ts#L20)

The redirect URL for Silent Authentication.

##### to

```ts
to: string;
```

Defined in: [verify2/lib/types/workflows/silentAuthWorkflow.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/silentAuthWorkflow.ts#L15)

The target identifier for Silent Authentication.

***

### SilentAuthWorkflowRequest

```ts
type SilentAuthWorkflowRequest = object & Omit<SilentAuthWorkflow, "redirectUrl">;
```

Defined in: [verify2/lib/types/requests/verificationRequest.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/verificationRequest.ts#L19)

#### Type declaration

##### redirect\_url

```ts
redirect_url: string;
```

***

### SMSWorkflow

```ts
type SMSWorkflow = object;
```

Defined in: [verify2/lib/types/workflows/smsWorkflow.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/smsWorkflow.ts#L6)

Represents a workflow for sending a verification code via SMS.

#### Properties

##### appHash?

```ts
optional appHash: string;
```

Defined in: [verify2/lib/types/workflows/smsWorkflow.ts:41](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/smsWorkflow.ts#L41)

(Optional) An application-specific hash value for the SMS workflow.

##### channel

```ts
channel: SMS;
```

Defined in: [verify2/lib/types/workflows/smsWorkflow.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/smsWorkflow.ts#L10)

The communication channel for sending the verification code.

##### contentId?

```ts
optional contentId: string;
```

Defined in: [verify2/lib/types/workflows/smsWorkflow.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/smsWorkflow.ts#L36)

Optional value corresponding to a TemplateID for SMS delivery using Indian Carriers

##### entityId?

```ts
optional entityId: string;
```

Defined in: [verify2/lib/types/workflows/smsWorkflow.ts:31](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/smsWorkflow.ts#L31)

Optional PEID required for SMS delivery using Indian Carriers

##### from?

```ts
optional from: string;
```

Defined in: [verify2/lib/types/workflows/smsWorkflow.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/smsWorkflow.ts#L26)

An optional sender number, in the E.164 format.
Don't use a leading + or 00 when entering a phone number, start with the
country code, for example, 447700900000.

###### Remarks

If no from number is given, the request will default to the brand.

##### to

```ts
to: string;
```

Defined in: [verify2/lib/types/workflows/smsWorkflow.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/smsWorkflow.ts#L16)

The recipient's phone number where the verification code will be sent,
in the E.164 format.

***

### SMSWorkflowRequest

```ts
type SMSWorkflowRequest = object & Omit<SMSWorkflow, "appHash">;
```

Defined in: [verify2/lib/types/requests/verificationRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/verificationRequest.ts#L11)

#### Type declaration

##### app\_hash?

```ts
optional app_hash: string;
```

##### content\_id?

```ts
optional content_id: string;
```

##### entity\_id?

```ts
optional entity_id: string;
```

***

### Template

```ts
type Template = object;
```

Defined in: [verify2/lib/types/template.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/template.ts#L4)

Represents a value object for a template, converted to camelCase, without _links.

#### Properties

##### isDefault

```ts
isDefault: boolean;
```

Defined in: [verify2/lib/types/template.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/template.ts#L21)

Indicates whether this is the default template.

###### Example

```ts
true
```

##### name

```ts
name: string;
```

Defined in: [verify2/lib/types/template.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/template.ts#L15)

The name of the template.

###### Example

```ts
"my-template"
```

##### templateId

```ts
templateId: string;
```

Defined in: [verify2/lib/types/template.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/template.ts#L9)

Unique identifier for the template.

###### Example

```ts
"8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9"
```

***

### TemplateFragment

```ts
type TemplateFragment = object;
```

Defined in: [verify2/lib/types/templateFragment.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragment.ts#L4)

Represents a template fragment

#### Properties

##### channel

```ts
channel: "sms" | "voice";
```

Defined in: [verify2/lib/types/templateFragment.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragment.ts#L15)

The communication channel for the fragment (e.g., sms, voice).

###### Example

```ts
"sms"
```

##### dateCreated

```ts
dateCreated: string;
```

Defined in: [verify2/lib/types/templateFragment.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragment.ts#L39)

The date when the template fragment was created, in ISO 8601 format.

###### Example

```ts
"2021-08-30T20:12:15.17865735Z"
```

##### dateUpdated

```ts
dateUpdated: string;
```

Defined in: [verify2/lib/types/templateFragment.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragment.ts#L33)

The date when the template fragment was last updated, in ISO 8601 format.

###### Example

```ts
"2023-08-30T15:20:15.17865735Z"
```

##### locale

```ts
locale: string;
```

Defined in: [verify2/lib/types/templateFragment.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragment.ts#L21)

Locale in IETF BCP 47 format.

###### Example

```ts
"en-us"
```

##### templateFragmentId

```ts
templateFragmentId: string;
```

Defined in: [verify2/lib/types/templateFragment.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragment.ts#L9)

Unique identifier for the template fragment.

###### Example

```ts
"c70f446e-997a-4313-a081-60a02a31dc19"
```

##### text

```ts
text: string;
```

Defined in: [verify2/lib/types/templateFragment.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragment.ts#L27)

Text content of the template fragment.

###### Example

```ts
"Text content of the template. May contain 4 reserved variables: `${code}`, `${brand}`, `${time-limit}` and `${time-limit-unit}`"
```

***

### TemplateFragmentPage

```ts
type TemplateFragmentPage = object;
```

Defined in: [verify2/lib/types/templateFragmentPage.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragmentPage.ts#L7)

Value object for a page of template fragments, with camelCase properties.

#### Properties

##### fragments

```ts
fragments: TemplateFragment[];
```

Defined in: [verify2/lib/types/templateFragmentPage.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragmentPage.ts#L35)

The list of template fragments.

##### links?

```ts
optional links: Record<string, APILink>;
```

Defined in: [verify2/lib/types/templateFragmentPage.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragmentPage.ts#L40)

The set of links for the current page.

##### page

```ts
page: number;
```

Defined in: [verify2/lib/types/templateFragmentPage.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragmentPage.ts#L18)

The current page number.

###### Example

```ts
2
```

##### pageSize

```ts
pageSize: number;
```

Defined in: [verify2/lib/types/templateFragmentPage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragmentPage.ts#L12)

The number of fragments returned in the current page.

###### Example

```ts
10
```

##### totalItems

```ts
totalItems: number;
```

Defined in: [verify2/lib/types/templateFragmentPage.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragmentPage.ts#L30)

Total number of template fragments available.

###### Example

```ts
25
```

##### totalPages

```ts
totalPages: number;
```

Defined in: [verify2/lib/types/templateFragmentPage.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templateFragmentPage.ts#L24)

Total number of pages available.

###### Example

```ts
5
```

***

### TemplateFragmentResponse

```ts
type TemplateFragmentResponse = object;
```

Defined in: [verify2/lib/types/responses/templateFragmentResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateFragmentResponse.ts#L6)

Represents the response when retrieving a template fragment.

#### Properties

##### \_links

```ts
_links: object;
```

Defined in: [verify2/lib/types/responses/templateFragmentResponse.ts:46](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateFragmentResponse.ts#L46)

HAL format links related to the template fragment.

###### self

```ts
self: APILink;
```

A link to the template fragment itself.

###### template

```ts
template: APILink;
```

A link to the parent template this fragment belongs to.

##### channel

```ts
channel: "sms" | "voice";
```

Defined in: [verify2/lib/types/responses/templateFragmentResponse.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateFragmentResponse.ts#L17)

The communication channel for the fragment (e.g., sms, voice, email).

###### Example

```ts
"sms"
```

##### date\_created

```ts
date_created: string;
```

Defined in: [verify2/lib/types/responses/templateFragmentResponse.ts:41](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateFragmentResponse.ts#L41)

The date when the template fragment was created, in ISO 8601 format.

###### Example

```ts
"2021-08-30T20:12:15.17865735Z"
```

##### date\_updated

```ts
date_updated: string;
```

Defined in: [verify2/lib/types/responses/templateFragmentResponse.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateFragmentResponse.ts#L35)

The date when the template fragment was last updated, in ISO 8601 format.

###### Example

```ts
"2023-08-30T15:20:15.17865735Z"
```

##### locale

```ts
locale: string;
```

Defined in: [verify2/lib/types/responses/templateFragmentResponse.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateFragmentResponse.ts#L23)

Locale in IETF BCP 47 format.

###### Example

```ts
"en-us"
```

##### template\_fragment\_id

```ts
template_fragment_id: string;
```

Defined in: [verify2/lib/types/responses/templateFragmentResponse.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateFragmentResponse.ts#L11)

Unique identifier for the template fragment.

###### Example

```ts
"c70f446e-997a-4313-a081-60a02a31dc19"
```

##### text

```ts
text: string;
```

Defined in: [verify2/lib/types/responses/templateFragmentResponse.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateFragmentResponse.ts#L29)

Text content of the template fragment.

###### Example

```ts
"Text content of the template. May contain 4 reserved variables: `${code}`, `${brand}`, `${time-limit}` and `${time-limit-unit}`"
```

***

### TemplatePage

```ts
type TemplatePage = object;
```

Defined in: [verify2/lib/types/templatePage.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templatePage.ts#L7)

Value object for a page of templates with camelCase properties.

#### Properties

##### links?

```ts
optional links: Record<string, APILink>;
```

Defined in: [verify2/lib/types/templatePage.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templatePage.ts#L40)

The set of links for the current page.

##### page

```ts
page: number;
```

Defined in: [verify2/lib/types/templatePage.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templatePage.ts#L18)

The current page number.

###### Example

```ts
2
```

##### pageSize

```ts
pageSize: number;
```

Defined in: [verify2/lib/types/templatePage.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templatePage.ts#L12)

The number of templates returned in the current page.

###### Example

```ts
10
```

##### templates

```ts
templates: Template[];
```

Defined in: [verify2/lib/types/templatePage.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templatePage.ts#L35)

The list of templates.

##### totalItems

```ts
totalItems: number;
```

Defined in: [verify2/lib/types/templatePage.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templatePage.ts#L30)

Total number of template available.

###### Example

```ts
25
```

##### totalPages

```ts
totalPages: number;
```

Defined in: [verify2/lib/types/templatePage.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/templatePage.ts#L24)

Total number of pages available.

###### Example

```ts
5
```

***

### TemplateResponse

```ts
type TemplateResponse = object;
```

Defined in: [verify2/lib/types/responses/templateResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateResponse.ts#L6)

Represents a single template in the Verify API response.

#### Properties

##### \_links

```ts
_links: object;
```

Defined in: [verify2/lib/types/responses/templateResponse.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateResponse.ts#L28)

HAL format links related to the template.

###### fragments

```ts
fragments: APILink;
```

A link to the template fragments associated with this template.

###### self

```ts
self: APILink;
```

A link to the template itself.

##### is\_default

```ts
is_default: boolean;
```

Defined in: [verify2/lib/types/responses/templateResponse.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateResponse.ts#L23)

Indicates whether this is the default template.

###### Example

```ts
true
```

##### name

```ts
name: string;
```

Defined in: [verify2/lib/types/responses/templateResponse.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateResponse.ts#L17)

The name of the template.

###### Example

```ts
"my-template"
```

##### template\_id

```ts
template_id: string;
```

Defined in: [verify2/lib/types/responses/templateResponse.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/templateResponse.ts#L11)

Unique identifier for the template.

###### Example

```ts
"8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9"
```

***

### VerificationRequest

```ts
type VerificationRequest = object;
```

Defined in: [verify2/lib/types/requests/verificationRequest.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/verificationRequest.ts#L26)

Represents a verification request for sending verification codes via
different communication channels.

#### Properties

##### brand

```ts
brand: string;
```

Defined in: [verify2/lib/types/requests/verificationRequest.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/verificationRequest.ts#L30)

The brand associated with the verification request.

##### channel\_timeout?

```ts
optional channel_timeout: number;
```

Defined in: [verify2/lib/types/requests/verificationRequest.ts:59](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/verificationRequest.ts#L59)

(Optional) The timeout duration for the verification channel in seconds.

##### client\_ref?

```ts
optional client_ref: string;
```

Defined in: [verify2/lib/types/requests/verificationRequest.ts:64](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/verificationRequest.ts#L64)

(Optional) The client reference associated with the verification request.

##### code?

```ts
optional code: string;
```

Defined in: [verify2/lib/types/requests/verificationRequest.ts:49](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/verificationRequest.ts#L49)

(Optional) The verification code to be sent.

##### code\_length?

```ts
optional code_length: 4 | 5 | 6 | 7 | 8 | 9 | 10;
```

Defined in: [verify2/lib/types/requests/verificationRequest.ts:70](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/verificationRequest.ts#L70)

(Optional) The length of the verification code, if not provided,
defaults to 4 digits.

##### fraud\_check?

```ts
optional fraud_check: boolean;
```

Defined in: [verify2/lib/types/requests/verificationRequest.ts:76](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/verificationRequest.ts#L76)

(Optional) Indicates whether fraud checking is enabled for the
verification request.

##### locale?

```ts
optional locale: VerifyLocale | string;
```

Defined in: [verify2/lib/types/requests/verificationRequest.ts:54](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/verificationRequest.ts#L54)

(Optional) The locale for the verification request.

##### workflow

```ts
workflow: (
  | EmailWorkflow
  | SMSWorkflowRequest
  | SilentAuthWorkflowRequest
  | VoiceWorkflow
  | WhatsAppInteractiveWorkflow
  | WhatsAppWorkflow)[];
```

Defined in: [verify2/lib/types/requests/verificationRequest.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/requests/verificationRequest.ts#L37)

An array of workflow configurations for sending verification codes via
different channels. Each element in the array corresponds to a specific
channel workflow.

***

### VerificationRequestParams

```ts
type VerificationRequestParams = object;
```

Defined in: [verify2/lib/types/params/verifcationRequestParams.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/verifcationRequestParams.ts#L15)

Represents parameters for creating a verification request for sending
verification codes via different communication channels.

#### Properties

##### brand

```ts
brand: string;
```

Defined in: [verify2/lib/types/params/verifcationRequestParams.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/verifcationRequestParams.ts#L19)

The brand associated with the verification request.

##### channelTimeout?

```ts
optional channelTimeout: number;
```

Defined in: [verify2/lib/types/params/verifcationRequestParams.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/verifcationRequestParams.ts#L48)

(Optional) The timeout duration for the verification channel in seconds.

##### clientRef?

```ts
optional clientRef: string;
```

Defined in: [verify2/lib/types/params/verifcationRequestParams.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/verifcationRequestParams.ts#L53)

(Optional) The client reference associated with the verification request.

##### code?

```ts
optional code: string;
```

Defined in: [verify2/lib/types/params/verifcationRequestParams.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/verifcationRequestParams.ts#L38)

(Optional) The verification code to be sent.

##### codeLength?

```ts
optional codeLength: 4 | 5 | 6 | 7 | 8 | 9 | 10;
```

Defined in: [verify2/lib/types/params/verifcationRequestParams.ts:59](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/verifcationRequestParams.ts#L59)

(Optional) The length of the verification code, if not provided,
defaults to 4 digits.

##### fraudCheck?

```ts
optional fraudCheck: boolean;
```

Defined in: [verify2/lib/types/params/verifcationRequestParams.ts:65](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/verifcationRequestParams.ts#L65)

(Optional) Indicates whether fraud checking is enabled for the
verification request.

##### locale?

```ts
optional locale: VerifyLocale | string;
```

Defined in: [verify2/lib/types/params/verifcationRequestParams.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/verifcationRequestParams.ts#L43)

(Optional) The locale for the verification request.

##### templateId?

```ts
optional templateId: string;
```

Defined in: [verify2/lib/types/params/verifcationRequestParams.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/verifcationRequestParams.ts#L73)

A custom template ID to use for the verification request.

###### Remarks

Only voice and sms workflows support custom templates.

##### workflow

```ts
workflow: (
  | EmailWorkflow
  | SMSWorkflow
  | SilentAuthWorkflow
  | VoiceWorkflow
  | WhatsAppInteractiveWorkflow
  | WhatsAppWorkflow)[];
```

Defined in: [verify2/lib/types/params/verifcationRequestParams.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/params/verifcationRequestParams.ts#L26)

An array of workflow configurations for sending verification codes via
different channels. Each element in the array corresponds to a specific
channel workflow.

***

### VerificationResponse

```ts
type VerificationResponse = object;
```

Defined in: [verify2/lib/types/responses/verificationResponse.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/verificationResponse.ts#L4)

Represents a response for a verification request.

#### Properties

##### check\_url?

```ts
optional check_url: string;
```

Defined in: [verify2/lib/types/responses/verificationResponse.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/verificationResponse.ts#L13)

The URL for checking the status of the verification request.

##### request\_id

```ts
request_id: string;
```

Defined in: [verify2/lib/types/responses/verificationResponse.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/responses/verificationResponse.ts#L8)

The unique identifier for the verification request.

***

### VerifyErrors

```ts
type VerifyErrors = object & GenericErrors;
```

Defined in: [verify2/lib/enums/verifyErrors.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/enums/verifyErrors.ts#L6)

Type representing possible errors related to verification requests.

#### Type declaration

##### CONFLICT

```ts
CONFLICT: "conflict";
```

Indicates a conflict error in the verification request.

##### EXPIRED

```ts
EXPIRED: "expired";
```

Indicates that the verification request has expired.

***

### VoiceWorkflow

```ts
type VoiceWorkflow = object;
```

Defined in: [verify2/lib/types/workflows/voiceWorkflow.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/voiceWorkflow.ts#L6)

Represents a workflow for sending a verification code via voice call.

#### Properties

##### channel

```ts
channel: VOICE;
```

Defined in: [verify2/lib/types/workflows/voiceWorkflow.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/voiceWorkflow.ts#L10)

The communication channel for sending the verification code.

##### to

```ts
to: string;
```

Defined in: [verify2/lib/types/workflows/voiceWorkflow.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/voiceWorkflow.ts#L16)

The recipient's phone number where the verification code will be sent,
in the E.164 format.

***

### WhatsAppInteractiveWorkflow

```ts
type WhatsAppInteractiveWorkflow = object;
```

Defined in: [verify2/lib/types/workflows/whatsAppInteractiveWorkflow.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/whatsAppInteractiveWorkflow.ts#L7)

Represents a workflow for sending a verification code via interactive
WhatsApp.

#### Properties

##### channel

```ts
channel: WHATSAPP_INTERACTIVE;
```

Defined in: [verify2/lib/types/workflows/whatsAppInteractiveWorkflow.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/whatsAppInteractiveWorkflow.ts#L11)

The communication channel for sending the verification code.

##### to

```ts
to: string;
```

Defined in: [verify2/lib/types/workflows/whatsAppInteractiveWorkflow.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/whatsAppInteractiveWorkflow.ts#L17)

The recipient's phone number where the verification code will be sent,
typically in the E.164 format.

***

### WhatsAppWorkflow

```ts
type WhatsAppWorkflow = object;
```

Defined in: [verify2/lib/types/workflows/whatsAppWorkflow.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/whatsAppWorkflow.ts#L6)

Represents a workflow for sending a verification code via WhatsApp.

#### Properties

##### channel

```ts
channel: WHATSAPP;
```

Defined in: [verify2/lib/types/workflows/whatsAppWorkflow.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/whatsAppWorkflow.ts#L10)

The communication channel for sending the verification code.

##### from?

```ts
optional from: string;
```

Defined in: [verify2/lib/types/workflows/whatsAppWorkflow.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/whatsAppWorkflow.ts#L22)

(Optional) The sender's phone number or identifier for the WhatsApp
message.

##### to

```ts
to: string;
```

Defined in: [verify2/lib/types/workflows/whatsAppWorkflow.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify2/lib/types/workflows/whatsAppWorkflow.ts#L16)

The recipient's phone number where the verification code will be sent,
typically in the E.164 format.