Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

telesignenterprisesdk

TeleSign402MIT3.3.0

This SDK enhances the functionality of the Telesign Self-service Node SDK, providing access to a broader range of Telesign APIs. See our source code on GitHub (https://github.com/TeleSign/node_telesign_enterprise) for installation instructions and other d

Telesign, sms, voice, intelligence, phoneid, twofactor, 2factor, authenticate, authentication, phone, call, text, AppVerify, 2FA, Twilio, Nexmo

readme

TeleSign Full-service Node.js SDK

Telesign connects, protects, and defends the customer experience with intelligence from billions of digital interactions and mobile signals. Through developer-friendly APIs that deliver user verification, digital identity, and omnichannel communications, we help the world's largest brands secure onboarding, maintain account integrity, prevent fraud, and streamline omnichannel engagement.

Requirements

  • Node.js 6+
  • npm (Optional) - This package manager isn't required to use this SDK, but it is required to use the installation instructions below.

NOTE:

These instructions are for MacOS. They will need to be adapted if you are installing on Windows.

Installation

Follow these steps to add this SDK as a dependency to your project. Both the Telesign Full-service Node.js SDK and the Telesign Self-service Node.js SDK are installed because the Full-service SDK also uses some functionality in the Self-service SDK.

  1. (Optional) Create a new directory for your Node.js project. Skip this step if you already have created a project. If you plan to create multiple Node.js projects that use Telesign, we recommend that you group them within a telesign_integrations directory.
    cd ~/code/local
    mkdir telesign_integrations
    cd telesign_integrations
    mkdir {your project name}
    cd {your project name}
  1. Install the SDK as a dependency in the top-level directory of your project using the command below. Once the SDK is installed, you should see a message in the terminal notifying you that you have successfully installed the SDK.

    npm install telesignenterprisesdk --save

This will also install the Telesign Self-service Node SDK since it is a dependency for the Full-service SDK.

Authentication

If you use a Telesign SDK to make your request, authentication is handled behind-the-scenes for you. All you need to provide is your Customer ID and API Key. The SDKs apply Digest authentication whenever they make a request to a Telesign service where it is supported. When Digest authentication is not supported, the SDKs apply Basic authentication.

What's next

  • Learn to send a request to Telesign with code with one of our tutorials.
  • Browse our Developer Portal for tutorials, how-to guides, reference content, and more.
  • Check out our sample code on GitHub.

changelog

3.3.0

  • Added methods to get information about a specified phone number

3.2.0

  • Added method to retrieve verification process.
  • Added unit test for retrieve verification process.
  • Added method to update verification process.
  • Added unit test for update verification process.

3.1.1

  • Added tracking to requests

3.1.0

  • Added method to send requests to Telesign Messaging.
  • Added method to send requests to the Telesign Verify API.
  • Removed Push Verify method in VerifyClient class
  • Added unit test for requests to Telesign Messaging.
  • Added unit test for requests to the Telesign Verify API.

3.0.2

  • Adds node-fetch by default for improved support in older versions of Node.

3.0.1

  • Updated installation instructions now that this SDK is on NPM.

3.0.0

  • Removed all third party dependencies, and upgraded Telesign Node SDK to the latest version.

2.0.1

  • Fixed typos with telebureau to resolve import issues effecting linux users.
  • Renamed packages
  • Minor updates to documentation

2.0.0

  • Node.js SDK release 2.0.0 for Telesign's enterprise products