Phone Validation API

Overview

The Phone Validation API performs a series of phone validations in inbound calls to get device and phone number fraud-related insights.

📘

Use Case

As a real life example, consider the scenario where Talkdesk administrators want to get insights regarding a designated phone number, or even a series of phone numbers. Using the Phone Validation API, it is possible to get insights into the phone number(s) so those can be used to integrate with third-party systems.

👍

Access and Registration

Authentication

Usage

Getting the phone number insights (this endpoint helps understand the variables below).

VariableDescriptionValue TypeValue Ranges
ActiveReveals if this phone number is a live phone number that is currently activeString- True
- False
- N/A
CarrierThe carrier this phone number has been assigned to, or "N/A" if unknownString-
- Null
CountryThe two-character country code for the phone numberStringExample: “PT”, “US”
Do Not Call (DNC)Indicates if the phone number is listed on any DNC listsString- True
- False
- N/A
Fraud ScoreThe risk score, which measures how likely a phone number is to be fraudulentIntegerPercentage from 0 to 100 with no decimal numbers:

- Fraud scores < 75% are considered Safe.
- Fraud scores >= 75% and < 85% are Suspicious.
- Fraud scores >=85% are High-risk.
LeakedIndicates if this phone number has recently been exposed in an online database breach or act of compromiseString- True
- False
- N/A
Line TypeThe type of line this phone number is associated with (Toll-Free, Wireless, Landline, Satellite, Voice Over Internet Protocol - VOIP, Premium Rate, Pager, etc.), or "N/A" if unknownString- VOIP
- Toll-Free
- Wireless
- Landline
- Satellite
- Premium Rate
- Pager
- N/A
PrepaidIndicates if this phone number is associated with a prepaid service planString- True
- False
- N/A
RiskyPoints out if this phone number is associated with fraudulent activity, scams, fake accounts, or other suspicious behaviorString- True
- False
- N/A
SpammerIndicates if the phone number has recently been reported for spam or harassing calls/textsString- True
- False
- N/A
StatusThe phone validation status as a result of the Fraud ScoreString- True
- False
- N/A
Recent AbuseDetails on whether this phone number has been associated with recent or ongoing fraudString- True
- False
- N/A
RegionThe region (state) of the phone number if available, or "N/A" if unknownStringExample: “CA”, “AZ”
ValidIndicates if the phone number is considered valid based on assigned phone numbers available to carriers in the caller’s countryBoolean- True
- False
VOIPIllustrates if this phone number is a VOIP or a digital phone number.String- True
- False
- N/A
WhenThe date and time when the call took placeStringyyyy-mm-ddThh:mm:ss.s

📘

Supported Regions and Base URLs

👍

API Availability

The Phone Validation API has been in General Availability since February 2022.

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.