Search for a Verify Request

You can use the search functionality to see the current status or eventual outcome of a Verify request, using the request_id returned when the verify code was sent.

Replace the following variables in the sample code with your own values:

Key	Description
`VONAGE_API_KEY`	Your Vonage API key (see it on your dashboard).
`VONAGE_API_SECRET`	Your Vonage API secret (also available on your dashboard).
`REQUEST_ID`	The ID of the Verify request (this is returned in the API response when you send a verification code)

Write the code

Add the following to search-for-verify-request.sh:

curl -X GET "https://api.nexmo.com/verify/search/json?&api_key=$VONAGE_API_KEY&api_secret=$VONAGE_API_SECRET&request_id=$REQUEST_ID"

View full source

Run your code

Save this file to your machine and run it:

sh search-for-verify-request.sh

Prerequisites

npm install @vonage/server-sdk

Create a file named search.js and add the following code:

const Vonage = require('@vonage/server-sdk');
const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET
});

View full source

Write the code

Add the following to search.js:

vonage.verify.search(REQUEST_ID, (err, result) => {
  if (err) {
    console.error(err);
  } else {
    console.log('Request status:', result.status);
  }
});

View full source

Run your code

Save this file to your machine and run it:

node search.js

Prerequisites

Add the following to `build.gradle`:

compile 'com.vonage:client:6.2.0'

Create a class named SearchVerification and add the following code to the main method:

VonageClient client = VonageClient.builder()
        .apiKey(VONAGE_API_KEY)
        .apiSecret(VONAGE_API_SECRET)
        .build();

View full source

Write the code

Add the following to the main method of the SearchVerification class:

VerifyClient verifyClient = client.getVerifyClient();

SearchVerifyResponse response = verifyClient.search(REQUEST_ID);
if (response.getStatus() == VerifyStatus.OK) {
    response.getVerificationRequests().forEach(it -> {
        System.out.println(it.getRequestId() + " " + it.getStatus());
    });
}

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

  apply plugin: 'application'
  mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.verify with the package containing SearchVerification:

gradle run -Pmain=com.vonage.quickstart.verify.SearchVerification

Prerequisites

Install-Package Vonage

Create a file named SearchVerificationRequest.cs and add the following code:

using Vonage;
using Vonage.Request;
using Vonage.Verify;

View full source

Add the following to SearchVerificationRequest.cs:

var credentials = Credentials.FromApiKeyAndSecret(VONAGE_API_KEY, VONAGE_API_SECRET);
var client = new VonageClient(credentials);

View full source

Write the code

Add the following to SearchVerificationRequest.cs:

var request = new VerifySearchRequest() { RequestId = REQUEST_ID };
var response = client.VerifyClient.VerifySearch(request);

View full source

Prerequisites

composer require vonage/client

Create a file named search.php and add the following code:

$basic  = new \Vonage\Client\Credentials\Basic(VONAGE_API_KEY, VONAGE_API_SECRET);
$client = new \Vonage\Client(new \Vonage\Client\Credentials\Container($basic));

View full source

Write the code

Add the following to search.php:

try {
    $result = $client->verify()->search(REQUEST_ID);
    echo "Request has a status of " . $result->getStatus() . PHP_EOL;
} catch (\Vonage\Client\Exception\Request $e) {
    error_log("Client error: " . $e->getMessage());
    exit(1);
} catch (\Vonage\Client\Exception\Server $e) {
    error_log("Server error: " . $e->getMessage());
    exit(1);
}

View full source

Run your code

Save this file to your machine and run it:

php search.php

Prerequisites

pip install vonage

Create a file named search.py and add the following code:

verify = Verify(
        Client(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
    )

View full source

Write the code

Add the following to search.py:

response = verify.search(REQUEST_ID)

if response is not None:
    print(response['status'])
else:
    print(f'{REQUEST_ID} was not found')

View full source

Run your code

Save this file to your machine and run it:

python search.py

Prerequisites

gem install vonage

Create a file named search.rb and add the following code:

client = Vonage::Client.new(
  api_key: VONAGE_API_KEY,
  api_secret: VONAGE_API_SECRET
)

View full source

Write the code

Add the following to search.rb:

response = client.verify.search(request_id: REQUEST_ID)

if response
  # The current status of this request, for example:
  # => IN PROGRESS
  puts response.status
end

View full source

Run your code

Save this file to your machine and run it:

ruby search.rb

Improve this page