@vonage/verify
Version:
Verify API provides a choice of routes for sending a code to a user. You can use this to confirm a user's contact information, as a second factor when authenticating users, or for step-up authentication.
55 lines (52 loc) • 1.7 kB
TypeScript
import { PSD2Parameters } from '../types/PSD2Parameters.js';
import { VerifyLanguages } from '../enums/VerifyLanguages.js';
import { VerifyWorkflows } from '../enums/Workflows.js';
import '../types/VerificationParams.js';
/**
* Represents parameters for a PSD2 (Payment Services Directive 2) verification
* request.
*/
declare class PSD2 implements PSD2Parameters {
/**
* The phone number to be verified.
*/
number: string;
/**
* The payee's name or identifier for the payment confirmation.
*/
payee: string;
/**
* The decimal amount of the payment to be confirmed, in Euros.
*/
amount: number;
/**
* The country code associated with the phone number (optional).
*/
country?: string;
/**
* The desired length of the verification code (optional).
*/
codeLength?: number;
/**
* @deprecated This property is deprecated. Use `lg` instead.
*/
language?: string;
/**
* The language for sending verification messages (optional).
*/
lg?: VerifyLanguages;
/**
* The duration in seconds for which the verification code will be valid.
*/
pinExpiry?: number;
/**
* The duration in seconds to wait before sending the next verification event.
*/
nextEventWait?: number;
/**
* The workflow ID for customizing the verification process (optional).
*/
workflowId?: VerifyWorkflows;
constructor(phoneNumber: string, payee: string, amount: number, country?: string, codeLength?: number, language?: VerifyLanguages, lg?: VerifyLanguages, pinExpiry?: number, nextEventWait?: number, workflowId?: VerifyWorkflows);
}
export { PSD2 };