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"
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
}, {
debug: true
});
Write the code
Add the following to check.js
:
vonage.verify.check({
request_id: REQUEST_ID,
code: CODE
}, (err, result) => {
if (err) {
console.error(err);
} else {
console.log(result);
}
});
Run your code
Save this file to your machine and run it:
node check.js
Prerequisites
Add the following to `build.gradle`:
compile 'com.vonage:client:5.5.0'
Create a class named CheckVerification
and add the following code to the main
method:
VonageClient client = VonageClient.builder().apiKey(VONAGE_API_KEY).apiSecret(VONAGE_API_SECRET).build();
Write the code
Add the following to the main
method of the CheckVerification
class:
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());
}
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;
Add the following to CheckVerificationRequest.cs
:
var credentials = Credentials.FromApiKeyAndSecret(VONAGE_API_KEY, VONAGE_API_SECRET);
var client = new VonageClient(credentials);
Write the code
Add the following to CheckVerificationRequest.cs
:
var request = new VerifyCheckRequest() { Code = CODE, RequestId = REQUEST_ID };
var response = client.VerifyClient.VerifyCheck(request);
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));
Write the code
Add the following to verify.php
:
$result = $client->verify()->check(REQUEST_ID, CODE);
var_dump($result->getResponseData());
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:
verify = vonage.Verify(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
Write the code
Add the following to check.py
:
response = verify.check(REQUEST_ID, code=CODE)
if response["status"] == "0":
print("Verification successful, event_id is %s" % (response["event_id"]))
else:
print("Error: %s" % response["error_text"])
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
)
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
Run your code
Save this file to your machine and run it:
ruby check.rb