Verify API - Generally Available [RELEASE NOTES]
23, Jun 2021
Verify API Product Release Notes
Today we’re making our Verify API generally available to everyone. Since launching our Verify Beta last December, we’ve received a lot of great feedback from our early users.
That’s why in addition to adding Flash Call & Voice channels back in May, we’ve now included verification via WhatsApp and integrated payment details for PSD2 compliant authentications.
Also, to be more in line with industry demands, we’ve changed our billing from an API request model to a ‘pay only for success,’ Authentication one. That means, you’re only billed when a recipient successfully completes a verification.
23, June 2021
Send Two-Factor Authentication via WhatsApp
We're excited to announce that your Verify API now supports delivering a verification code through WhatsApp messages.
With this new feature, we introduced an addition 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 add this feature.
Updates to API Requests and Responses
In the code snippets below, existing features are in green, while new features are in red.
Create a Verify Profile
Update a Verify Profile
Trigger a Verification
Triggering a verification to /v2/verification with the old payload is still accommodated. However, the new style of API will support /v2/verifications/{channel of delivery}.
We encourage users to migrate to the new API to use the new style API features
Submit a Verification
We encourage users to migrate to the new API to use the new style API features
List all Verify Profiles
After this release, the old style update payload to /v2/verify_profiles will still be accommodated and the response will remain unchanged. However, we encourage the user to migrate to the new API.
Retrieve a Verify Profile
After this release, the old style and new style request remains the same. However, there are new fields added to the response.
Delete a Verify Profile
After this release, old style and new style requests remain the same. However, there are new fields added to the response.
List Verifications by Phone Number
After this release, old style and new style requests remain the same. However, there are new fields added to the response.
Retrieve a Verification
After this release, old style and new style requests remain the same. However, there are new fields added to the response.
25, May 2021
Verify API Voice, Flash Call, and API Updates
We're excited to announce that our 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.
Updates to API Requests and Responses
In the code snippets below, existing features are in green, while new features are in red.
Create a Verify Profile
After this release, the old style create payload to /v2/verify_profiles will still be accommodated and the response will remain unchanged. However, we encourage users to migrate to the new API.
Update a Verify Profile
After this release, the old style update payload to /v2/verify_profiles/[PROFILE_ID] will still be accommodated and the response will remain unchanged. However, we encourage the user to migrate to the new API.
Trigger a Verification
Triggering a verification to /v2/verification with the old payload is still accommodated. However, the new style of API will support /v2/verifications/{channel of delivery}.
We encourage users to migrate to the new API to use the new style API features
Submit a Verification Code
After this release, old style and new style usage for this feature remain the same.
List all Verify Profiles
After this release, old style list payload to /v2/verify_profiles will still be accommodated and the response will remain unchanged. However, We encourage users to migrate to the new API to use the new style API features.
Retrieve a Verify Profile
After this release, the old style and new style request remains the same. However, there are new fields added to the response.
Delete a Verify Profile
After this release, old style and new style requests remain the same. However, there are new fields added to the response.there are new fields added to the response.
List Verifications by Phone Number
After this release, old style and new style requests remain the same. However, there are new fields added to the response.
Retrieve a Verification
After this release, old style and new style usage remain the same. However, there are new fields added to the response.
09, December 2020
Introducing the Verify API
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.
Curious about Verify? Talk to one of our experts today.