Authentication
Try the API Explorer
APIs
SMS API
SMS Verify API
Bulk SMS API
Anonymous SMS API
Voice Verify API
Phone Numbers API
PhoneID API
Score API
Get Status API
Completion API

API Reference

Welcome to the API Reference section. Here you will find details about each of TeleSign’s current APIs. If you are looking for a legacy API, check the Legacy Products page.

Otherwise, your product appears in this API reference section. Each API is organized like this:

  • Get Started page - this acts as an index that briefly describes what is offered in the other sub sections.
  • Task pages - Each of the subsections describes a particular common use case, and provides you with an API Explorer. If you have TeleSign credentials and access to the API you are reading about, you can immediately try out the API Explorer with a test request. Each task page explains how to use the API explorer and grab your first code snippet from it.
  • API Reference pages - Under each Task page, the endpoint for the API that goes with it is listed. These pages show you all the request parameters and response parameters. And, if you like, there is an API Explorer at the bottom of each of these pages that lets you try out any kind of request to the API, so long as you have your credentials.

A List of TeleSign APIs

You can choose an API to review from the left column. Or, from here. These are the available TeleSign APIs, organized into Communications, Verification, and Mobile Identity categories.

Communications

TeleSign’s communications APIs allow you to easily send alerts, reminders, notifications, and marketing messages. You send them through a secure platform that offers direct carrier connections, global carrier data, and telecom fraud expertise.

  • SMS API - The SMS API is the perfect API for sending simple alerts, reminders, notifications, and marketing messages.
  • Voice API - The Voice API is a flexible and powerful API that allows you to set up IVR systems. You can create outbound calls, receive inbound calls, set up click-to-call, perform a cold transfer, set up survey after call, and create anonymous 2-way voice.
  • Bulk SMS API - The Bulk SMS API allows you to send SMS messages in bulk. You may send up to 1000 messages at a time. It is specifically for sending bulk messages to do with alerts, reminders, notifications, or marketing.
  • Anonymous SMS API - The Anonymous SMS API allows you to have two end users send and receive SMSes to one another without either party disclosing their phone numbers to one another. You and TeleSign will know their numbers and track their interactions so you can be sure they are not violating your terms of use. You can also log the conversation between the users.
  • Companion APIs - A companion API is an additional API that allows you to do more with your existing voice or SMS choice.
    • Phone Numbers API - You can use TeleSign’s Phone Numbers API to look for voice eligible phone numbers that can act as a sender ID. You can lease numbers, cancel leases, and retrieve a list of any numbers you leased from TeleSign.

Verification

TeleSign’s Verification APIs make it easy for you to set up two-factor authentication (2FA).

  • SMS Verify API - The SMS Verify API is the perfect API for sending OTP messages. You can generate your own verification code or have TeleSign do it for you. This API offers predefined templates that send the OTP message for you. You can also create your own OTP message if you choose to override the templates.
  • Voice Verify API - If you want to send OTP messages using voice, the Voice Verify API is designed for that. You can generate your own verification code or have TeleSign do it for you. This API offers predefined voice templates that send the OTP message for you. You can also create your own OTP text-to-speech message if you choose to override the templates.
  • Companion APIs for SMS Verify and Voice Verify - To retrieve the status of individual transactions and send completion data, TeleSign offers these APIs to be used alongside SMS Verify and Voice Verify:
    • Phone Numbers API - You can use TeleSign’s Phone Numbers API to look for voice eligible phone numbers that can act as a sender ID. You can lease numbers, cancel leases, and retrieve a list of any numbers you leased from TeleSign.
      • Get Status API - The Get Status API is for use with SMS Verify and Voice Verify. You can use this API to retrieve status results for an individual transaction as long as you have the reference ID.
      • Completion API - The Completion API is a lightweight API that is ideal for submitting completion rate information on high volumes of transactions. Completion rate information for a transaction is a way of telling TeleSign that you received a voice or SMS message, indicating that the transaction was completed. Providing this information allows TeleSign to monitor route quality and provide the fastest, most high quality routes for your messages.

Mobile Identity

Mobile identity includes all of TeleSign’s data products. These APIs deliver actionable insights that enhance and protect every stage of the customer experience. They include:

  • PhoneID API - The PhoneID API returns standard available data about a phone number. You can then include various add-ons that will give you additional data about a phone number. Add-ons include:
    • Contact - allows you to retrieve the name and address associated with the phone number you submit, without requesting explicit consent from your end user.
    • Contact Plus - allows you to compare a name and address for a submitted phone number in your request with a name and address on file with the carrier and return a score referred to as a match score that tells you how close a match was found.
    • Device Info - allows you to provide an end-user phone number and receive its phone manufacturer and model to detect fraud or understand the value or risk of the device holder and adjust content and marketing strategies per device.
    • Number Deactivation - allows you to find out whether a phone number has been deactivated, when it was deactivated, and by which carrier the phone number was deactivated based on carriers’ phone number data and TeleSign’s proprietary analysis.
    • Subscriber Status - allows you to provide an end-user phone number and receive their current carrier subscriber status (prepaid or postpaid; active, suspended, deactivated; account type; primary account holder; length of account tenure) to understand the strength, value or risk of a user.
    • Porting History - allows you to retrieve details about where a phone number was ported.
    • Porting Status - allows you to find out whether or not a phone number was ported to a carrier and who the current carrier is based on the mobile country code (MCC) and mobile network code (MNC) returned in the response.
    • Sim Swap - allows you to determine whether or not the SIM for the phone number has been swapped and how recently the swap occurred. TeleSign evaluates how likely it is that the SIM swap was for a fraudulent reason using a scale from 1-4.
  • Score API - you can use the Score API to submit a phone number and get back a score that tells you how likely it is that the number is used for fraudlent activities.