-
Notifications
You must be signed in to change notification settings - Fork 178
Vonage Verify
Vonage Verify • Docs
Documentation / Vonage Verify
Enum representing the status of a verification check.
| 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 |
CODE_MISMATCH |
"16" |
Code mismatch in the verification request. | verify/lib/enums/CheckStatus.ts:63 |
CONCURRENT_VERIFICATIONS |
"10" |
Concurrent verifications not allowed. | verify/lib/enums/CheckStatus.ts:53 |
DELIVERY_FAILED |
"19" |
Delivery of the verification failed. | verify/lib/enums/CheckStatus.ts:73 |
FAILED_TO_PROCESS |
"6" |
Failed to process the verification request. | verify/lib/enums/CheckStatus.ts:38 |
INTERNAL_ERROR |
"5" |
An internal error occurred during the verification process. | verify/lib/enums/CheckStatus.ts:33 |
INVALID_CODE |
"17" |
Invalid verification code provided. | verify/lib/enums/CheckStatus.ts:68 |
INVALID_CREDENTIALS |
"4" |
Invalid credentials were used in the verification request. | verify/lib/enums/CheckStatus.ts:28 |
INVALID_PARAM |
"3" |
An invalid parameter was provided in the verification request. | verify/lib/enums/CheckStatus.ts:23 |
MISSING_REQUIRED_PARAM |
"2" |
A required parameter was missing in the verification request. | verify/lib/enums/CheckStatus.ts:18 |
NON_PERMITTED_DESTINATION |
"29" |
Destination not permitted for verification. | verify/lib/enums/CheckStatus.ts:83 |
PARTNER_QUOTA_EXCEEDED |
"9" |
Partner quota for verifications exceeded. | verify/lib/enums/CheckStatus.ts:48 |
PIN_NOT_SUPPORTED |
"20" |
PIN not supported for verification. | verify/lib/enums/CheckStatus.ts:78 |
SUCCESS |
"0" |
The verification check was successful. | verify/lib/enums/CheckStatus.ts:8 |
THROTTLED |
"1" |
The verification request was throttled. | verify/lib/enums/CheckStatus.ts:13 |
UNSUPPORTED_NETWORK |
"15" |
The network is not supported for verification. | verify/lib/enums/CheckStatus.ts:58 |
Enum representing commands for controlling Verify requests.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
CANCEL |
"cancel" |
Command to request cancellation of the verification process. | verify/lib/enums/Command.ts:8 |
TRIGGER_NEXT_EVENT |
"trigger_next_event" |
Command to trigger the next verification event (if any). | verify/lib/enums/Command.ts:13 |
Enum representing the status of a verification check during Verify search.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
INVALID |
"INVALID" |
The verification check is invalid. | verify/lib/enums/SearchCheckStatus.ts:8 |
VALID |
"VALID" |
The verification check is valid. | verify/lib/enums/SearchCheckStatus.ts:13 |
Enum representing the types of events that can occur during Verify search.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
SMS |
"SMS" |
Short Message Service (SMS) event. | verify/lib/enums/SearchEventTypes.ts:13 |
TTS |
"TTS" |
Text-to-Speech event. | verify/lib/enums/SearchEventTypes.ts:8 |
Enum representing the status of a Verify search request.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
CANCELLED |
"CANCELLED" |
The verification process was canceled by a Verify control request. | verify/lib/enums/SearchStatus.ts:28 |
EXPIRED |
"EXPIRED" |
Your user did not enter a code before the pin_expiry time elapsed. | verify/lib/enums/SearchStatus.ts:23 |
FAILED |
"FAILED" |
Your user entered an incorrect code more than three times. | verify/lib/enums/SearchStatus.ts:18 |
IN_PROGRESS |
"IN PROGRESS" |
The search is still in progress. | verify/lib/enums/SearchStatus.ts:8 |
SUCCESS |
"SUCCESS" |
Your user entered a correct verification code. | verify/lib/enums/SearchStatus.ts:13 |
Enum representing supported languages for Verify requests.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
ARABIC |
"ar-xa" |
Arabic language (ar-xa). | verify/lib/enums/VerifyLanguages.ts:8 |
CHINESE_MAINLAND |
"zh-cn" |
Chinese language, Mainland (zh-cn). | verify/lib/enums/VerifyLanguages.ts:193 |
CHINESE_TAIWAN |
"zh-tw" |
Chinese language, Taiwan (zh-tw). | verify/lib/enums/VerifyLanguages.ts:198 |
CZECH |
"cs-cz" |
Czech language (cs-cz). | verify/lib/enums/VerifyLanguages.ts:13 |
DANISH |
"da-dk" |
Danish language (da-dk). | verify/lib/enums/VerifyLanguages.ts:28 |
DUTCH |
"nl-nl" |
Dutch language (nl-nl). | verify/lib/enums/VerifyLanguages.ts:138 |
ENGLISH_AUSTRALIA |
"en-au" |
English language, Australia (en-au). | verify/lib/enums/VerifyLanguages.ts:43 |
ENGLISH_INDIA |
"en-in" |
English language, India (en-in). | verify/lib/enums/VerifyLanguages.ts:53 |
ENGLISH_UK |
"en-gb" |
English language, United Kingdom (en-gb). | verify/lib/enums/VerifyLanguages.ts:48 |
ENGLISH_US |
"en-us" |
English language, United States (en-us). | verify/lib/enums/VerifyLanguages.ts:58 |
FILIPINO |
"fil-ph" |
Filipino language (fil-ph). | verify/lib/enums/VerifyLanguages.ts:83 |
FINNISH |
"fi-fi" |
Finnish language (fi-fi). | verify/lib/enums/VerifyLanguages.ts:78 |
FRENCH_CANADA |
"fr-ca" |
French language, Canada (fr-ca). | verify/lib/enums/VerifyLanguages.ts:88 |
FRENCH_FRANCE |
"fr-fr" |
French language, France (fr-fr). | verify/lib/enums/VerifyLanguages.ts:93 |
GERMAN |
"de-de" |
German language (de-de). | verify/lib/enums/VerifyLanguages.ts:33 |
GREEK |
"el-gr" |
Greek language (el-gr). | verify/lib/enums/VerifyLanguages.ts:38 |
HINDI |
"hi-in" |
Hindi language (hi-in). | verify/lib/enums/VerifyLanguages.ts:98 |
HUNGARIAN |
"hu-hu" |
Hungarian language (hu-hu). | verify/lib/enums/VerifyLanguages.ts:103 |
ICELANDIC |
"is-is" |
Icelandic language (is-is). | verify/lib/enums/VerifyLanguages.ts:113 |
INDONESIAN |
"id-id" |
Indonesian language (id-id). | verify/lib/enums/VerifyLanguages.ts:108 |
ITALIAN |
"it-it" |
Italian language (it-it). | verify/lib/enums/VerifyLanguages.ts:118 |
JAPANESE |
"ja-jp" |
Japanese language (ja-jp). | verify/lib/enums/VerifyLanguages.ts:123 |
KOREAN |
"ko-kr" |
Korean language (ko-kr). | verify/lib/enums/VerifyLanguages.ts:128 |
NORWEGIAN |
"nb-no" |
Norwegian language (nb-no). | verify/lib/enums/VerifyLanguages.ts:133 |
POLISH |
"pl-pl" |
Polish language (pl-pl). | verify/lib/enums/VerifyLanguages.ts:143 |
PORTUGUESE_BRAZIL |
"pt-br" |
Portuguese language, Brazil (pt-br). | verify/lib/enums/VerifyLanguages.ts:148 |
PORTUGUESE_PORTUGAL |
"pt-pt" |
Portuguese language, Portugal (pt-pt). | verify/lib/enums/VerifyLanguages.ts:153 |
ROMANIAN |
"ro-ro" |
Romanian language (ro-ro). | verify/lib/enums/VerifyLanguages.ts:158 |
RUSSIAN |
"ru-ru" |
Russian language (ru-ru). | verify/lib/enums/VerifyLanguages.ts:163 |
SPANISH_MEXICO |
"es-mx" |
Spanish language, Mexico (es-mx). | verify/lib/enums/VerifyLanguages.ts:68 |
SPANISH_SPAIN |
"es-es" |
Spanish language, Spain (es-es). | verify/lib/enums/VerifyLanguages.ts:63 |
SPANISH_US |
"es-us" |
Spanish language, United States (es-us). | verify/lib/enums/VerifyLanguages.ts:73 |
SWEDISH |
"sv-se" |
Swedish language (sv-se). | verify/lib/enums/VerifyLanguages.ts:168 |
THAI |
"th-th" |
Thai language (th-th). | verify/lib/enums/VerifyLanguages.ts:173 |
TURKISH |
"tr-tr" |
Turkish language (tr-tr). | verify/lib/enums/VerifyLanguages.ts:178 |
VIETNAMESE |
"vi-vn" |
Vietnamese language (vi-vn). | verify/lib/enums/VerifyLanguages.ts:183 |
WELSH |
"cy-cy" |
Welsh language (cy-cy). | verify/lib/enums/VerifyLanguages.ts:18 |
WELSH_UK |
"cy-gb" |
Welsh language, United Kingdom (cy-gb). | verify/lib/enums/VerifyLanguages.ts:23 |
YUE_CHINESE_CANTONESE |
"yue-cn" |
Yue Chinese Cantonese language (yue-cn). | verify/lib/enums/VerifyLanguages.ts:188 |
Enum representing predefined Verify workflows.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
SMS |
"6" |
Workflow: SMS | verify/lib/enums/Workflows.ts:33 |
SMS_SMS |
"4" |
Workflow: SMS - SMS | verify/lib/enums/Workflows.ts:23 |
SMS_SMS_TTS |
"2" |
Workflow: SMS - SMS - TTS | verify/lib/enums/Workflows.ts:13 |
SMS_TTS |
"5" |
Workflow: SMS - TTS | verify/lib/enums/Workflows.ts:28 |
SMS_TTS_TTS |
"1" |
Workflow: SMS - TTS - TTS | verify/lib/enums/Workflows.ts:8 |
TTS |
"7" |
Workflow: TTS | verify/lib/enums/Workflows.ts:38 |
TTS_TTS |
"3" |
Workflow: TTS - TTS | verify/lib/enums/Workflows.ts:18 |
Represents parameters for a PSD2 (Payment Services Directive 2) verification request.
new PSD2(
phoneNumber,
payee,
amount,
country?,
codeLength?,
language?,
lg?,
pinExpiry?,
nextEventWait?,
workflowId?): PSD2• phoneNumber: string
• payee: string
The payee's name or identifier for the payment confirmation.
• amount: number
The decimal amount of the payment to be confirmed, in Euros.
• country?: string
(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.
• codeLength?: number
(Optional) The length of the verification code.
• language?: VerifyLanguages
• lg?: VerifyLanguages
(Optional) The language used for the Verify request.
• pinExpiry?: number
(Optional) How long the generated verification code is valid for, in seconds.
• nextEventWait?: number
(Optional) The wait time in seconds between attempts to deliver the verification code.
• workflowId?: VerifyWorkflows
(Optional) Selects the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user.
amount: number;The decimal amount of the payment to be confirmed, in Euros.
PSD2Parameters.amount
optional codeLength: number;The desired length of the verification code (optional).
PSD2Parameters.codeLength
optional country: string;The country code associated with the phone number (optional).
PSD2Parameters.country
optional language: string;This property is deprecated. Use lg instead.
optional lg: VerifyLanguages;The language for sending verification messages (optional).
PSD2Parameters.lg
optional nextEventWait: number;The duration in seconds to wait before sending the next verification event.
PSD2Parameters.nextEventWait
number: string;The phone number to be verified.
PSD2Parameters.number
payee: string;The payee's name or identifier for the payment confirmation.
PSD2Parameters.payee
optional pinExpiry: number;The duration in seconds for which the verification code will be valid.
PSD2Parameters.pinExpiry
optional workflowId: VerifyWorkflows;The workflow ID for customizing the verification process (optional).
PSD2Parameters.workflowId
Represents parameters for a verification request.
new Verification(
phoneNumber,
brand,
country?,
senderId?,
codeLength?,
language?,
lg?,
pinExpiry?,
nextEventWait?,
workflowId?): Verification• phoneNumber: string
• brand: string
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 ..."
• country?: string
(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.
• senderId?: string
(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.
• codeLength?: number
(Optional) The length of the verification code.
• language?: VerifyLanguages
• lg?: VerifyLanguages
(Optional) The language used for the Verify request.
• pinExpiry?: number
(Optional) How long the generated verification code is valid for, in seconds.
• nextEventWait?: number
(Optional) The wait time in seconds between attempts to deliver the verification code.
• workflowId?: VerifyWorkflows
(Optional) Selects the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user.
verify/lib/classes/Verification.ts:59
brand: string;The brand or application name associated with the verification request.
verify/lib/classes/Verification.ts:16
optional codeLength: number;The desired length of the verification code (optional).
verify/lib/classes/Verification.ts:32
optional country: string;The country code associated with the phone number (optional).
verify/lib/classes/Verification.ts:21
optional language: string;This property is deprecated. Use lg instead.
verify/lib/classes/Verification.ts:37
optional lg: VerifyLanguages;The language for sending verification messages (optional).
verify/lib/classes/Verification.ts:42
optional nextEventWait: number;The duration in seconds to wait before sending the next verification event.
verify/lib/classes/Verification.ts:52
number: string;The phone number to be verified.
verify/lib/classes/Verification.ts:11
optional pinExpiry: number;The duration in seconds for which the verification code will be valid.
verify/lib/classes/Verification.ts:47
optional senderId: string;The sender ID or phone number that will be used to send verification messages (optional).
verify/lib/classes/Verification.ts:27
optional workflowId: VerifyWorkflows;The workflow ID for customizing the verification process (optional).
verify/lib/classes/Verification.ts:57
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.
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;new Verify(credentials, options?): VerifyCreates a new instance of the Client.
• credentials: AuthParams | AuthInterface
The authentication credentials or an authentication instance.
• options?: ConfigParams
Optional configuration settings for the client.
server-client/dist/client.d.ts:30
protected auth: AuthInterface;The authentication instance responsible for generating authentication headers and query parameters.
server-client/dist/client.d.ts:19
protected optional authType: AuthenticationType = AuthenticationType.KEY_SECRET;The type of authentication used for the client's requests.
protected config: ConfigParams;Configuration settings for the client, including default hosts for various services and other request settings.
server-client/dist/client.d.ts:23
static transformers: __module;Static property containing utility transformers.
server-client/dist/client.d.ts:11
addAuthenticationToRequest(request): Promise<VetchOptions>Adds the appropriate authentication headers or parameters to the request based on the authentication type.
• request: VetchOptions
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
Client.addAuthenticationToRequest
server-client/dist/client.d.ts:37
cancel(requestId): Promise<VerifyControlResponse | VerifyControlError>Cancels a specific verification request.
• requestId: string
The request ID of the verification to cancel.
Promise<VerifyControlResponse>
A Promise that resolves to a VerifyControl object containing the control response on success or a VerifyControlError object on error.
If an error occurs while canceling the verification request.
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(requestId, code): Promise<VerifyCheck | VerifyCheckError>Checks the verification code for a specific verification request.
• requestId: string
The request ID of the verification to check.
• code: string
The verification code to check against.
Promise<VerifyCheck>
A Promise that resolves to a VerifyCheck object containing the verification result on success or a VerifyCheckError object on error.
If an error occurs during the verification check.
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.');
}protected parseResponse<T>(request, response): Promise<VetchResponse<T>>Parses the response based on its content type.
• T
The expected type of the parsed response data.
• request: VetchOptions
The request options.
• response: Response
The raw response from the request.
Promise<VetchResponse<T>>
- The parsed response.
server-client/dist/client.d.ts:134
protected prepareBody(request): undefined | stringPrepares the body for the request based on the content type.
• request: VetchOptions
The request options.
undefined | string
- The prepared request body as a string or undefined.
server-client/dist/client.d.ts:124
protected prepareRequest(request): Promise<VetchOptions>Prepares the request with necessary headers, authentication, and query parameters.
• request: VetchOptions
The initial request options.
Promise<VetchOptions>
- The modified request options.
server-client/dist/client.d.ts:117
search(requestId): Promise<VerifySearch | VerifySearchError>Searches for the status of a verification request by its request ID.
• requestId: string
The request ID of the verification to search for.
Promise<VerifySearch>
A VerifySearch object containing the verification details on success or a VerifySearchError object on error.
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(command, requestId): Promise<VerifyControlResponse | VerifyControlError>Sends a control command for a specific verification request.
• command: Command
The control command to send, either "cancel" or "trigger_next_event".
• requestId: string
The request ID of the verification to control.
Promise<VerifyControlResponse>
A Promise that resolves to a VerifyControl object containing the control response on success or a VerifyControlError object on error.
If an error occurs while sending the control command.
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<T>(url): Promise<VetchResponse<T>>Sends a DELETE request to the specified URL.
• T
• url: string
The URL endpoint for the DELETE request.
Promise<VetchResponse<T>>
- The response from the DELETE request.
server-client/dist/client.d.ts:44
sendFormSubmitRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a POST request with form data to the specified URL.
• T
• url: string
The URL endpoint for the POST request.
• payload?: Record<string, string>
Optional payload containing form data to send with the POST request.
Promise<VetchResponse<T>>
- The response from the POST request.
server-client/dist/client.d.ts:52
sendGetRequest<T>(url, queryParams?): Promise<VetchResponse<T>>Sends a GET request to the specified URL with optional query parameters.
• T
• 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.
Promise<VetchResponse<T>>
- The response from the GET request.
server-client/dist/client.d.ts:60
sendPatchRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a PATCH request to the specified URL with an optional payload.
• T
• url: string
The URL endpoint for the PATCH request.
• payload?
Optional payload to be sent as the body of the PATCH request.
Promise<VetchResponse<T>>
- The response from the PATCH request.
server-client/dist/client.d.ts:70
sendPostRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a POST request to the specified URL with an optional payload.
• T
• url: string
The URL endpoint for the POST request.
• payload?
Optional payload to be sent as the body of the POST request.
Promise<VetchResponse<T>>
- The response from the POST request.
server-client/dist/client.d.ts:80
sendPutRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a PUT request to the specified URL with an optional payload.
• T
• url: string
The URL endpoint for the PUT request.
• payload?
Optional payload to be sent as the body of the PUT request.
Promise<VetchResponse<T>>
- The response from the PUT request.
server-client/dist/client.d.ts:90
sendRequest<T>(request): Promise<VetchResponse<T>>Sends a request adding necessary headers, handling authentication, and parsing the response.
• T
• request: VetchOptions
The options defining the request, including URL, method, headers, and data.
Promise<VetchResponse<T>>
- The parsed response from the request.
server-client/dist/client.d.ts:110
sendRequestWithData<T>(
method,
url,
payload?): Promise<VetchResponse<T>>Sends a request with JSON-encoded data to the specified URL using the provided HTTP method.
• T
• method: POST | PUT | PATCH
The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable).
• url: string
The URL endpoint for the request.
• payload?
Optional payload to be sent as the body of the request, JSON-encoded.
Promise<VetchResponse<T>>
- The response from the request.
server-client/dist/client.d.ts:101
start(request): Promise<VerifyRequest | VerifyError>Starts a verification request.
• request: VerificationParameters
The verification parameters for the request.
Promise<VerifyRequest>
A VerifyError object on error or a VerifyRequest object on success.
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
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(requestId): Promise<VerifyControlResponse | VerifyControlError>Triggers the next verification event for a specific verification request.
• requestId: string
The request ID of the verification to trigger the next event for.
Promise<VerifyControlResponse>
A Promise that resolves to a VerifyControl object containing the control response on success or a VerifyControlError object on error.
If an error occurs while triggering the next verification event.
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);
}Represents parameters for a verification request.
brand: string;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 ..."
verify/lib/types/VerificationParams.ts:18
optional codeLength: number;(Optional) The length of the verification code.
verify/lib/types/VerificationParams.ts:38
optional country: string;(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.
verify/lib/types/VerificationParams.ts:25
optional lg: VerifyLanguages;(Optional) The language used for the Verify request.
verify/lib/types/VerificationParams.ts:43
optional nextEventWait: number;(Optional) The wait time in seconds between attempts to deliver the verification code.
verify/lib/types/VerificationParams.ts:55
number: string;The mobile or landline phone number to verify. Unless you are setting country explicitly, this number must be in E.164 format.
verify/lib/types/VerificationParams.ts:11
optional pinCode: string;(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.
verify/lib/types/VerificationParams.ts:70
optional pinExpiry: number;(Optional) How long the generated verification code is valid for, in seconds.
verify/lib/types/VerificationParams.ts:49
optional senderId: string;(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.
verify/lib/types/VerificationParams.ts:33
optional workflowId: VerifyWorkflows;(Optional) Selects the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user.
verify/lib/types/VerificationParams.ts:61
type CheckInformation: SearchEventInformationResponse;Represents the information of a check event response.
Please use SearchEventInformation instead
verify/lib/types/Response/CheckInformation.ts:8
type EventInformation: SearchEventInformationResponse;Represents the event information for a response.
please use SearchEventInformation instead
verify/lib/types/Response/EventInformation.ts:7
type PSD2Parameters: Omit<VerificationParameters, "brand" | "senderId" | "pinCode"> & object;Represents parameters for a PSD2 (Payment Services Directive 2) verification request.
amount: number;The decimal amount of the payment to be confirmed, in Euros.
payee: string;The payee's name or identifier for the payment confirmation.
verify/lib/types/PSD2Parameters.ts:7
type PSD2Request: PSD2Parameters;please use PSD2Parameters
verify/lib/types/PSD2Request.ts:6
type SearchCheckInformationResponse: object;Represents the response data for searching check information.
code: string;The code associated with the check information.
date_received: string;The date when the check information was received.
ip_address: string;The IP address associated with the check information.
status: SearchCheckStatus;The status of the search check.
verify/lib/types/Response/SearchCheckInformationResponse.ts:6
type SearchEventInformationResponse: object;Represents the response for searching event information.
id: string;The ID of the event.
type: SearchEventTypes;The type of the event.
verify/lib/types/Response/SearchEventInformationResponse.ts:6
type UblockRequestResponse: object;Represents the response of an unblock request.
network: string;The network associated with the unblock request.
unblocked_until: string;The date and time until which the unblock is valid.
verify/lib/types/Response/UnblockRequestResponse.ts:7
type VerificationRequest: VerificationParameters;Represents a verification request.
please use VerificationParameters
verify/lib/types/VerificationRequest.ts:8
type VerifyCancelResponse: VerifyControlResponse & object;Represents the response for cancelling a verification request.
command: Command.CANCEL;The command type for the response, which is "CANCEL".
Please use VerifyControlResponse instead
verify/lib/types/Response/VerifyCancelResponse.ts:9
type VerifyCheck: VerifyRequestResponse & object;Represents a Verify Check response.
optional errorText: string;The error message, if any, associated with the Verify Check.
optional estimatedPriceMessagesSent: string;The estimated price for the messages sent during the Verify Check.
optional eventId: string;The unique identifier for the Verify event.
requestId: string;The unique identifier for the Verify request.
verify/lib/types/VerifyCheck.ts:6
type VerifyCheckError: VerifyCheckErrorResponse & object;Represents an error that occurred during the verification check process.
errorId: string;The unique identifier of the error.
requestId: string;The unique identifier of the request.
verify/lib/types/VerifyCheckError.ts:6
type VerifyCheckErrorResponse: object;Represents the response object for a failed verification check.
error_text: string;The error message associated with the failed verification check.
request_id: string;The unique identifier for the verification request.
status: CheckStatus;The status of the verification check.
verify/lib/types/Response/VerifyCheckErrorResponse.ts:6
type VerifyCheckResponse: object;Represents the response object for the Verify Check API.
optional currency: string;The currency of the price.
optional event_id: string;The unique identifier for the verification event.
optional price: string;The price of the verification check.
request_id: string;The unique identifier for the verification request.
status: CheckStatus;The status of the verification check.
verify/lib/types/Response/VerifyCheckResponse.ts:6
type VerifyClassParameters: AuthParams & VetchOptions & object;Represents parameters for configuring the VerifyClass.
optional auth: AuthInterface;(Optional) An authentication interface to use for authentication.
The class will set the correct type
verify/lib/types/VerifyClassParameters.ts:9
type VerifyControl: VerifyControlResponse;Represents the VerifyControl type.
verify/lib/types/VerifyControl.ts:6
type VerifyControlError: object;Represents an error that occurred during the verification control process.
errorText: string;The error message associated with the verification control error.
status: CheckStatus;The status of the verification control.
verify/lib/types/VerifyControlError.ts:6
type VerifyControlErrorResponse: object;Represents an error response for a Verify control operation.
error_text: string;The error text providing more information about the error.
status: CheckStatus;The status code indicating the outcome of the operation.
verify/lib/types/Response/VerifyControlError.ts:6
type VerifyControlResponse: object;Represents the response for a Verify control operation.
command: Command;The command associated with the Verify control operation.
status: string;The status code indicating the outcome of the operation.
verify/lib/types/Response/VerifyControlResponse.ts:6
type VerifyError: VerifyRequest & object;Represents an error response for a Verify operation with additional error-related properties.
errorText: string;The error text providing more information about the error
error_text: string;The error text providing more information about the error.
optional network: string;(Optional) The network associated with the error.
verify/lib/types/VerifyError.ts:7
type VerifyPDS2Response: VerifyRequestResponse;Represents the response for a PSD2 verification request.
verify/lib/types/Response/PSD2RequestResponse.ts:6
type VerifyRequest: VerifyRequestResponse & object;Represents a Verify request with an additional requestId property.
requestId: string;The unique identifier for the Verify request.
verify/lib/types/VerifyRequest.ts:6
type VerifyRequestError: VerifyCheckResponse;Please use VerifyCheckResponse instead
verify/lib/types/Response/VerifyCheckError.ts:6
type VerifyRequestErrorResponse: object;Represents an error response for a Verify request operation.
error_text: string;The error text providing more information about the error.
optional network: string;(Optional) The network associated with the error.
optional request_id: string;(Optional) The unique identifier for the Verify request.
status: string;The status code indicating the outcome of the operation.
verify/lib/types/Response/VerifyRequestError.ts:4
type VerifyRequestResponse: object;Represents the response for a Verify request operation.
request_id: string;The unique identifier for the Verify request.
status: string;The status code indicating the outcome of the operation.
verify/lib/types/Response/VerifyRequestResponse.ts:4
type VerifyResponse: object;Represents the response for a Verify operation.
request_id: string;The unique identifier for the Verify request.
status: CheckStatus;The status code indicating the outcome of the operation.
verify/lib/types/Response/VerifyResponse.ts:6
type VerifySearch: Omit<VerifySearchResponse, "checks"> & object;Represents the response for a Verify search operation.
accountId: string;The Vonage account ID associated with the request.
checks: VerifySearchCheck[];The list of verification checks made for this verification and their outcomes.
dateFinalized: string;The date and time the verification request was completed in the format 'YYYY-MM-DD HH:MM:SS'.
dateSubmitted: string;The date and time the verification request was submitted in the format 'YYYY-MM-DD HH:MM:SS'.
estimatedPriceMessagesSent: string;The estimated cost of messages sent during the verification process.
optional firstEventDate: string;(Optional) The time the first verification attempt was made in the format 'YYYY-MM-DD HH:MM:SS'.
optional lastEventDate: string;(Optional) The time the last verification attempt was made in the format 'YYYY-MM-DD HH:MM:SS'.
requestId: string;The unique identifier for the Verify request.
senderId: string;The sender ID provided in the Verify request.
verify/lib/types/VerifySearch.ts:7
type VerifySearchCheck: VerifyCheckResponse & object;Represents a verification check result as part of a Verify search operation.
dateReceived: string;The date and time this check was received in the format 'YYYY-MM-DD HH:MM:SS'.
ipAddress: string;The IP address associated with this verification check.
verify/lib/types/VerifySearchCheck.ts:6
type VerifySearchError: VerifySearchErrorResponse & object;Represents an error response for a Verify search operation.
errorText: string;A descriptive error message providing more information about the error.
requestId: string;The unique identifier for the Verify request that resulted in an error.
verify/lib/types/VerifySearchError.ts:6
type VerifySearchErrorResponse: object;Represents an error response for a Verify search operation.
error_text: string;The error text providing more information about the error.
request_id: string;The unique identifier for the Verify request.
status: SearchStatus;The status code indicating the outcome of the search operation.
verify/lib/types/Response/VerifySearchErrorResponse.ts:6
type VerifySearchResponse: object;Represents the response for a Verify search operation.
account_id: string;The account ID associated with the request.
checks: SearchCheckInformationResponse[];The list of checks made for this verification and their outcomes.
currency: string;The currency code.
date_finalized: string;The date and time the verification request was completed.
date_submitted: string;The date and time the verification request was submitted.
estimated_price_messages_sent: string;The estimated cost of messages sent for the verification process.
events: SearchEventInformationResponse[];The events that have taken place to verify this number, and their unique identifiers.
first_event_date: string;The time the first verification attempt was made.
last_event_date: string;The time the last verification attempt was made.
number: string;The phone number this verification request was used for.
price: string;The cost incurred for this verification request.
request_id: string;The unique identifier for the Verify request.
sender_id: string;The sender ID provided in the Verify request.
status: SearchStatus;The status code indicating the outcome of the search operation.