Package com.vonage.client.verify

Class VerifyClient

java.lang.Object

com.vonage.client.verify.VerifyClient

public class VerifyClient
extends Object

A client for talking to the Vonage Verify API. The standard way to obtain an instance of this class is to use VonageClient.getVerifyClient().

Send a verification request with a call to verify, confirm the code entered by the user with check, and search in-progress or completed verification requests with search

More information on method parameters can be found on the Vonage developer portal.

Constructor Summary

Constructors

Constructor	Description
VerifyClient(HttpWrapper wrapper)	Constructor.

Method Summary

Modifier and Type	Method	Description
ControlResponse	advanceVerification(String requestId)	Advance a current verification request to the next stage in the process.
ControlResponse	cancelVerification(String requestId)	Cancel a current verification request.
CheckResponse	check(CheckRequest request)	Deprecated. Use check(String, String).
CheckResponse	check(String requestId, String code)	Validate a code provided by a user in response to a call from verify.
VerifyResponse	psd2Verify(Psd2Request psd2Request)	Send a PSD2 verification request to a phone number with optional parameters
VerifyResponse	psd2Verify(String number, Double amount, String payee)	Send a PSD2 compliant payment token to a user for payment authorization
VerifyResponse	psd2Verify(String number, Double amount, String payee, Psd2Request.Workflow workflow)	Send a PSD2 compliant payment token to a user for payment authorization with a pin verification workflow
SearchVerifyResponse	search(String requestId)	Search for a previous verification request.
SearchVerifyResponse	search(String... requestIds)	Search for a previous verification request.
VerifyResponse	verify(VerifyRequest request)	Send a verification request to a phone number.
VerifyResponse	verify(String number, String brand)	Send a verification request to a phone number.
VerifyResponse	verify(String number, String brand, VerifyRequest.Workflow workflow)	Send a verification request to a phone number with a pin verification workflow
VerifyResponse	verify(String number, String brand, String from)	Send a verification request to a phone number.
VerifyResponse	verify(String number, String brand, String from, int length, Locale locale)	Send a verification request to a phone number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VerifyClient

public VerifyClient(HttpWrapper wrapper)

Constructor.

Parameters:

wrapper - (required) shared HTTP wrapper object used for making REST calls.

Method Details

verify

public VerifyResponse verify(String number,
 String brand)
                      throws VonageResponseParseException,
VonageClientException

Send a verification request to a phone number.

Parameters:

number - (required) The recipient's phone number in E.164 format.

brand - (required) The name of the company or app to be verified for. Must not be longer than 18 characters.

Returns:

a VerifyResponse representing the response received from the Verify API call.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

verify

public VerifyResponse verify(String number,
 String brand,
 VerifyRequest.Workflow workflow)
                      throws VonageResponseParseException,
VonageClientException

Send a verification request to a phone number with a pin verification workflow

Parameters:

number - (required) The recipient's phone number in E.164 format.

brand - (required) The name of the company or app to be verified for. Must not be longer than 18 characters.

workflow - workflow to use for sending verification pin

Returns:

a VerifyResponse representing the response received from the Verify API call.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

Since:

5.5.0

verify

public VerifyResponse verify(String number,
 String brand,
 String from)
                      throws VonageClientException,
VonageResponseParseException

Send a verification request to a phone number.

Parameters:

number - (required) The recipient's phone number in E.164 format.

brand - (required) The name of the company or app to be verified for. Must not be longer than 18 characters.

from - (optional The Vonage number to use as the sender for the verification SMS message and calls, in E.164 format.

Returns:

a VerifyResponse representing the response received from the Verify API call.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

verify

public VerifyResponse verify(String number,
 String brand,
 String from,
 int length,
 Locale locale)
                      throws VonageClientException,
VonageResponseParseException

Send a verification request to a phone number.

Parameters:

number - (required) The recipient's phone number in E.164 format.

brand - (required) The name of the company or app to be verified for. Must not be longer than 18 characters.

from - (optional The Vonage number to use as the sender for the verification SMS message and calls, in E.164 format.

length - (optional) The length of the verification code to be sent to the user. Must be either 4 or 6. Use -1 to use the default value.

locale - (optional) Override the default locale used for verification. By default the locale is determined from the country code included in number

Returns:

a VerifyResponse representing the response received from the Verify API call.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

verify

public VerifyResponse verify(VerifyRequest request)
                      throws VonageClientException,
VonageResponseParseException

Send a verification request to a phone number.

Parameters:

request - validation request for the 2FA verification.

Returns:

a VerifyResponse representing the response received from the Verify API call.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

check

@Deprecated
public CheckResponse check(CheckRequest request)
                    throws VonageClientException,
VonageResponseParseException

Deprecated.

Use check(String, String).

Validate a code provided by a user in response to a call from verify.

Parameters:

request - The request to send for validation.

Returns:

a CheckResponse representing the response received from the API call.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

check

public CheckResponse check(String requestId,
 String code)
                    throws VonageClientException,
VonageResponseParseException

Validate a code provided by a user in response to a call from verify.

Parameters:

requestId - (required) The requestId returned by the verify call.

code - (required) The code entered by the user.

Returns:

a CheckResponse representing the response received from the API call.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

search

public SearchVerifyResponse search(String requestId)
                            throws VonageClientException,
VonageResponseParseException

Search for a previous verification request.

Parameters:

requestId - The requestId of a single Verify request to be looked up.

Returns:

A SearchVerifyResponse containing the details of the Verify request that was looked up, or null if no record was found.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

search

public SearchVerifyResponse search(String... requestIds)
                            throws VonageClientException,
VonageResponseParseException

Search for a previous verification request.

Parameters:

requestIds - The requestIds of Verify requests to be looked up.

Returns:

An array SearchVerifyResponse for each record that was found.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

advanceVerification

public ControlResponse advanceVerification(String requestId)
                                    throws VonageClientException,
VonageResponseParseException

Advance a current verification request to the next stage in the process.

Parameters:

requestId - The requestId of the ongoing verification request.

Returns:

A ControlResponse representing the response from the API.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

cancelVerification

public ControlResponse cancelVerification(String requestId)
                                   throws VonageClientException,
VonageResponseParseException

Cancel a current verification request.

Parameters:

requestId - The requestId of the ongoing verification request.

Returns:

A ControlResponse representing the response from the API.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

psd2Verify

public VerifyResponse psd2Verify(String number,
 Double amount,
 String payee)
                          throws VonageClientException,
VonageResponseParseException

Send a PSD2 compliant payment token to a user for payment authorization

Parameters:

number - Telephone number to verify, in E.164 format

amount - payment amount

payee - name of the person the payment is for. Name will be included in the message

Returns:

A VerifyResponse representing the response from the API.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

Since:

5.5.0

psd2Verify

public VerifyResponse psd2Verify(String number,
 Double amount,
 String payee,
 Psd2Request.Workflow workflow)
                          throws VonageClientException,
VonageResponseParseException

Send a PSD2 compliant payment token to a user for payment authorization with a pin verification workflow

Parameters:

number - telephone number to verify, in E.164 format

amount - payment amount

payee - name of the person the payment is for. Name will be included in the message

workflow - workflow to use for sending verification pin

Returns:

A VerifyResponse representing the response from the API.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

Since:

5.5.0

psd2Verify

public VerifyResponse psd2Verify(Psd2Request psd2Request)
                          throws VonageClientException,
VonageResponseParseException

Send a PSD2 verification request to a phone number with optional parameters

Parameters:

psd2Request - request to send PSD2 verification to a phone.

Returns:

A VerifyResponse representing the response from the API.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

Since:

5.5.0