vonage-verify 1.1.1

Vonage verify package

Vonage Verify Package

This package contains the code to use Vonage's Verify API in Python. This package includes methods for working with 2-factor authentication (2FA) messages sent via SMS or TTS.

Note: There is a more current package available: Vonage's Verify v2 API which is recommended for most use cases. The v2 API lets you send messages via multiple channels, including Email, SMS, MMS, WhatsApp, Messenger and others. You can also make Silent Authentication requests with Verify v2 to give an end user a more seamless experience.

Usage

It is recommended to use this as part of the main vonage package. The examples below assume you've created an instance of the vonage.Vonage class called vonage_client.

Make a Verify Request

from vonage_verify import VerifyRequest
params = {'number': '1234567890', 'brand': 'Acme Inc.'}
request = VerifyRequest(**params)
response = vonage_client.verify.start_verification(request)

Make a PSD2 (Payment Services Directive v2) Request

from vonage_verify import Psd2Request
params = {'number': '1234567890', 'payee': 'Acme Inc.', 'amount': 99.99}
request = VerifyRequest(**params)
response = vonage_client.verify.start_verification(request)

Check a Verification Code

vonage_client.verify.check_code(request_id='my_request_id', code='1234')

Search Verification Requests

# Search for single request
response = vonage_client.verify.search('my_request_id')

# Search for multiple requests
response = vonage_client.verify.search(['my_request_id_1', 'my_request_id_2'])

Cancel a Verification

response = vonage_client.verify.cancel_verification('my_request_id')

Trigger the Next Workflow Event

response = vonage_client.verify.trigger_next_event('my_request_id')

Request a Network Unblock

Note: Network Unblock is switched off by default. Contact Sales to enable the Network Unblock API for your account.

response = vonage_client.verify.request_network_unblock('23410')