Smart 2FA Console

Introduction

Smart 2FA API lets you send One Time Password (OTP) using SMS, Voice or email.

2FA allows you to add a second layer of security to your Application in addition to the user-id and password. The flexibility of using any channel makes sure your users get OTP even when they experience issues with one of the channels.

To understand more about 2FA, follow the general doc here.

This document covers features and functionalities of 2FA UI Console that leverages underlying API.

To access 2FA Console visit https://<your custom domain>/twofa/ and login via Credentials provided by your Service Provider.

Home

This is the default page user will see after the user logs in. Here users can find the number of OTP requests sent per channel - SMS, Voice and Email in the last 24 hours and 30 days usage report of OTP requests.

2FA Home

Limits

Limits provide the capability to enforce limitations on the number of OTPs sent based on various Keys defined. Keys can be defined to put limits based on many parameters. Some of the examples are below

  • Phone Number

  • End User IP Address

  • Application specific Session-Id

  • Geolocation of End User IP Address

For more details please look at the Limits section of the API documentation.

Limits Page

Limits home page lets you:

  • Search all existing Limits

  • Lists all existing Limits

  • Add new limit

  • Delete Limit by hovering mouse on limit row and clicking on Delete icon that appears at right

2FA Limits

Add Limit

Add Limit allows the user to define new limits.

  • Name: Unique Name for this Limit. Developers will pass this as key when passing Limit to Send API.

  • Account: Sub-Account Sid for which Limit is to be created. If not passed Limit is created for the same Account signed in.

  • Description: Optional Description for this Limit.

  • Buckets: Maximum of 2 Buckets can be defined with parameters as defined below.

Buckets Parameters

  • Name: Unique name of bucket. This is just for easy identification.

  • Max OTP: Maximum number of OTPs allowed for passed Interval.

  • Interval: Time in seconds under which maximum OTP will be allowed as specified in “Max OTP“ parameter.

add limit

Edit Limit

To edit the details of a Limit, click on the Limit name from the list. The following parameters can be changed:

  • Limit name

  • Description

  • Bucket name

  • Max OTP

  • Interval

add limit

Delete Limit

To delete a Limit, hover on the limit’s name in the list of Limits and click the Delete icon on the right of the row. Once the Limit is deleted it cannot be undone.

add limit

Session Details

Session Details Records allows users to Search for a specific set of 2FA requests based on filter criteria or to retrieve Usage Records like how many 2FA requests per day based on filter criteria.

Search

The user can search for a specific set of 2FA. Below are the supported filters for search:

Account Scope

  • Search in Current Account: Shows the 2FA requests that are created by the logged in user.

  • Search current account and sub-accounts: Shows 2FA requests that are created by logged in user and all other Sub-Accounts under logged in user.

  • Search in Specific Account: Search 2FA requests that are created by specific Sub-Account under logged in user. User is presented with a list of Sub-Accounts in a popup window. The user can select the Sub-Account on that popup window.

Start Date: Shows the list of 2FA requests that were created on or after this date.

End Date: Shows the list of 2FA requests that were created on or before this date.

Status: Shows the list of 2FA requests that have selected status.

Channel: Shows the list of 2FA requests that are sent via selected channel.

Service: Shows the list of 2FA requests that match this service text, partially or fully in any position.

From: Only includes 2FA list that begins with this number/email text. For example if OTP from is “15713316943“ and from filter parameter is “1“, it will match. However if the filter parameter is “3“, this record will not match. This allows to filter 2FA sent from specific country codes.

To: Only includes OTP list that has to begin with this number/email text. For example if OTP to is “16513333367“ and to filter parameter is “1“, it will match. However if the filter parameter is “3“, this record will not match. This allows to filter OTP sent to specific country codes.

TargetSid: Only include 2FA list that matches the target sid of SMS/ Call/ Email text, partially or fully in any position.

Channel Status: Only includes 2FA list that match underlying channel status, partially or fully in any position. For SMS, possible channel status value can be as explained here. For Call, possible can be found here

Sorting

Users can sort the search results by clicking on Column Header as explained below

Date: Ascending or Descending list of 2FA based on Date when it was created Service: Sort by Service. Status: Sort by status of 2FA request.

2FA Search

Download as CSV

Once results are displayed for search criteria, users can click on the Download icon below the Search icon to download search results as CSV.

2FA request details

Users can view details of particular 2FA by clicking any row in the list.

2FA Request

Users can click on Check link to see the details of the 2FA check request

2FA Check Request

Users can click on Events to see details of the Channel used to send the 2FA request.

2FA Events

Usage Records

The Usage record allows you to retrieve usage made by your 2FA account during any time period and by any usage channel. Below filter parameters are supported

Usage Records do not include real time data and can be delayed by maximum 1 hour.

Account Scope:

  • Search in Current Account: Shows the 2FA requests that are created by the logged in user.

  • Search current account and sub-accounts: Shows 2FA requests that are created by logged in user and all other Sub-Accounts under logged in user.

  • Search in Specific Account: Search 2FA requests that are created by specific Sub-Account under logged in user. User is presented with a list of Sub-Accounts in a popup window. The user can select the Sub-Account on that popup window.

Subresource:

  • Daily: Shows the record of 2FA on a daily basis for selected Start Date and End Date.

  • Monthly: Shows the record of 2FA on a monthly basis for selected Start Date and End Date..

  • Yearly: Shows the record of 2FA on a yearly basis for selected Start Date and End Date.

  • Today: Shows the record of 2FA today.

  • Yesterday: Shows the record of 2FA on yesterday.

  • This Month: Shows the record of 2FA this month.

  • Last Month: Shows the record of 2FA last month.

Start Date: Only include 2FA requests that were created on or after this date.

End Date: Only include 2FA requests that were created on or before this date.

Status: Only include 2FA requests that have selected status.

Channel: Only include 2FA requests that are sent via selected channel.

Filter By Country Code: Only include 2FA requests sent to selected Country Code. For example if OTP is sent to “16513333367“ and the filter parameter is “1 - United States“, it will match.

2FA Usage Records

Usage Records will show Total, Successful, UnSuccessful and Success Ratio (Successful/Total).

Demo

2FA Console also provides an easy demo for users to send OTP and test the API. To try Demo, click on your name at top right corner and select “2FA Demo“. Click on the “Try Demo“ button on the card displayed. It displays a form where users can enter all the values and send OTP. If sending is successful, it displays the API called along with parameters.