telesign.api

The telesign.api module contains Python classes and methods that allow you to use the Python programming language to programmatically access the Verify and the PhoneId TeleSign web services.

Verify The Verify class exposes several services for sending users a verification token.
PhoneId The PhoneId class exposes three services that each provide detailed information about a specified phone number.

telesign.api.Verify

call Calls the specified phone number, and using speech synthesis, speaks the verification code to the user.
sms Sends a text message containing the verification code, to the specified phone number (supported for mobile phones only).
status Retrieves the verification result.

telesign.api.PhoneId

standard Retrieves the standard set of details about the specified phone number.
score Retrieves a score for the specified phone number.
contact In addition to the information retrieved by standard, this service provides the Name & Address associated with the specified phone number.
live In addition to the information retrieved by standard, this service provides actionable data associated with the specified phone number.

telesign.exceptions

You need the telesign.exceptions module to handle the exception conditions raised by the functions in the telesign.api module.

TelesignError The exceptions base class.
AuthorizationError Either the client failed to authenticate with the REST API server, or the service cannot be executed using the specified credentials.
ValidationError The submitted data failed the intial validation, and the service was not executed.