Introducing the Verify API

This article will explain how to set up Verify API to utilize within the Telnyx Portal.

Telnyx Engineering avatar
Written by Telnyx Engineering
Updated over a week ago

Verify API has reduced all of the unnecessary steps for sending 2FA codes to devices, making it easier than ever to secure login requests, confirm account changes, and authenticate devices.

It takes just two steps in our portal to set up a 2FA profile with Telnyx Verify API.

  • Step 1: Create a 2FA profile that contains the configurations for sending out two factor authentication codes.

  • Step 2: Create a 2FA verification using the 2FA profile ID and the end user’s phone number.

To get started, you can access our in-depth documentation here. SDK updates on Python, Ruby, Node, PHP, Java, and .NET coming soon.

Creating Verify Profile

To begin, navigate to your Telnyx admin portal and click on the Verify Icon as shown below.

Verify profiles page.

On the page click on New Verify Profile icon.

Verify profile icon settings page.

Enter your Profile Name and click Create. You have now made a Verify Profile.

Verify profile credentials page.

Creating Verify API

To begin, navigate to your Telnyx admin portal and click on the Verify Icon as shown below.

Telnyx Admin portal.

Now enter the tab at the top of the page, Learn & Build to configure the Verify API.

Learn and Build tab.

Check Step 1 to verify that the Verification Profile you have chosen is the correct profile. For example purposes we have chosen TelnyxTest as our Verification Profile. Once you have chosen your desired Verification Profile click Next: Send a Verification Code to proceed to Step 2.

Profile verification section of the Learn and Build tab.

You will be presented with the following field:

  • Fill in the Phone Number Receipt with the phone number you desire.

Once completed click on the icon Send Verification Code to send a verification to the desired phone number.

Verification code page.

Now enter the received Verification Code into the following field and hit Verify. You have now sent and verified your first verification through Telnyx Verify API!

A detailed workflow including expected API webhook responses is shown here.

Other general information relating to this API.

Verify API now offers Voice and Flash Call as channels for sending 2FA codes

The new features supported are:

  • Delivering a verification code through voice call

  • Delivering a verification code through flash call

  • Delivering a verification code specific to the PSD2 use case

  • Specifying the language for a verification code delivered through voice call or SMS

With these new features, we introduced some changes to the verification API while doing our best to maintain backward compatibility. Users who have already integrated with the API should read the release notes carefully and make the appropriate planning to accommodate the changes.

Did this answer your question?