-
Notifications
You must be signed in to change notification settings - Fork 178
Vonage Verify v2
Vonage Verify v2 • Docs
Documentation / Vonage Verify v2
Enum representing different communication channels for verification.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
EMAIL |
"email" |
Email channel for verification. | verify2/lib/enums/channels.ts:28 |
SMS |
"sms" |
SMS channel for verification. | verify2/lib/enums/channels.ts:8 |
VOICE |
"voice" |
Voice channel for verification. | verify2/lib/enums/channels.ts:23 |
WHATSAPP |
"whatsapp" |
WhatsApp channel for verification. | verify2/lib/enums/channels.ts:13 |
WHATSAPP_INTERACTIVE |
"whatsapp_interactive" |
Interactive WhatsApp channel for verification. | verify2/lib/enums/channels.ts:18 |
Enum representing the status of an event in the verification process.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
COMPLETED |
"completed" |
The event has been completed successfully. | verify2/lib/enums/eventStatus.ts:8 |
FAILED |
"failed" |
The event has failed. | verify2/lib/enums/eventStatus.ts:13 |
REJECTED |
"rejected" |
The event has been rejected. | verify2/lib/enums/eventStatus.ts:23 |
USER_REJECTED |
"user_rejected" |
The user has rejected the event. | verify2/lib/enums/eventStatus.ts:18 |
Enum representing the status of a verification request.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
COMPLETED |
"completed" |
The verification request has been completed successfully. | verify2/lib/enums/requestStatus.ts:8 |
EXPIRED |
"expired" |
The verification request has expired. | verify2/lib/enums/requestStatus.ts:18 |
FAILED |
"failed" |
The verification request has failed. | verify2/lib/enums/requestStatus.ts:13 |
Enum representing the status of a verification request workflow step.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
COMPLETED |
"completed" |
The workflow step has been completed successfully. | verify2/lib/enums/requestWorkflowsStatus.ts:13 |
EXPIRED |
"expired" |
The workflow step has expired. | verify2/lib/enums/requestWorkflowsStatus.ts:23 |
FAILED |
"failed" |
The workflow step has failed. | verify2/lib/enums/requestWorkflowsStatus.ts:18 |
UNUSED |
"unused" |
The workflow step is unused. | verify2/lib/enums/requestWorkflowsStatus.ts:8 |
USER_REJECTED |
"user_rejected" |
The user has rejected the workflow step. | verify2/lib/enums/requestWorkflowsStatus.ts:28 |
Enum representing the status of Silent Authentication.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
ACTION_PENDING |
"action_pending" |
An action is pending for Silent Authentication. | verify2/lib/enums/silentAuthStatus.ts:28 |
COMPLETED |
"completed" |
Silent Authentication has been completed successfully. | verify2/lib/enums/silentAuthStatus.ts:8 |
EXPIRED |
"expired" |
Silent Authentication has expired. | verify2/lib/enums/silentAuthStatus.ts:23 |
FAILED |
"failed" |
Silent Authentication has failed. | verify2/lib/enums/silentAuthStatus.ts:13 |
USER_REJECTED |
"user_rejected" |
The user has rejected Silent Authentication. | verify2/lib/enums/silentAuthStatus.ts:18 |
Enum representing the Silent Authentication channel.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
SILENT_AUTH |
"silent_auth" |
Silent Authentication channel for verification. | verify2/lib/enums/channels.ts:38 |
Enum representing different locales for verification.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
DE_DE |
"de-de" |
German (Germany) locale. | verify2/lib/enums/verifyLocale.ts:43 |
EN_GB |
"en-gb" |
English (United Kingdom) locale. | verify2/lib/enums/verifyLocale.ts:13 |
EN_US |
"en-us" |
English (United States) locale. | verify2/lib/enums/verifyLocale.ts:8 |
ES_ES |
"es-es" |
Spanish (Spain) locale. | verify2/lib/enums/verifyLocale.ts:18 |
ES_MX |
"es-mx" |
Spanish (Mexico) locale. | verify2/lib/enums/verifyLocale.ts:23 |
ES_US |
"es-us" |
Spanish (United States) locale. | verify2/lib/enums/verifyLocale.ts:28 |
FR_FR |
"fr-fr" |
French (France) locale. | verify2/lib/enums/verifyLocale.ts:38 |
HI_IN |
"hi-in" |
Hindi (India) locale. | verify2/lib/enums/verifyLocale.ts:53 |
ID_ID |
"id-id" |
Indonesian (Indonesia) locale. | verify2/lib/enums/verifyLocale.ts:68 |
IT_IT |
"it-it" |
Italian (Italy) locale. | verify2/lib/enums/verifyLocale.ts:33 |
PT_BR |
"pt-br" |
Portuguese (Brazil) locale. | verify2/lib/enums/verifyLocale.ts:58 |
PT_PT |
"pt-pt" |
Portuguese (Portugal) locale. | verify2/lib/enums/verifyLocale.ts:63 |
RU_RU |
"ru-ru" |
Russian (Russia) locale. | verify2/lib/enums/verifyLocale.ts:48 |
A class for interacting with the Vonage Verify API (Version 2).
new Verify2(credentials, options?): Verify2Creates a new instance of the Client.
• credentials: AuthInterface | AuthParams
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 authType: AuthenticationType = AuthenticationType.JWT;The authentication type used for this client (JWT).
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<boolean>Cancels a verification request.
• requestId: string
The ID of the verification request to cancel.
Promise<boolean>
true if the cancellation was successful.
checkCode(requestId, code): Promise<string>Checks a verification code against a verification request.
• requestId: string
The ID of the verification request.
• code: string
The verification code to check.
Promise<string>
The status of the verification code check.
newRequest(params): Promise<Request>Creates a new verification request.
• params: VerificationRequestParams
The parameters for the verification request.
Promise<Request>
A Request object containing the request ID.
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
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
type CheckCodeRequest: object;Represents a request to check a code against a verification request.
code: string;The code to be checked against the verification request.
verify2/lib/types/checkCodeRequest.ts:4
type CheckRequestResponse: object;Represents the response for checking a code against a verification request.
request_id: string;The ID of the verification request.
status: string;The status of the verification request.
verify2/lib/types/checkRequestResponse.ts:4
type EmailWorkflow: object;Represents a workflow for sending a verification code via email.
channel: Channels.EMAIL;The communication channel for sending the verification code.
optional from: string;(Optional) The sender's email address for the verification email.
to: string;The recipient's email address where the verification code will be sent.
verify2/lib/types/emailWorkflow.ts:6
type EventCallback: object;Represents an event callback received for a verification request.
channel: Channels;The communication channel for the verification request.
optional client_ref: string;(Optional) The client reference given in the original Verify request.
finalized_at: string;The date and time when the verification request was completed in ISO 8601 format.
request_id: string;The ID of the verification request associated with the event.
status: EventStatus;The status of the event.
triggerd_at: string;The date and time when the event was triggered in ISO 8601 format.
type: string;The type of response for the event.
verify2/lib/types/eventCallback.ts:6
type Request: object;Represents a request object with a unique request ID.
optional checkUrl: string;The URL to check the status of the request.
requestId: string;The unique identifier for the request.
verify2/lib/types/request.ts:4
type RequestStatusCallback: object;Represents a callback received for the status update of a verification request.
channel_timeout: number;The number of seconds before the current step in the verification request times out.
request_id: string;The ID of the verification request associated with the callback.
status: RequestStatus;The status of the verification request.
submitted_at: string;The date and time when the verification request was submitted in ISO 8601 format.
type: string;The type of response for the callback.
workflow: RequestStatusCallbackWorkflow[];An array of workflow details for the verification request.
verify2/lib/types/requestStatusCallback.ts:8
type RequestStatusCallbackWorkflow: object;Represents a workflow step within a verification request's status callback.
channel: Channels;The communication channel associated with this workflow step.
initiated_at: string;The date and time when this workflow step was initiated in ISO 8601 format.
status: RequestWorkflowStatus;The status of this workflow step within the verification request.
verify2/lib/types/requestStatusCallbackWorkflow.ts:6
type SMSWorkflow: object;Represents a workflow for sending a verification code via SMS.
optional appHash: string;(Optional) An application-specific hash value for the SMS workflow.
channel: Channels.SMS;The communication channel for sending the verification code.
optional contentId: string;Optional value corresponding to a TemplateID for SMS delivery using Indian Carriers
optional entityId: string;Optional PEID required for SMS delivery using Indian Carriers
optional from: string;An optional sender number, in the E.164 format. Don't use a leading + or 00 when entering a phone number, start with the country code, for example, 447700900000.
If no from number is given, the request will default to the brand.
to: string;The recipient's phone number where the verification code will be sent, in the E.164 format.
verify2/lib/types/smsWorkflow.ts:6
type SMSWorkflowRequest: object & Omit<SMSWorkflow, "appHash">;optional app_hash: string;optional content_id: string;optional entity_id: string;verify2/lib/types/verifcationRequest.ts:9
type SilenAuthChannel: SilentAuthChannel;Type alias for the Silent Authentication channel.
verify2/lib/enums/channels.ts:44
type SilentAuthCallback: object;Represents a callback received for Silent Authentication.
action: object;Information about the action in the Silent Authentication event.
action.check_url: string;The URL for Silent Authentication Verify workflow completion.
action.type: "check";The type of action, which is 'check' for Silent Authentication.
channel: SilentAuthChannel.SILENT_AUTH;The communication channel for Silent Authentication (always 'silent_auth').
request_id: string;The ID of the Silent Authentication request associated with the callback.
status: SilenAuthStatus;The status of the Silent Authentication event.
triggerd_at: string;The date and time when the Silent Authentication event was triggered in ISO 8601 format.
type: string;The type of response for the Silent Authentication event.
verify2/lib/types/silentAuthCallback.ts:6
type SilentAuthWorkflow: object;Represents a workflow for Silent Authentication.
channel: SilentAuthChannel;The communication channel for Silent Authentication.
redirectUrl: string;The redirect URL for Silent Authentication.
to: string;The target identifier for Silent Authentication.
verify2/lib/types/silentAuthWorkflow.ts:6
type SilentAuthWorkflowRequest: object & Omit<SilentAuthWorkflow, "redirectUrl">;redirect_url: string;verify2/lib/types/verifcationRequest.ts:17
type VerificationRequest: object;Represents a verification request for sending verification codes via different communication channels.
brand: string;The brand associated with the verification request.
optional channel_timeout: number;(Optional) The timeout duration for the verification channel in seconds.
optional client_ref: string;(Optional) The client reference associated with the verification request.
optional code: string;(Optional) The verification code to be sent.
optional code_length:
| 4
| 5
| 6
| 7
| 8
| 9
| 10;(Optional) The length of the verification code, if not provided, defaults to 4 digits.
optional fraud_check: boolean;(Optional) Indicates whether fraud checking is enabled for the verification request.
optional locale: VerifyLocale | string;(Optional) The locale for the verification request.
workflow: (
| EmailWorkflow
| SMSWorkflowRequest
| SilentAuthWorkflowRequest
| VoiceWorkflow
| WhatsAppInteractiveWorkflow
| WhatsAppWorkflow)[];An array of workflow configurations for sending verification codes via different channels. Each element in the array corresponds to a specific channel workflow.
verify2/lib/types/verifcationRequest.ts:24
type VerificationRequestParams: object;Represents parameters for creating a verification request for sending verification codes via different communication channels.
brand: string;The brand associated with the verification request.
optional channelTimeout: number;(Optional) The timeout duration for the verification channel in seconds.
optional clientRef: string;(Optional) The client reference associated with the verification request.
optional code: string;(Optional) The verification code to be sent.
optional codeLength:
| 4
| 5
| 6
| 7
| 8
| 9
| 10;(Optional) The length of the verification code, if not provided, defaults to 4 digits.
optional fraudCheck: boolean;(Optional) Indicates whether fraud checking is enabled for the verification request.
optional locale: VerifyLocale | string;(Optional) The locale for the verification request.
workflow: (
| EmailWorkflow
| SMSWorkflow
| SilentAuthWorkflow
| VoiceWorkflow
| WhatsAppInteractiveWorkflow
| WhatsAppWorkflow)[];An array of workflow configurations for sending verification codes via different channels. Each element in the array corresponds to a specific channel workflow.
verify2/lib/types/verifcationRequestParams.ts:13
type VerificationResponse: object;Represents a response for a verification request.
optional check_url: string;The URL for checking the status of the verification request.
request_id: string;The unique identifier for the verification request.
verify2/lib/types/verificationResponse.ts:4
type VerifyErrors: object & GenericErrors;Type representing possible errors related to verification requests.
CONFLICT: "conflict";Indicates a conflict error in the verification request.
EXPIRED: "expired";Indicates that the verification request has expired.
verify2/lib/enums/verifyErrors.ts:6
type VoiceWorkflow: object;Represents a workflow for sending a verification code via voice call.
channel: Channels.VOICE;The communication channel for sending the verification code.
to: string;The recipient's phone number where the verification code will be sent, in the E.164 format.
verify2/lib/types/voiceWorkflow.ts:6
type WhatsAppInteractiveWorkflow: object;Represents a workflow for sending a verification code via interactive WhatsApp.
channel: Channels.WHATSAPP_INTERACTIVE;The communication channel for sending the verification code.
to: string;The recipient's phone number where the verification code will be sent, typically in the E.164 format.
verify2/lib/types/whatsAppInteractiveWorkflow.ts:7
type WhatsAppWorkflow: object;Represents a workflow for sending a verification code via WhatsApp.
channel: Channels.WHATSAPP;The communication channel for sending the verification code.
optional from: string;(Optional) The sender's phone number or identifier for the WhatsApp message.
to: string;The recipient's phone number where the verification code will be sent, typically in the E.164 format.