Check verification code

Check the verification code that a user has provided. Use the request_id that was received when the verification code was sent.

Note: You should always check the verification code after sending it. This enables Vonage to determine the number of successful requests and protect against fraudulent use of the platform

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)
`CODE`	The code the user supplies as having been sent to them

Write the code

Add the following to send-verification-code.sh:

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

View full source

Run your code

Save this file to your machine and run it:

sh send-verification-code.sh

Prerequisites

npm install @vonage/server-sdk

Create a file named check.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 check.js:

vonage.verify.check(REQUEST_ID, CODE)
  .then((resp) => console.log(resp))
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node check.js

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk-kotlin:1.1.2'

Create a file named CheckVerification and add the following code to the main method:

val client = Vonage {
    apiKey(VONAGE_API_KEY)
    apiSecret(VONAGE_API_SECRET)
}

View full source

Write the code

Add the following to the main method of the CheckVerification file:

val response = client.verifyLegacy.request(REQUEST_ID).check(CODE)
if (response.status == VerifyStatus.OK) {
    println("Code matched. Verification successful.")
}
else {
    println("Verification failed: ${response.errorText}")
}

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.kt.verify.legacy with the package containing CheckVerification:

gradle run -Pmain=com.vonage.quickstart.kt.verify.legacy.CheckVerification

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk:8.15.1'

Create a file named CheckVerification 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 CheckVerification file:

CheckResponse response = client.getVerifyClient().check(REQUEST_ID, CODE);

if (response.getStatus() == VerifyStatus.OK) {
    System.out.println("Verification Successful");
}
else {
    System.out.println("Verification failed: " + response.getErrorText());
}

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

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

Prerequisites

Install-Package Vonage

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

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

View full source

Add the following to CheckVerificationRequest.cs:


var credentials = Credentials.FromApiKeyAndSecret(vonageApiKey, vonageApiSecret);

View full source

Write the code

Add the following to CheckVerificationRequest.cs:


var request = new VerifyCheckRequest() { Code = code, RequestId = requestId };

View full source

Prerequisites

composer require vonage/client

Create a file named verify.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 verify.php:

$result = $client->verify()->check(REQUEST_ID, CODE);

var_dump($result->getResponseData());

View full source

Run your code

Save this file to your machine and run it:

php verify.php

Prerequisites

pip install vonage

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

View full source

Write the code

Add the following to check.py:

View full source

Run your code

Save this file to your machine and run it:

python check.py

Prerequisites

gem install vonage

Create a file named check.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 check.rb:

response = client.verify.check(
  request_id: REQUEST_ID,
  code: CODE
)

# when the check is successful
if response
  # the cost of this verification
  puts response.price
  # the currency ofthe cost
  puts response.currency
end

View full source

Run your code

Save this file to your machine and run it:

ruby check.rb