com.nexmo.client.verify

Class VerifyClient

java.lang.Object

com.nexmo.client.AbstractClient

com.nexmo.client.verify.VerifyClient

public class VerifyClient
extends AbstractClient

A client for talking to the Nexmo Verify API. The standard way to obtain an instance of this class is to use NexmoClient.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 at Nexmo website: https://docs.nexmo.com/verify

Field Summary

Fields inherited from class com.nexmo.client.AbstractClient

httpWrapper

Constructor Summary

Constructors

Constructor and Description
VerifyClient(HttpWrapper httpWrapper) Constructor.

Method Summary

Modifier and Type	Method and Description
ControlResponse	advanceVerification(java.lang.String requestId) Advance a current verification request to the next stage in the process.
ControlResponse	cancelVerification(java.lang.String requestId) Cancel a current verification request.
CheckResponse	check(java.lang.String requestId, java.lang.String code) Validate a code provided by a user in response to a call from verify.
CheckResponse	check(java.lang.String requestId, java.lang.String code, java.lang.String ipAddress) 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(java.lang.String number, java.lang.Double amount, java.lang.String payee) Send a PSD2 compliant payment token to a user for payment authorization
VerifyResponse	psd2Verify(java.lang.String number, java.lang.Double amount, java.lang.String payee, Psd2Request.Workflow workflow) Send a PSD2 compliant payment token to a user for payment authorization with a pin verification workflow
SearchVerifyResponse	search(java.lang.String... requestIds) Search for a previous verification request.
SearchVerifyResponse	search(java.lang.String requestId) Search for a previous verification request.
VerifyResponse	verify(java.lang.String number, java.lang.String brand) Send a verification request to a phone number.
VerifyResponse	verify(java.lang.String number, java.lang.String brand, java.lang.String from) Send a verification request to a phone number.
VerifyResponse	verify(java.lang.String number, java.lang.String brand, java.lang.String from, int length, java.util.Locale locale) Send a verification request to a phone number.
VerifyResponse	verify(java.lang.String number, java.lang.String brand, java.lang.String from, int length, java.util.Locale locale, VerifyRequest.LineType type) Send a verification request to a phone number.
VerifyResponse	verify(java.lang.String number, java.lang.String brand, VerifyRequest.Workflow workflow) Send a verification request to a phone number with a pin verification workflow
VerifyResponse	verify(VerifyRequest request) 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 Detail

VerifyClient

public VerifyClient(HttpWrapper httpWrapper)

Constructor.

Parameters:

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

Method Detail

verify

public VerifyResponse verify(java.lang.String number,
                             java.lang.String brand)
                      throws NexmoResponseParseException,
                             NexmoClientException

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:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

verify

public VerifyResponse verify(java.lang.String number,
                             java.lang.String brand,
                             VerifyRequest.Workflow workflow)
                      throws NexmoResponseParseException,
                             NexmoClientException

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:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

Since:

5.5.0

verify

public VerifyResponse verify(java.lang.String number,
                             java.lang.String brand,
                             java.lang.String from)
                      throws NexmoClientException,
                             NexmoResponseParseException

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

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

verify

public VerifyResponse verify(java.lang.String number,
                             java.lang.String brand,
                             java.lang.String from,
                             int length,
                             java.util.Locale locale)
                      throws NexmoClientException,
                             NexmoResponseParseException

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

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

verify

public VerifyResponse verify(java.lang.String number,
                             java.lang.String brand,
                             java.lang.String from,
                             int length,
                             java.util.Locale locale,
                             VerifyRequest.LineType type)
                      throws NexmoClientException

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

type - (optional) If provided, restrict the verification to the specified network type. Contact support@nexmo.com to enable this feature.

Returns:

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

Throws:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

verify

public VerifyResponse verify(VerifyRequest request)
                      throws NexmoClientException,
                             NexmoResponseParseException

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:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

check

public CheckResponse check(java.lang.String requestId,
                           java.lang.String code)
                    throws NexmoClientException,
                           NexmoResponseParseException

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:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

check

public CheckResponse check(java.lang.String requestId,
                           java.lang.String code,
                           java.lang.String ipAddress)
                    throws NexmoClientException,
                           NexmoResponseParseException

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.

ipAddress - (optional) The IP address obtained from the HTTP request made when the user entered their code.

Returns:

a CheckResponse representing the response received from the API call.

Throws:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

search

public SearchVerifyResponse search(java.lang.String requestId)
                            throws NexmoClientException,
                                   NexmoResponseParseException

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:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

search

public SearchVerifyResponse search(java.lang.String... requestIds)
                            throws NexmoClientException,
                                   NexmoResponseParseException

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:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

advanceVerification

public ControlResponse advanceVerification(java.lang.String requestId)
                                    throws NexmoClientException,
                                           NexmoResponseParseException

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:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

cancelVerification

public ControlResponse cancelVerification(java.lang.String requestId)
                                   throws NexmoClientException,
                                          NexmoResponseParseException

Cancel a current verification request.

Parameters:

requestId - The requestId of the ongoing verification request.

Returns:

A ControlResponse representing the response from the API.

Throws:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

psd2Verify

public VerifyResponse psd2Verify(java.lang.String number,
                                 java.lang.Double amount,
                                 java.lang.String payee)
                          throws NexmoClientException,
                                 NexmoResponseParseException

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:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

Since:

5.5.0

psd2Verify

public VerifyResponse psd2Verify(java.lang.String number,
                                 java.lang.Double amount,
                                 java.lang.String payee,
                                 Psd2Request.Workflow workflow)
                          throws NexmoClientException,
                                 NexmoResponseParseException

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:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

Since:

5.5.0

psd2Verify

public VerifyResponse psd2Verify(Psd2Request psd2Request)
                          throws NexmoClientException,
                                 NexmoResponseParseException

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

Parameters:

psd2Request - request to to send PSD2 verification to a phone.

Returns:

A VerifyResponse representing the response from the API.

Throws:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

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

Since:

5.5.0