Search code, repositories, users, issues, pull requests...

lg?

pinExpiry?

number

nextEventWait?

number

workflowId?

VerifyWorkflows

Returns

PSD2

Properties

amount

amount: number;

Defined in: verify/lib/classes/PSD2.ts:22

The decimal amount of the payment to be confirmed, in Euros.

Implementation of

PSD2Parameters.amount

codeLength?

optional codeLength: number;

Defined in: verify/lib/classes/PSD2.ts:32

The desired length of the verification code (optional).

Implementation of

PSD2Parameters.codeLength

country?

optional country: string;

Defined in: verify/lib/classes/PSD2.ts:27

The country code associated with the phone number (optional).

Implementation of

PSD2Parameters.country

language?

optional language: string;

Defined in: verify/lib/classes/PSD2.ts:37

Deprecated

This property is deprecated. Use lg instead.

lg?

optional lg: VerifyLanguages;

Defined in: verify/lib/classes/PSD2.ts:42

The language for sending verification messages (optional).

Implementation of

PSD2Parameters.lg

nextEventWait?

optional nextEventWait: number;

Defined in: verify/lib/classes/PSD2.ts:52

The duration in seconds to wait before sending the next verification event.

Implementation of

PSD2Parameters.nextEventWait

number

number: string;

Defined in: verify/lib/classes/PSD2.ts:12

The phone number to be verified.

Implementation of

PSD2Parameters.number

payee

payee: string;

Defined in: verify/lib/classes/PSD2.ts:17

The payee's name or identifier for the payment confirmation.

Implementation of

PSD2Parameters.payee

pinExpiry?

optional pinExpiry: number;

Defined in: verify/lib/classes/PSD2.ts:47

The duration in seconds for which the verification code will be valid.

Implementation of

PSD2Parameters.pinExpiry

workflowId?

optional workflowId: VerifyWorkflows;

Defined in: verify/lib/classes/PSD2.ts:57

The workflow ID for customizing the verification process (optional).

Implementation of

PSD2Parameters.workflowId

Verification

Defined in: verify/lib/classes/Verification.ts:7

Represents parameters for a verification request.

Implements

VerificationParameters

Constructors

new Verification()

new Verification(
   phoneNumber, 
   brand, 
   country?, 
   senderId?, 
   codeLength?, 
   language?, 
   lg?, 
   pinExpiry?, 
   nextEventWait?, 
   workflowId?): Verification

Defined in: verify/lib/classes/Verification.ts:59

Parameters

phoneNumber

string

brand

string

country?

string

senderId?

string

codeLength?

number

language?

lg?

pinExpiry?

number

nextEventWait?

number

workflowId?

VerifyWorkflows

Returns

Verification

Properties

brand

brand: string;

Defined in: verify/lib/classes/Verification.ts:16

The brand or application name associated with the verification request.

Implementation of

codeLength?

optional codeLength: number;

Defined in: verify/lib/classes/Verification.ts:32

The desired length of the verification code (optional).

Implementation of

country?

optional country: string;

Defined in: verify/lib/classes/Verification.ts:21

The country code associated with the phone number (optional).

Implementation of

language?

optional language: string;

Defined in: verify/lib/classes/Verification.ts:37

Deprecated

This property is deprecated. Use lg instead.

lg?

optional lg: VerifyLanguages;

Defined in: verify/lib/classes/Verification.ts:42

The language for sending verification messages (optional).

Implementation of

nextEventWait?

optional nextEventWait: number;

Defined in: verify/lib/classes/Verification.ts:52

The duration in seconds to wait before sending the next verification event.

Implementation of

number

number: string;

Defined in: verify/lib/classes/Verification.ts:11

The phone number to be verified.

Implementation of

pinExpiry?

optional pinExpiry: number;

Defined in: verify/lib/classes/Verification.ts:47

The duration in seconds for which the verification code will be valid.

Implementation of

senderId?

optional senderId: string;

Defined in: verify/lib/classes/Verification.ts:27

The sender ID or phone number that will be used to send verification messages (optional).

Implementation of

workflowId?

optional workflowId: VerifyWorkflows;

Defined in: verify/lib/classes/Verification.ts:57

The workflow ID for customizing the verification process (optional).

Implementation of

AuthParams | AuthInterface

Verify

Defined in: verify/lib/verify.ts:55

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

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

import { Vonage } from '@vonage/server-client';

const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET
});

const verifyClient = vonage.verify;

Extends

Client

Constructors

new Verify()

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.

options?

ConfigParams

Optional configuration settings for the client.

Returns

Verify

Inherited from

Client.constructor

Properties

auth

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.auth

authType?

protected optional authType: AuthenticationType = AuthenticationType.KEY_SECRET;

Defined in: verify/lib/verify.ts:57

The type of authentication used for the client's requests.

Overrides

Client.authType

config

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.config

transformers

static transformers: object;

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

Static property containing utility transformers.

camelCaseObjectKeys

camelCaseObjectKeys: PartialTransformFunction;

kebabCaseObjectKeys

kebabCaseObjectKeys: PartialTransformFunction;

omit()

omit: (keys, obj) => TransformedObject;

Parameters

keys

string[]

obj

ObjectToTransform

Returns

TransformedObject

snakeCaseObjectKeys

snakeCaseObjectKeys: PartialTransformFunction;

Inherited from

Client.transformers

Methods

addAuthenticationToRequest()

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

Client.addAuthenticationToRequest

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

addBasicAuthToRequest()

protected addBasicAuthToRequest(request): Promise<VetchOptions>

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

Adds basic authentication headers to the request.

Parameters

request

Client.addBasicAuthToRequest

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

addJWTToRequest()

protected addJWTToRequest(request): Promise<VetchOptions>

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

Adds a JWT to the request.

Parameters

request

Client.addJWTToRequest

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

addQueryKeySecretToRequest()

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

Client.addQueryKeySecretToRequest

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

addQueryKeySecretToRequestBody()

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

Client.addQueryKeySecretToRequestBody

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

cancel()

cancel(requestId): Promise<
  | VerifyControlResponse
| VerifyControlError>

Defined in: verify/lib/verify.ts:140

Cancels a specific verification request.

Parameters

requestId

string

The request ID of the verification to cancel.

Returns

Promise< | VerifyControlResponse | 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

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()

check(requestId, code): Promise<
  | VerifyCheck
| VerifyCheckError>

Defined in: verify/lib/verify.ts:194

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 | 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

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()

getConfig(): ConfigParams

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

Returns

ConfigParams

Inherited from

Client.getConfig

parseResponse()

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

The expected type of the parsed response data.

Parameters

request

The request options.

response

Response

The raw response from the request.

Returns

Promise<VetchResponse<T>>

The parsed response.

Inherited from

Client.parseResponse

prepareBody()

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

The request options.

Returns

undefined | string

The prepared request body as a string or undefined.

Inherited from

Client.prepareBody

prepareRequest()

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

Client.prepareRequest

The initial request options.

Returns

Promise<VetchOptions>

The modified request options.

Inherited from

search()

search(requestId): Promise<
  | VerifySearch
| VerifySearchError>

Defined in: verify/lib/verify.ts:229

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 | VerifySearchError>

A VerifySearch object containing the verification details on success or a VerifySearchError object on error.

Example

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()

sendControl(command, requestId): Promise<
  | VerifyControlResponse
| VerifyControlError>

Defined in: verify/lib/verify.ts:97

Sends a control command for a specific verification request.

Parameters

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 | 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

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

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()

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

Parameters

url

string

The URL endpoint for the DELETE request.

Returns

Promise<VetchResponse<T>>

The response from the DELETE request.

Inherited from

Client.sendDeleteRequest

sendFormSubmitRequest()

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

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<T>>

The response from the POST request.

Inherited from

Client.sendFormSubmitRequest

sendGetRequest()

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

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<T>>

The response from the GET request.

Inherited from

Client.sendGetRequest

sendPatchRequest()

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

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<T>>

The response from the PATCH request.

Inherited from

Client.sendPatchRequest

sendPostRequest()

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

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<T>>

The response from the POST request.

Inherited from

Client.sendPostRequest

sendPutRequest()

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

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<T>>

The response from the PUT request.

Inherited from

Client.sendPutRequest

sendRequest()

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

Parameters

request

Client.sendRequestWithData

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

Returns

Promise<VetchResponse<T>>

The parsed response from the request.

Inherited from

Client.sendRequest

sendRequestWithData()

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

Parameters

method

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

POST | PUT | 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<T>>

The response from the request.

Inherited from

start()

start(request): Promise<
  | VerifyRequest
| VerifyError>

Defined in: verify/lib/verify.ts:281

Starts a verification request.

Parameters

request

The verification parameters for the request.