[**Documentation**](index.md) *** [Documentation](packages.md) / Vonage Verify # Vonage Verify 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/verify?label=%40vonage%2Fverify&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] Vonage This is the Vonage Verify (for version 1) 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]. Note: This package is only compatible with verify V1. For full API documentation refer to [developer.vonage.com](https://developer.vonage.com/). If you are updating from V2 to V3 of the SDK, please check the migration guide found [here](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/verify/v2_TO_v3_MIGRATION_GUIDE.md) - [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/verify ``` ### With Yarn ```bash yarn add @vonage/verify ``` ## Usage ### As part of the Vonage Server SDK If you are using this SDK as part of the Vonage Server SDK, you can access it as the `verify` 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.verify .check(VERIFY_REQUEST_ID, CODE) .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 API. All you need to do is `require('@vonage/verify')`, and use the returned object to create your own client. ```js const { Auth } = require('@vonage/auth') const { Verify } = require('@vonage/verify') const credentials = new Auth({ apiKey: API_KEY, apiSecret: API_SECRET, }) const options = {} const verifyClient = new Verify(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 vonage.vrify.check(VERIFY_REQUEST_ID, CODE) vonage.verify .check(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 ### CheckStatus Defined in: [verify/lib/enums/CheckStatus.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L4) Enum representing the status of a verification check. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `BARRED_API_KEY` | `"8"` | The API key used in the verification request is barred. | [verify/lib/enums/CheckStatus.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L43) | | `CODE_MISMATCH` | `"16"` | Code mismatch in the verification request. | [verify/lib/enums/CheckStatus.ts:63](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L63) | | `CONCURRENT_VERIFICATIONS` | `"10"` | Concurrent verifications not allowed. | [verify/lib/enums/CheckStatus.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L53) | | `DELIVERY_FAILED` | `"19"` | Delivery of the verification failed. | [verify/lib/enums/CheckStatus.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L73) | | `FAILED_TO_PROCESS` | `"6"` | Failed to process the verification request. | [verify/lib/enums/CheckStatus.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L38) | | `INTERNAL_ERROR` | `"5"` | An internal error occurred during the verification process. | [verify/lib/enums/CheckStatus.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L33) | | `INVALID_CODE` | `"17"` | Invalid verification code provided. | [verify/lib/enums/CheckStatus.ts:68](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L68) | | `INVALID_CREDENTIALS` | `"4"` | Invalid credentials were used in the verification request. | [verify/lib/enums/CheckStatus.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L28) | | `INVALID_PARAM` | `"3"` | An invalid parameter was provided in the verification request. | [verify/lib/enums/CheckStatus.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L23) | | `MISSING_REQUIRED_PARAM` | `"2"` | A required parameter was missing in the verification request. | [verify/lib/enums/CheckStatus.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L18) | | `NON_PERMITTED_DESTINATION` | `"29"` | Destination not permitted for verification. | [verify/lib/enums/CheckStatus.ts:83](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L83) | | `PARTNER_QUOTA_EXCEEDED` | `"9"` | Partner quota for verifications exceeded. | [verify/lib/enums/CheckStatus.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L48) | | `PIN_NOT_SUPPORTED` | `"20"` | PIN not supported for verification. | [verify/lib/enums/CheckStatus.ts:78](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L78) | | `SUCCESS` | `"0"` | The verification check was successful. | [verify/lib/enums/CheckStatus.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L8) | | `THROTTLED` | `"1"` | The verification request was throttled. | [verify/lib/enums/CheckStatus.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L13) | | `UNSUPPORTED_NETWORK` | `"15"` | The network is not supported for verification. | [verify/lib/enums/CheckStatus.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/CheckStatus.ts#L58) | *** ### Command Defined in: [verify/lib/enums/Command.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/Command.ts#L4) Enum representing commands for controlling Verify requests. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `CANCEL` | `"cancel"` | Command to request cancellation of the verification process. | [verify/lib/enums/Command.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/Command.ts#L8) | | `TRIGGER_NEXT_EVENT` | `"trigger_next_event"` | Command to trigger the next verification event (if any). | [verify/lib/enums/Command.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/Command.ts#L13) | *** ### SearchCheckStatus Defined in: [verify/lib/enums/SearchCheckStatus.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchCheckStatus.ts#L4) Enum representing the status of a verification check during Verify search. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `INVALID` | `"INVALID"` | The verification check is invalid. | [verify/lib/enums/SearchCheckStatus.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchCheckStatus.ts#L8) | | `VALID` | `"VALID"` | The verification check is valid. | [verify/lib/enums/SearchCheckStatus.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchCheckStatus.ts#L13) | *** ### SearchEventTypes Defined in: [verify/lib/enums/SearchEventTypes.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchEventTypes.ts#L4) Enum representing the types of events that can occur during Verify search. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `SMS` | `"SMS"` | Short Message Service (SMS) event. | [verify/lib/enums/SearchEventTypes.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchEventTypes.ts#L13) | | `TTS` | `"TTS"` | Text-to-Speech event. | [verify/lib/enums/SearchEventTypes.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchEventTypes.ts#L8) | *** ### SearchStatus Defined in: [verify/lib/enums/SearchStatus.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchStatus.ts#L4) Enum representing the status of a Verify search request. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `CANCELLED` | `"CANCELLED"` | The verification process was canceled by a Verify control request. | [verify/lib/enums/SearchStatus.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchStatus.ts#L28) | | `EXPIRED` | `"EXPIRED"` | Your user did not enter a code before the pin_expiry time elapsed. | [verify/lib/enums/SearchStatus.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchStatus.ts#L23) | | `FAILED` | `"FAILED"` | Your user entered an incorrect code more than three times. | [verify/lib/enums/SearchStatus.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchStatus.ts#L18) | | `IN_PROGRESS` | `"IN PROGRESS"` | The search is still in progress. | [verify/lib/enums/SearchStatus.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchStatus.ts#L8) | | `SUCCESS` | `"SUCCESS"` | Your user entered a correct verification code. | [verify/lib/enums/SearchStatus.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/SearchStatus.ts#L13) | *** ### VerifyLanguages Defined in: [verify/lib/enums/VerifyLanguages.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L4) Enum representing supported languages for Verify requests. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `ARABIC` | `"ar-xa"` | Arabic language (ar-xa). | [verify/lib/enums/VerifyLanguages.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L8) | | `CHINESE_MAINLAND` | `"zh-cn"` | Chinese language, Mainland (zh-cn). | [verify/lib/enums/VerifyLanguages.ts:193](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L193) | | `CHINESE_TAIWAN` | `"zh-tw"` | Chinese language, Taiwan (zh-tw). | [verify/lib/enums/VerifyLanguages.ts:198](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L198) | | `CZECH` | `"cs-cz"` | Czech language (cs-cz). | [verify/lib/enums/VerifyLanguages.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L13) | | `DANISH` | `"da-dk"` | Danish language (da-dk). | [verify/lib/enums/VerifyLanguages.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L28) | | `DUTCH` | `"nl-nl"` | Dutch language (nl-nl). | [verify/lib/enums/VerifyLanguages.ts:138](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L138) | | `ENGLISH_AUSTRALIA` | `"en-au"` | English language, Australia (en-au). | [verify/lib/enums/VerifyLanguages.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L43) | | `ENGLISH_INDIA` | `"en-in"` | English language, India (en-in). | [verify/lib/enums/VerifyLanguages.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L53) | | `ENGLISH_UK` | `"en-gb"` | English language, United Kingdom (en-gb). | [verify/lib/enums/VerifyLanguages.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L48) | | `ENGLISH_US` | `"en-us"` | English language, United States (en-us). | [verify/lib/enums/VerifyLanguages.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L58) | | `FILIPINO` | `"fil-ph"` | Filipino language (fil-ph). | [verify/lib/enums/VerifyLanguages.ts:83](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L83) | | `FINNISH` | `"fi-fi"` | Finnish language (fi-fi). | [verify/lib/enums/VerifyLanguages.ts:78](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L78) | | `FRENCH_CANADA` | `"fr-ca"` | French language, Canada (fr-ca). | [verify/lib/enums/VerifyLanguages.ts:88](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L88) | | `FRENCH_FRANCE` | `"fr-fr"` | French language, France (fr-fr). | [verify/lib/enums/VerifyLanguages.ts:93](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L93) | | `GERMAN` | `"de-de"` | German language (de-de). | [verify/lib/enums/VerifyLanguages.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L33) | | `GREEK` | `"el-gr"` | Greek language (el-gr). | [verify/lib/enums/VerifyLanguages.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L38) | | `HINDI` | `"hi-in"` | Hindi language (hi-in). | [verify/lib/enums/VerifyLanguages.ts:98](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L98) | | `HUNGARIAN` | `"hu-hu"` | Hungarian language (hu-hu). | [verify/lib/enums/VerifyLanguages.ts:103](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L103) | | `ICELANDIC` | `"is-is"` | Icelandic language (is-is). | [verify/lib/enums/VerifyLanguages.ts:113](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L113) | | `INDONESIAN` | `"id-id"` | Indonesian language (id-id). | [verify/lib/enums/VerifyLanguages.ts:108](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L108) | | `ITALIAN` | `"it-it"` | Italian language (it-it). | [verify/lib/enums/VerifyLanguages.ts:118](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L118) | | `JAPANESE` | `"ja-jp"` | Japanese language (ja-jp). | [verify/lib/enums/VerifyLanguages.ts:123](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L123) | | `KOREAN` | `"ko-kr"` | Korean language (ko-kr). | [verify/lib/enums/VerifyLanguages.ts:128](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L128) | | `NORWEGIAN` | `"nb-no"` | Norwegian language (nb-no). | [verify/lib/enums/VerifyLanguages.ts:133](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L133) | | `POLISH` | `"pl-pl"` | Polish language (pl-pl). | [verify/lib/enums/VerifyLanguages.ts:143](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L143) | | `PORTUGUESE_BRAZIL` | `"pt-br"` | Portuguese language, Brazil (pt-br). | [verify/lib/enums/VerifyLanguages.ts:148](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L148) | | `PORTUGUESE_PORTUGAL` | `"pt-pt"` | Portuguese language, Portugal (pt-pt). | [verify/lib/enums/VerifyLanguages.ts:153](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L153) | | `ROMANIAN` | `"ro-ro"` | Romanian language (ro-ro). | [verify/lib/enums/VerifyLanguages.ts:158](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L158) | | `RUSSIAN` | `"ru-ru"` | Russian language (ru-ru). | [verify/lib/enums/VerifyLanguages.ts:163](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L163) | | `SPANISH_MEXICO` | `"es-mx"` | Spanish language, Mexico (es-mx). | [verify/lib/enums/VerifyLanguages.ts:68](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L68) | | `SPANISH_SPAIN` | `"es-es"` | Spanish language, Spain (es-es). | [verify/lib/enums/VerifyLanguages.ts:63](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L63) | | `SPANISH_US` | `"es-us"` | Spanish language, United States (es-us). | [verify/lib/enums/VerifyLanguages.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L73) | | `SWEDISH` | `"sv-se"` | Swedish language (sv-se). | [verify/lib/enums/VerifyLanguages.ts:168](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L168) | | `THAI` | `"th-th"` | Thai language (th-th). | [verify/lib/enums/VerifyLanguages.ts:173](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L173) | | `TURKISH` | `"tr-tr"` | Turkish language (tr-tr). | [verify/lib/enums/VerifyLanguages.ts:178](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L178) | | `VIETNAMESE` | `"vi-vn"` | Vietnamese language (vi-vn). | [verify/lib/enums/VerifyLanguages.ts:183](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L183) | | `WELSH` | `"cy-cy"` | Welsh language (cy-cy). | [verify/lib/enums/VerifyLanguages.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L18) | | `WELSH_UK` | `"cy-gb"` | Welsh language, United Kingdom (cy-gb). | [verify/lib/enums/VerifyLanguages.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L23) | | `YUE_CHINESE_CANTONESE` | `"yue-cn"` | Yue Chinese Cantonese language (yue-cn). | [verify/lib/enums/VerifyLanguages.ts:188](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/VerifyLanguages.ts#L188) | *** ### VerifyWorkflows Defined in: [verify/lib/enums/Workflows.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/Workflows.ts#L4) Enum representing predefined Verify workflows. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `SMS` | `"6"` | Workflow: SMS | [verify/lib/enums/Workflows.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/Workflows.ts#L33) | | `SMS_SMS` | `"4"` | Workflow: SMS - SMS | [verify/lib/enums/Workflows.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/Workflows.ts#L23) | | `SMS_SMS_TTS` | `"2"` | Workflow: SMS - SMS - TTS | [verify/lib/enums/Workflows.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/Workflows.ts#L13) | | `SMS_TTS` | `"5"` | Workflow: SMS - TTS | [verify/lib/enums/Workflows.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/Workflows.ts#L28) | | `SMS_TTS_TTS` | `"1"` | Workflow: SMS - TTS - TTS | [verify/lib/enums/Workflows.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/Workflows.ts#L8) | | `TTS` | `"7"` | Workflow: TTS | [verify/lib/enums/Workflows.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/Workflows.ts#L38) | | `TTS_TTS` | `"3"` | Workflow: TTS - TTS | [verify/lib/enums/Workflows.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/enums/Workflows.ts#L18) | ## Classes ### PSD2 Defined in: [verify/lib/classes/PSD2.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L8) Represents parameters for a PSD2 (Payment Services Directive 2) verification request. #### Implements - [`PSD2Parameters`](#psd2parameters) #### Constructors ##### Constructor ```ts new PSD2( phoneNumber, payee, amount, country?, codeLength?, language?, lg?, pinExpiry?, nextEventWait?, workflowId?): PSD2; ``` Defined in: [verify/lib/classes/PSD2.ts:59](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L59) ###### Parameters ###### phoneNumber `string` ###### payee `string` ###### amount `number` ###### country? `string` ###### codeLength? `number` ###### language? [`VerifyLanguages`](#verifylanguages) ###### lg? [`VerifyLanguages`](#verifylanguages) ###### pinExpiry? `number` ###### nextEventWait? `number` ###### workflowId? [`VerifyWorkflows`](#verifyworkflows) ###### Returns [`PSD2`](#psd2) #### Properties ##### amount ```ts amount: number; ``` Defined in: [verify/lib/classes/PSD2.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L22) The decimal amount of the payment to be confirmed, in Euros. ###### Implementation of ```ts PSD2Parameters.amount ``` ##### codeLength? ```ts optional codeLength: number; ``` Defined in: [verify/lib/classes/PSD2.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L32) The desired length of the verification code (optional). ###### Implementation of ```ts PSD2Parameters.codeLength ``` ##### country? ```ts optional country: string; ``` Defined in: [verify/lib/classes/PSD2.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L27) The country code associated with the phone number (optional). ###### Implementation of ```ts PSD2Parameters.country ``` ##### ~~language?~~ ```ts optional language: string; ``` Defined in: [verify/lib/classes/PSD2.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L37) ###### Deprecated This property is deprecated. Use `lg` instead. ##### lg? ```ts optional lg: VerifyLanguages; ``` Defined in: [verify/lib/classes/PSD2.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L42) The language for sending verification messages (optional). ###### Implementation of ```ts PSD2Parameters.lg ``` ##### nextEventWait? ```ts optional nextEventWait: number; ``` Defined in: [verify/lib/classes/PSD2.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L52) The duration in seconds to wait before sending the next verification event. ###### Implementation of ```ts PSD2Parameters.nextEventWait ``` ##### number ```ts number: string; ``` Defined in: [verify/lib/classes/PSD2.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L12) The phone number to be verified. ###### Implementation of ```ts PSD2Parameters.number ``` ##### payee ```ts payee: string; ``` Defined in: [verify/lib/classes/PSD2.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L17) The payee's name or identifier for the payment confirmation. ###### Implementation of ```ts PSD2Parameters.payee ``` ##### pinExpiry? ```ts optional pinExpiry: number; ``` Defined in: [verify/lib/classes/PSD2.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L47) The duration in seconds for which the verification code will be valid. ###### Implementation of ```ts PSD2Parameters.pinExpiry ``` ##### workflowId? ```ts optional workflowId: VerifyWorkflows; ``` Defined in: [verify/lib/classes/PSD2.ts:57](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/PSD2.ts#L57) The workflow ID for customizing the verification process (optional). ###### Implementation of ```ts PSD2Parameters.workflowId ``` *** ### Verification Defined in: [verify/lib/classes/Verification.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L7) Represents parameters for a verification request. #### Implements - [`VerificationParameters`](#verificationparameters) #### Constructors ##### Constructor ```ts new Verification( phoneNumber, brand, country?, senderId?, codeLength?, language?, lg?, pinExpiry?, nextEventWait?, workflowId?): Verification; ``` Defined in: [verify/lib/classes/Verification.ts:59](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L59) ###### Parameters ###### phoneNumber `string` ###### brand `string` ###### country? `string` ###### senderId? `string` ###### codeLength? `number` ###### language? [`VerifyLanguages`](#verifylanguages) ###### lg? [`VerifyLanguages`](#verifylanguages) ###### pinExpiry? `number` ###### nextEventWait? `number` ###### workflowId? [`VerifyWorkflows`](#verifyworkflows) ###### Returns [`Verification`](#verification) #### Properties ##### brand ```ts brand: string; ``` Defined in: [verify/lib/classes/Verification.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L16) The brand or application name associated with the verification request. ###### Implementation of [`VerificationParameters`](#verificationparameters).[`brand`](#brand-1) ##### codeLength? ```ts optional codeLength: number; ``` Defined in: [verify/lib/classes/Verification.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L32) The desired length of the verification code (optional). ###### Implementation of [`VerificationParameters`](#verificationparameters).[`codeLength`](#codelength-2) ##### country? ```ts optional country: string; ``` Defined in: [verify/lib/classes/Verification.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L21) The country code associated with the phone number (optional). ###### Implementation of [`VerificationParameters`](#verificationparameters).[`country`](#country-2) ##### ~~language?~~ ```ts optional language: string; ``` Defined in: [verify/lib/classes/Verification.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L37) ###### Deprecated This property is deprecated. Use `lg` instead. ##### lg? ```ts optional lg: VerifyLanguages; ``` Defined in: [verify/lib/classes/Verification.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L42) The language for sending verification messages (optional). ###### Implementation of [`VerificationParameters`](#verificationparameters).[`lg`](#lg-2) ##### nextEventWait? ```ts optional nextEventWait: number; ``` Defined in: [verify/lib/classes/Verification.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L52) The duration in seconds to wait before sending the next verification event. ###### Implementation of [`VerificationParameters`](#verificationparameters).[`nextEventWait`](#nexteventwait-2) ##### number ```ts number: string; ``` Defined in: [verify/lib/classes/Verification.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L11) The phone number to be verified. ###### Implementation of [`VerificationParameters`](#verificationparameters).[`number`](#number-2) ##### pinExpiry? ```ts optional pinExpiry: number; ``` Defined in: [verify/lib/classes/Verification.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L47) The duration in seconds for which the verification code will be valid. ###### Implementation of [`VerificationParameters`](#verificationparameters).[`pinExpiry`](#pinexpiry-2) ##### senderId? ```ts optional senderId: string; ``` Defined in: [verify/lib/classes/Verification.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L27) The sender ID or phone number that will be used to send verification messages (optional). ###### Implementation of [`VerificationParameters`](#verificationparameters).[`senderId`](#senderid-1) ##### workflowId? ```ts optional workflowId: VerifyWorkflows; ``` Defined in: [verify/lib/classes/Verification.ts:57](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/classes/Verification.ts#L57) The workflow ID for customizing the verification process (optional). ###### Implementation of [`VerificationParameters`](#verificationparameters).[`workflowId`](#workflowid-2) *** ### Verify Defined in: [verify/lib/verify.ts:55](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/verify.ts#L55) The Verify class provides methods for managing and performing verification processes using the Vonage Verify API. It allows you to initiate new verification requests, check verification codes, search for verification request details, and perform control actions like canceling or triggering the next event for a verification process. #### Examples Create a standalone Verify client ```ts import { Verify } from '@vonage/verify'; const verifyClient = new Verify({ apiKey: VONAGE_API_KEY, apiSecret: VONAGE_API_SECRET }); ``` Create an Verify client from the Vonage client ```ts import { Vonage } from '@vonage/server-client'; const vonage = new Vonage({ apiKey: VONAGE_API_KEY, apiSecret: VONAGE_API_SECRET }); const verifyClient = vonage.verify; ``` #### Extends - [`Client`](Vonage-Server-Client.md#client) #### Constructors ##### Constructor ```ts new Verify(credentials, options?): Verify; ``` 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. [`AuthParams`](Vonage-Auth.md#authparams) | [`AuthInterface`](Vonage-Auth.md#authinterface) ###### options? [`ConfigParams`](Vonage-Server-Client.md#configparams) Optional configuration settings for the client. ###### Returns [`Verify`](#verify) ###### 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 optional authType: AuthenticationType = AuthenticationType.KEY_SECRET; ``` Defined in: [verify/lib/verify.ts:57](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/verify.ts#L57) The type of authentication used for the client's requests. ###### 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; ``` 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; ``` 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; ``` 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; ``` 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; ``` 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< | VerifyControlResponse | VerifyControlError>; ``` Defined in: [verify/lib/verify.ts:140](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/verify.ts#L140) Cancels a specific verification request. ###### Parameters ###### requestId `string` The request ID of the verification to cancel. ###### Returns `Promise`\< \| [`VerifyControlResponse`](#verifycontrolresponse) \| [`VerifyControlError`](#verifycontrolerror)\> A Promise that resolves to a `VerifyControl` object containing the control response on success or a `VerifyControlError` object on error. ###### Throws If an error occurs while canceling the verification request. ###### Example ```ts import { CheckStatus } from '@vonage/verify'; const result = await verifyClient.cancel('REQUEST_ID') if (result.status === CheckStatus.SUCCESS) { console.log('Verification request canceled.'); console.log(result.status); } else { console.log('Error canceling verification request.'); console.log(result.errorText); } ``` ##### check() ```ts check(requestId, code): Promise; ``` Defined in: [verify/lib/verify.ts:194](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/verify.ts#L194) Checks the verification code for a specific verification request. ###### Parameters ###### requestId `string` The request ID of the verification to check. ###### code `string` The verification code to check against. ###### Returns `Promise`\<[`VerifyCheck`](#verifycheck-2) \| [`VerifyCheckError`](#verifycheckerror)\> A Promise that resolves to a `VerifyCheck` object containing the verification result on success or a `VerifyCheckError` object on error. ###### Throws If an error occurs during the verification check. ###### Example ```ts import { CheckStatus } from '@vonage/verify'; const result = await verifyClient.check('REQUEST_ID', 'CODE') if (result.status === CheckStatus.SUCCESS) { console.log('Verification code is valid.'); } else { console.log('Verification code is invalid.'); } ``` ##### 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) ##### parseResponse() ```ts protected parseResponse(request, response): Promise>; ``` 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; ``` 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) ##### search() ```ts search(requestId): Promise< | VerifySearch | VerifySearchError>; ``` Defined in: [verify/lib/verify.ts:229](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/verify.ts#L229) Searches for the status of a verification request by its request ID. ###### Parameters ###### requestId `string` The request ID of the verification to search for. ###### Returns `Promise`\< \| [`VerifySearch`](#verifysearch-2) \| [`VerifySearchError`](#verifysearcherror)\> A `VerifySearch` object containing the verification details on success or a `VerifySearchError` object on error. ###### Example ```ts const result = await verifyClient.search('REQUEST_ID') if (result.errorText) { console.log(`Request found with error ${result.errorText}`); } else { console.log(`Request found and submitted on ${result.dateSubmitted}`); } ``` ##### sendControl() ```ts sendControl(command, requestId): Promise< | VerifyControlResponse | VerifyControlError>; ``` Defined in: [verify/lib/verify.ts:97](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/verify.ts#L97) Sends a control command for a specific verification request. ###### Parameters ###### command [`Command`](#command) The control command to send, either "cancel" or "trigger_next_event". ###### requestId `string` The request ID of the verification to control. ###### Returns `Promise`\< \| [`VerifyControlResponse`](#verifycontrolresponse) \| [`VerifyControlError`](#verifycontrolerror)\> A Promise that resolves to a `VerifyControl` object containing the control response on success or a `VerifyControlError` object on error. ###### Throws If an error occurs while sending the control command. ###### Examples Cancel a verification request ```ts import { Command, CheckStatus } from '@vonage/verify'; const result = await verifyClient.sendControl(Command.CANCEL, 'REQUEST_ID') if (result.status === CheckStatus.SUCCESS) { console.log('Verification request canceled.'); console.log(result.status); } else { console.log('Error canceling verification request.'); console.log(result.errorText); } ``` Trigger the next event for a verification request ```ts import { Command, CheckStatus } from '@vonage/verify'; const result = await verifyClient.sendControl(Command.TRIGGER_NEXT_EVENT, 'REQUEST_ID') if (result.status === CheckStatus.SUCCESS) { console.log('Next event triggered'); console.log(result.status); } else { console.log('Error triggering next event'); console.log(result.errorText); } ``` ##### sendDeleteRequest() ```ts sendDeleteRequest(url): Promise>; ``` 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(url, payload?): Promise>; ``` 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(url, queryParams?): Promise>; ``` 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(url, payload?): Promise>; ``` 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(url, payload?): Promise>; ``` 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(url, payload?): Promise>; ``` 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(request): Promise>; ``` 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( method, url, payload?): Promise>; ``` 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) ##### start() ```ts start(request): Promise; ``` Defined in: [verify/lib/verify.ts:281](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/verify.ts#L281) Starts a verification request. ###### Parameters ###### request The verification parameters for the request. [`VerificationParameters`](#verificationparameters) | [`PSD2Parameters`](#psd2parameters) ###### Returns `Promise`\<[`VerifyRequest`](#verifyrequest) \| [`VerifyError`](#verifyerror)\> A `VerifyError` object on error or a `VerifyRequest` object on success. ###### Examples ```ts const result = await verifyClient.start({ number: TO_NUMBER, brand: BRAND_NAME }); if (result.requestId) { console.log(`Request started with id ${result.requestId}`); } else { console.log(`Request failed with error: ${result.errorText}`); } ``` Start a request with PSD2 parameters ```ts const result = await verifyClient.start({ number: TO_NUMBER, payee: PAYEE, amount: AMOUNT, }) if (result.requestId) { console.log(`Request started with id ${result.requestId}`); } else { console.log(`Request failed with error: ${result.errorText}`); } ``` ##### trigger() ```ts trigger(requestId): Promise< | VerifyControlResponse | VerifyControlError>; ``` Defined in: [verify/lib/verify.ts:168](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/verify.ts#L168) Triggers the next verification event for a specific verification request. ###### Parameters ###### requestId `string` The request ID of the verification to trigger the next event for. ###### Returns `Promise`\< \| [`VerifyControlResponse`](#verifycontrolresponse) \| [`VerifyControlError`](#verifycontrolerror)\> A Promise that resolves to a `VerifyControl` object containing the control response on success or a `VerifyControlError` object on error. ###### Throws If an error occurs while triggering the next verification event. ###### Example ```ts import { CheckStatus } from '@vonage/verify'; const result = await verifyClient.trigger('REQUEST_ID') if (result.status === CheckStatus.SUCCESS) { console.log('Verification request canceled.'); console.log(result.status); } else { console.log('Error canceling verification request.'); console.log(result.errorText); } ``` ## Interfaces ### VerificationParameters Defined in: [verify/lib/types/VerificationParams.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationParams.ts#L6) Represents parameters for a verification request. #### Properties ##### brand ```ts brand: string; ``` Defined in: [verify/lib/types/VerificationParams.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationParams.ts#L18) An 18-character alphanumeric string you can use to personalize the verification request SMS body, to help users identify your company or application name. For example: "Your Acme Inc PIN is ..." ##### codeLength? ```ts optional codeLength: number; ``` Defined in: [verify/lib/types/VerificationParams.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationParams.ts#L38) (Optional) The length of the verification code. ##### country? ```ts optional country: string; ``` Defined in: [verify/lib/types/VerificationParams.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationParams.ts#L25) (Optional) The two-character country code if the number is not provided in international format or if you are not sure if the number is correctly formatted. Verify will then format the number for you. ##### lg? ```ts optional lg: VerifyLanguages; ``` Defined in: [verify/lib/types/VerificationParams.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationParams.ts#L43) (Optional) The language used for the Verify request. ##### nextEventWait? ```ts optional nextEventWait: number; ``` Defined in: [verify/lib/types/VerificationParams.ts:55](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationParams.ts#L55) (Optional) The wait time in seconds between attempts to deliver the verification code. ##### number ```ts number: string; ``` Defined in: [verify/lib/types/VerificationParams.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationParams.ts#L11) The mobile or landline phone number to verify. Unless you are setting country explicitly, this number must be in E.164 format. ##### pinCode? ```ts optional pinCode: string; ``` Defined in: [verify/lib/types/VerificationParams.ts:70](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationParams.ts#L70) (Optional) A custom PIN to send to the user. If a PIN is not provided, Verify will generate a random PIN for you. This feature is not enabled by default - please discuss with your Account Manager if you would like it enabled. If this feature is not enabled on your account, error status 20 will be returned. ##### pinExpiry? ```ts optional pinExpiry: number; ``` Defined in: [verify/lib/types/VerificationParams.ts:49](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationParams.ts#L49) (Optional) How long the generated verification code is valid for, in seconds. ##### senderId? ```ts optional senderId: string; ``` Defined in: [verify/lib/types/VerificationParams.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationParams.ts#L33) (Optional) An 11-character alphanumeric string that represents the identity of the sender of the verification request. Depending on the destination of the phone number you are sending the verification SMS to, restrictions might apply. ##### workflowId? ```ts optional workflowId: VerifyWorkflows; ``` Defined in: [verify/lib/types/VerificationParams.ts:61](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationParams.ts#L61) (Optional) Selects the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user. ## Type Aliases ### ~~CheckInformation~~ ```ts type CheckInformation = SearchEventInformationResponse; ``` Defined in: [verify/lib/types/Response/CheckInformation.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/CheckInformation.ts#L8) Represents the information of a check event response. #### Deprecated Please use SearchEventInformation instead *** ### ~~EventInformation~~ ```ts type EventInformation = SearchEventInformationResponse; ``` Defined in: [verify/lib/types/Response/EventInformation.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/EventInformation.ts#L7) Represents the event information for a response. #### Deprecated please use SearchEventInformation instead *** ### PSD2Parameters ```ts type PSD2Parameters = Omit & object; ``` Defined in: [verify/lib/types/PSD2Parameters.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/PSD2Parameters.ts#L7) Represents parameters for a PSD2 (Payment Services Directive 2) verification request. #### Type declaration ##### amount ```ts amount: number; ``` The decimal amount of the payment to be confirmed, in Euros. ##### payee ```ts payee: string; ``` The payee's name or identifier for the payment confirmation. *** ### ~~PSD2Request~~ ```ts type PSD2Request = PSD2Parameters; ``` Defined in: [verify/lib/types/PSD2Request.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/PSD2Request.ts#L6) #### Deprecated please use PSD2Parameters *** ### SearchCheckInformationResponse ```ts type SearchCheckInformationResponse = object; ``` Defined in: [verify/lib/types/Response/SearchCheckInformationResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/SearchCheckInformationResponse.ts#L6) Represents the response data for searching check information. #### Properties ##### code ```ts code: string; ``` Defined in: [verify/lib/types/Response/SearchCheckInformationResponse.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/SearchCheckInformationResponse.ts#L15) The code associated with the check information. ##### date\_received ```ts date_received: string; ``` Defined in: [verify/lib/types/Response/SearchCheckInformationResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/SearchCheckInformationResponse.ts#L10) The date when the check information was received. ##### ip\_address ```ts ip_address: string; ``` Defined in: [verify/lib/types/Response/SearchCheckInformationResponse.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/SearchCheckInformationResponse.ts#L25) The IP address associated with the check information. ##### status ```ts status: SearchCheckStatus; ``` Defined in: [verify/lib/types/Response/SearchCheckInformationResponse.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/SearchCheckInformationResponse.ts#L20) The status of the search check. *** ### SearchEventInformationResponse ```ts type SearchEventInformationResponse = object; ``` Defined in: [verify/lib/types/Response/SearchEventInformationResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/SearchEventInformationResponse.ts#L6) Represents the response for searching event information. #### Properties ##### id ```ts id: string; ``` Defined in: [verify/lib/types/Response/SearchEventInformationResponse.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/SearchEventInformationResponse.ts#L14) The ID of the event. ##### type ```ts type: SearchEventTypes; ``` Defined in: [verify/lib/types/Response/SearchEventInformationResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/SearchEventInformationResponse.ts#L10) The type of the event. *** ### UblockRequestResponse ```ts type UblockRequestResponse = object; ``` Defined in: [verify/lib/types/Response/UnblockRequestResponse.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/UnblockRequestResponse.ts#L7) Represents the response of an unblock request. #### Properties ##### network ```ts network: string; ``` Defined in: [verify/lib/types/Response/UnblockRequestResponse.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/UnblockRequestResponse.ts#L11) The network associated with the unblock request. ##### unblocked\_until ```ts unblocked_until: string; ``` Defined in: [verify/lib/types/Response/UnblockRequestResponse.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/UnblockRequestResponse.ts#L16) The date and time until which the unblock is valid. *** ### ~~VerificationRequest~~ ```ts type VerificationRequest = VerificationParameters; ``` Defined in: [verify/lib/types/VerificationRequest.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerificationRequest.ts#L8) Represents a verification request. #### Deprecated please use VerificationParameters *** ### ~~VerifyCancelResponse~~ ```ts type VerifyCancelResponse = VerifyControlResponse & object; ``` Defined in: [verify/lib/types/Response/VerifyCancelResponse.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCancelResponse.ts#L9) Represents the response for cancelling a verification request. #### Type declaration ##### ~~command~~ ```ts command: CANCEL; ``` The command type for the response, which is "CANCEL". #### Deprecated Please use VerifyControlResponse instead *** ### VerifyCheck ```ts type VerifyCheck = VerifyRequestResponse & object; ``` Defined in: [verify/lib/types/VerifyCheck.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifyCheck.ts#L6) Represents a Verify Check response. #### Type declaration ##### errorText? ```ts optional errorText: string; ``` The error message, if any, associated with the Verify Check. ##### estimatedPriceMessagesSent? ```ts optional estimatedPriceMessagesSent: string; ``` The estimated price for the messages sent during the Verify Check. ##### eventId? ```ts optional eventId: string; ``` The unique identifier for the Verify event. ##### requestId ```ts requestId: string; ``` The unique identifier for the Verify request. *** ### VerifyCheckError ```ts type VerifyCheckError = VerifyCheckErrorResponse & object; ``` Defined in: [verify/lib/types/VerifyCheckError.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifyCheckError.ts#L6) Represents an error that occurred during the verification check process. #### Type declaration ##### errorId ```ts errorId: string; ``` The unique identifier of the error. ##### requestId ```ts requestId: string; ``` The unique identifier of the request. *** ### VerifyCheckErrorResponse ```ts type VerifyCheckErrorResponse = object; ``` Defined in: [verify/lib/types/Response/VerifyCheckErrorResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCheckErrorResponse.ts#L6) Represents the response object for a failed verification check. #### Properties ##### error\_text ```ts error_text: string; ``` Defined in: [verify/lib/types/Response/VerifyCheckErrorResponse.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCheckErrorResponse.ts#L20) The error message associated with the failed verification check. ##### request\_id ```ts request_id: string; ``` Defined in: [verify/lib/types/Response/VerifyCheckErrorResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCheckErrorResponse.ts#L10) The unique identifier for the verification request. ##### status ```ts status: CheckStatus; ``` Defined in: [verify/lib/types/Response/VerifyCheckErrorResponse.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCheckErrorResponse.ts#L15) The status of the verification check. *** ### VerifyCheckResponse ```ts type VerifyCheckResponse = object; ``` Defined in: [verify/lib/types/Response/VerifyCheckResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCheckResponse.ts#L6) Represents the response object for the Verify Check API. #### Properties ##### currency? ```ts optional currency: string; ``` Defined in: [verify/lib/types/Response/VerifyCheckResponse.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCheckResponse.ts#L30) The currency of the price. ##### event\_id? ```ts optional event_id: string; ``` Defined in: [verify/lib/types/Response/VerifyCheckResponse.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCheckResponse.ts#L20) The unique identifier for the verification event. ##### price? ```ts optional price: string; ``` Defined in: [verify/lib/types/Response/VerifyCheckResponse.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCheckResponse.ts#L25) The price of the verification check. ##### request\_id ```ts request_id: string; ``` Defined in: [verify/lib/types/Response/VerifyCheckResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCheckResponse.ts#L10) The unique identifier for the verification request. ##### status ```ts status: CheckStatus; ``` Defined in: [verify/lib/types/Response/VerifyCheckResponse.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCheckResponse.ts#L15) The status of the verification check. *** ### ~~VerifyClassParameters~~ ```ts type VerifyClassParameters = AuthParams & VetchOptions & object; ``` Defined in: [verify/lib/types/VerifyClassParameters.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifyClassParameters.ts#L9) Represents parameters for configuring the VerifyClass. #### Type declaration ##### ~~auth?~~ ```ts optional auth: AuthInterface; ``` (Optional) An authentication interface to use for authentication. #### Deprecated The class will set the correct type *** ### VerifyControl ```ts type VerifyControl = VerifyControlResponse; ``` Defined in: [verify/lib/types/VerifyControl.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifyControl.ts#L6) Represents the VerifyControl type. *** ### VerifyControlError ```ts type VerifyControlError = object; ``` Defined in: [verify/lib/types/VerifyControlError.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifyControlError.ts#L6) Represents an error that occurred during the verification control process. #### Properties ##### errorText ```ts errorText: string; ``` Defined in: [verify/lib/types/VerifyControlError.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifyControlError.ts#L15) The error message associated with the verification control error. ##### status ```ts status: CheckStatus; ``` Defined in: [verify/lib/types/VerifyControlError.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifyControlError.ts#L10) The status of the verification control. *** ### VerifyControlErrorResponse ```ts type VerifyControlErrorResponse = object; ``` Defined in: [verify/lib/types/Response/VerifyControlError.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyControlError.ts#L6) Represents an error response for a Verify control operation. #### Properties ##### error\_text ```ts error_text: string; ``` Defined in: [verify/lib/types/Response/VerifyControlError.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyControlError.ts#L15) The error text providing more information about the error. ##### status ```ts status: CheckStatus; ``` Defined in: [verify/lib/types/Response/VerifyControlError.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyControlError.ts#L10) The status code indicating the outcome of the operation. *** ### VerifyControlResponse ```ts type VerifyControlResponse = object; ``` Defined in: [verify/lib/types/Response/VerifyControlResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyControlResponse.ts#L6) Represents the response for a Verify control operation. #### Properties ##### command ```ts command: Command; ``` Defined in: [verify/lib/types/Response/VerifyControlResponse.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyControlResponse.ts#L15) The command associated with the Verify control operation. ##### status ```ts status: string; ``` Defined in: [verify/lib/types/Response/VerifyControlResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyControlResponse.ts#L10) The status code indicating the outcome of the operation. *** ### VerifyError ```ts type VerifyError = VerifyRequest & object; ``` Defined in: [verify/lib/types/VerifyError.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifyError.ts#L7) Represents an error response for a Verify operation with additional error-related properties. #### Type declaration ##### error\_text ```ts error_text: string; ``` The error text providing more information about the error. ##### errorText ```ts errorText: string; ``` The error text providing more information about the error ##### network? ```ts optional network: string; ``` (Optional) The network associated with the error. *** ### VerifyPDS2Response ```ts type VerifyPDS2Response = VerifyRequestResponse; ``` Defined in: [verify/lib/types/Response/PSD2RequestResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/PSD2RequestResponse.ts#L6) Represents the response for a PSD2 verification request. *** ### VerifyRequest ```ts type VerifyRequest = VerifyRequestResponse & object; ``` Defined in: [verify/lib/types/VerifyRequest.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifyRequest.ts#L6) Represents a Verify request with an additional requestId property. #### Type declaration ##### requestId ```ts requestId: string; ``` The unique identifier for the Verify request. *** ### ~~VerifyRequestError~~ ```ts type VerifyRequestError = VerifyCheckResponse; ``` Defined in: [verify/lib/types/Response/VerifyCheckError.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyCheckError.ts#L6) #### Deprecated Please use VerifyCheckResponse instead *** ### VerifyRequestErrorResponse ```ts type VerifyRequestErrorResponse = object; ``` Defined in: [verify/lib/types/Response/VerifyRequestError.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyRequestError.ts#L4) Represents an error response for a Verify request operation. #### Properties ##### error\_text ```ts error_text: string; ``` Defined in: [verify/lib/types/Response/VerifyRequestError.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyRequestError.ts#L18) The error text providing more information about the error. ##### network? ```ts optional network: string; ``` Defined in: [verify/lib/types/Response/VerifyRequestError.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyRequestError.ts#L23) (Optional) The network associated with the error. ##### request\_id? ```ts optional request_id: string; ``` Defined in: [verify/lib/types/Response/VerifyRequestError.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyRequestError.ts#L8) (Optional) The unique identifier for the Verify request. ##### status ```ts status: string; ``` Defined in: [verify/lib/types/Response/VerifyRequestError.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyRequestError.ts#L13) The status code indicating the outcome of the operation. *** ### VerifyRequestResponse ```ts type VerifyRequestResponse = object; ``` Defined in: [verify/lib/types/Response/VerifyRequestResponse.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyRequestResponse.ts#L4) Represents the response for a Verify request operation. #### Properties ##### request\_id ```ts request_id: string; ``` Defined in: [verify/lib/types/Response/VerifyRequestResponse.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyRequestResponse.ts#L8) The unique identifier for the Verify request. ##### status ```ts status: string; ``` Defined in: [verify/lib/types/Response/VerifyRequestResponse.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyRequestResponse.ts#L13) The status code indicating the outcome of the operation. *** ### VerifyResponse ```ts type VerifyResponse = object; ``` Defined in: [verify/lib/types/Response/VerifyResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyResponse.ts#L6) Represents the response for a Verify operation. #### Properties ##### request\_id ```ts request_id: string; ``` Defined in: [verify/lib/types/Response/VerifyResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyResponse.ts#L10) The unique identifier for the Verify request. ##### status ```ts status: CheckStatus; ``` Defined in: [verify/lib/types/Response/VerifyResponse.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifyResponse.ts#L15) The status code indicating the outcome of the operation. *** ### VerifySearch ```ts type VerifySearch = Omit & object; ``` Defined in: [verify/lib/types/VerifySearch.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifySearch.ts#L7) Represents the response for a Verify search operation. #### Type declaration ##### accountId ```ts accountId: string; ``` The Vonage account ID associated with the request. ##### checks ```ts checks: VerifySearchCheck[]; ``` The list of verification checks made for this verification and their outcomes. ##### dateFinalized ```ts dateFinalized: string; ``` The date and time the verification request was completed in the format 'YYYY-MM-DD HH:MM:SS'. ##### dateSubmitted ```ts dateSubmitted: string; ``` The date and time the verification request was submitted in the format 'YYYY-MM-DD HH:MM:SS'. ##### estimatedPriceMessagesSent ```ts estimatedPriceMessagesSent: string; ``` The estimated cost of messages sent during the verification process. ##### firstEventDate? ```ts optional firstEventDate: string; ``` (Optional) The time the first verification attempt was made in the format 'YYYY-MM-DD HH:MM:SS'. ##### lastEventDate? ```ts optional lastEventDate: string; ``` (Optional) The time the last verification attempt was made in the format 'YYYY-MM-DD HH:MM:SS'. ##### requestId ```ts requestId: string; ``` The unique identifier for the Verify request. ##### senderId ```ts senderId: string; ``` The sender ID provided in the Verify request. *** ### VerifySearchCheck ```ts type VerifySearchCheck = VerifyCheckResponse & object; ``` Defined in: [verify/lib/types/VerifySearchCheck.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifySearchCheck.ts#L6) Represents a verification check result as part of a Verify search operation. #### Type declaration ##### dateReceived ```ts dateReceived: string; ``` The date and time this check was received in the format 'YYYY-MM-DD HH:MM:SS'. ##### ipAddress ```ts ipAddress: string; ``` The IP address associated with this verification check. *** ### VerifySearchError ```ts type VerifySearchError = VerifySearchErrorResponse & object; ``` Defined in: [verify/lib/types/VerifySearchError.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/VerifySearchError.ts#L6) Represents an error response for a Verify search operation. #### Type declaration ##### errorText ```ts errorText: string; ``` A descriptive error message providing more information about the error. ##### requestId ```ts requestId: string; ``` The unique identifier for the Verify request that resulted in an error. *** ### VerifySearchErrorResponse ```ts type VerifySearchErrorResponse = object; ``` Defined in: [verify/lib/types/Response/VerifySearchErrorResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchErrorResponse.ts#L6) Represents an error response for a Verify search operation. #### Properties ##### error\_text ```ts error_text: string; ``` Defined in: [verify/lib/types/Response/VerifySearchErrorResponse.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchErrorResponse.ts#L20) The error text providing more information about the error. ##### request\_id ```ts request_id: string; ``` Defined in: [verify/lib/types/Response/VerifySearchErrorResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchErrorResponse.ts#L10) The unique identifier for the Verify request. ##### status ```ts status: SearchStatus; ``` Defined in: [verify/lib/types/Response/VerifySearchErrorResponse.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchErrorResponse.ts#L15) The status code indicating the outcome of the search operation. *** ### VerifySearchResponse ```ts type VerifySearchResponse = object; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L8) Represents the response for a Verify search operation. #### Properties ##### account\_id ```ts account_id: string; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L17) The account ID associated with the request. ##### checks ```ts checks: SearchCheckInformationResponse[]; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:67](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L67) The list of checks made for this verification and their outcomes. ##### currency ```ts currency: string; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L37) The currency code. ##### date\_finalized ```ts date_finalized: string; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L52) The date and time the verification request was completed. ##### date\_submitted ```ts date_submitted: string; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L47) The date and time the verification request was submitted. ##### estimated\_price\_messages\_sent ```ts estimated_price_messages_sent: string; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:78](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L78) The estimated cost of messages sent for the verification process. ##### events ```ts events: SearchEventInformationResponse[]; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L73) The events that have taken place to verify this number, and their unique identifiers. ##### first\_event\_date ```ts first_event_date: string; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:57](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L57) The time the first verification attempt was made. ##### last\_event\_date ```ts last_event_date: string; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:62](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L62) The time the last verification attempt was made. ##### number ```ts number: string; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L27) The phone number this verification request was used for. ##### price ```ts price: string; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L32) The cost incurred for this verification request. ##### request\_id ```ts request_id: string; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L12) The unique identifier for the Verify request. ##### sender\_id ```ts sender_id: string; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L42) The sender ID provided in the Verify request. ##### status ```ts status: SearchStatus; ``` Defined in: [verify/lib/types/Response/VerifySearchResponse.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/verify/lib/types/Response/VerifySearchResponse.ts#L22) The status code indicating the outcome of the search operation.