GuidesAPI ReferenceDiscussionsContactsKnowledge BaseAppConnectTalkdesk

Phone Validation API

Suggest Edits

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 detect and route potential fraudulent calls within Talkdesk Studio, or get insights regarding a designated phone number, or even a series of phone numbers. Using the Phone Validation API, it is possible to get the insights of the phone number(s) so those can be used to integrate with Studio or even with third-party systems.

Integrating with Studio

You can integrate the Phone Validation API with Studio by using Studio components. You can use the Execute Action component to call the Phone Validation API and expose the insights as variables in Studio. Then you can use the Conditional Statement component to define the routing logic in Studio.

👍

Access and Registration

Authentication

Usage

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

Variable

Description

Value Type

Value Ranges

Active

Reveals if this phone number is a live phone number that is currently active

String

  • True
  • False
  • N/A

Carrier

The carrier this phone number has been assigned to, or "N/A" if unknown

String

  • Null

Country

The two-character country code for the phone number

String

Example: “PT”, “US”

Do Not Call (DNC)

Indicates if the phone number is listed on any DNC lists

String

  • True
  • False
  • N/A

Fraud Score

The risk score, which measures how likely a phone number is to be fraudulent

Integer

Percentage 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.

Line Type

The 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 unknown

String

  • VOIP
  • Toll-Free
  • Wireless
  • Landline
  • Satellite
  • Premium Rate
  • Pager
  • N/A

Prepaid

Indicates if this phone number is associated with a prepaid service plan

String

  • True
  • False
  • N/A

Risky

Points out if this phone number is associated with fraudulent activity, scams, fake accounts, or other suspicious behavior

String

  • True
  • False
  • N/A

Status

The phone validation status as a result of the Fraud Score

String

  • True
  • False
  • N/A

Recent Abuse

Details on whether this phone number has been associated with recent or ongoing fraud

String

  • True
  • False
  • N/A

Valid

Indicates if the phone number is considered valid based on assigned phone numbers available to carriers in the caller’s country

Boolean

  • True
  • False

VOIP

Illustrates if this phone number is a VOIP or a digital phone number.

String

  • True
  • False
  • N/A

When

The date and time when the call took place

String

yyyy-mm-ddThh:mm:ss.s

📘

Supported Regions and Base URLs

👍

API Availability

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

Updated 2 months ago

Did this page help you?