TeleSign Developer Center

Welcome! This resource hub provides documentation and references on API & SDK integration and other product-related information.

Search results for "{{ search.query }}"

No results found for "{{search.query}}". 
View All Results

Overview of TeleSign Products (Standard and Enterprise)

Welcome to TeleSign's developer documentation. This page will help you get started quickly with TeleSign products. TeleSign has two groups of products with specific traits. Read through the lists to determine which group of products you are using:

  • Standard

    • TeleSign's free trial allows you to try Standard products
    • Endpoints begin with https://rest-api.telesign.com/v1/
    • Your account is accessed via portal.telesign.com
    • You work with Support for any questions
    • Standard SDKs are publicly available on GitHub
    • Products included in the Standard category are Messaging, PhoneID, Score, Voice, and App Verify for iOS and Android
  • Enterprise

    • Endpoints begin with https://rest-ww.telesign.com/v1/
    • Your account is accessed via teleportal.telesign.com
    • You work with a dedicated Technical Account Manager (TAM)
    • Enterprise SDKs are available on GitHub after you request access from your TAM
    • Products included in the Enterprise category are Messaging, PhoneID, Score, Voice, App Verify for iOS and Android and TeleSign's older APIs such as Completion, Get Status, Number Deactivation, (deprecatedand PhoneID Standard, PhoneID Contact, PhoneID Live, Push Verify, Smart Verify, SMS Verify, and Voice Verify
    • If you are trying to choose an SMS, Voice, or PhoneID product, TeleSign recommends using our newer APIs (Messaging, Voice, PhoneID) with the only exception being if you want features from PhoneID Contact or PhoneID Live.

Shared Concepts

All TeleSign products require authentication. Digest authentication works the same way for Standard and Enterprise products, however the endpoints are different for each group. Authentication can be tricky to set up on your own, so if you want to get started immediately and see a product in action, TeleSign recommends that you use one of our SDKs.

Standard

Enterprise

  • Authentication for the Enterprise version of TeleSign products - Enterprise Authentication
  • Enterprise SDKs (authentication is handled for you, you must obtain access to these SDKs for the links to work, ask your TAM for access):

URI Structure

TeleSign web services conform to the industry standard REST Web Service Design Model. Each web service has a RESTful programming interface—a Uniform Resource Identifier (URI). Collectively, the URIs comprise the TeleSign REST API.

Web services are treated as domain resources, and each one is accessed using its own URI. The structure of each URI is organized into a sequence of functional parts.

Standard
| Scheme | Base URI | Ver | Resource | Sub Resource | Sub Resource ID | Query Params |
| --- | --- |
| https: | rest-api.telesign.com | v1 | phoneid | contact | 15555551234 |

For example:
https://rest-ww.telesign.com/v1/phoneid/contact/15555551234

Enterprise
| Scheme | Base URI | Ver | Resource | Sub Resource | Sub Resource ID | Query Params |
| --- | --- |
| https: | rest-ww.telesign.com | v1 | phoneid | contact | 15555551234 | ucid=BACS |

For example:
https://rest-ww.telesign.com/v1/phoneid/contact/15555551234?ucid=BACS

NOTE:

To protect data privacy, the TeleSign REST API uses Transport Layer Security (TLS) for all communications. This means all Request/Response transactions are sent using the HTTPS protocol rather than the regular HTTP protocol. The TLS version supported is TLS 1.2. Ciphers supported are:

  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

Important Things to Remember When Using TeleSign APIs

This section provides a brief list of things to remember that are commonly overlooked when working with the REST API. When using web services from TeleSign's REST API, remember the following:

  • API Key
    • Make sure you base64 decode the shared secret API key before adding it to the signature string.
    • Check that the elements of the signature string are in the order specified in the REST API.
  • General
    • Make sure the posting URL field is configurable. TeleSign may request URL changes on occasion.
    • Check that your application code is pointing to the TeleSign provided URL and not the IP address for the URL.
    • Ensure your DNS infrastructure respects the telesign.com (http://telesign.com) domain TTL value of 300 seconds.
    • Do not whitelist TeleSign URLs by IP on any device residing on your application's path to the Internet.
  • Ciphers - TeleSign only supports the following ciphers for API communication:
    • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
    • TLS_RSA_WITH_AES_128_GCM_SHA256
    • TLS_RSA_WITH_AES_256_GCM_SHA384
    • TLS_RSA_WITH_AES_128_CBC_SHA256
    • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • Protocols - Please use only TLS v1.2 protocols.

Overview of TeleSign Products (Standard and Enterprise)