Two-way Strong ¦ Sign In ¦ New User

Application Programming Interface (API)

 

Introduction

User Account

API Key

Test Environment

Web Application

Login

Token

Session Check

Session Check (Static)

Logout

Logout (Static)

Mobile Application

Mobile Login Check

Key Data Fields

Response Messages

Demo Examples

Powered By (Credit)

Technical Support

 

Key Data Fields

The following table describes the data fields that are relevant to the API.

Data Field

Definition

Value

apiKey

A system-generated unique identifier of the software development key that is issued to a user.

64 alphanumeric characters

sessionID

A system-generated unique identifier of the session established by a user in association with an apiKey.

48 alphanumeric characters

userID

A user-defined unique identifier of the computer user.

User-definable up to 15 alphanumeric characters

userName

An alternate field name for userID.

See user ID.

userRole

A system-defined unique identifier of the computer user's role, which indicates what certain access rights the user has.

5 alphanumeric characters

CSTM0 = Consumer
MRCN0 = Merchant Administrator
DEVS0 = Software Developer
PAYE0 = Payee

modeID

A user interface input field that indicates which mode a user wants to use to send a client token (one-time passcode).

One of two choices: PHN or EML

PHN = Phone
EML = E-mail

tokenInput

A user interface input field that allows a user to enter a client token (one-time passcode).

Up to 8 digits

tokenLen

The user-specified length of the client token (one-time passcode) that will be generated by the system.

User-definable 1-digit number. If left blank, the system uses 8.

5 = 5 digits
6 = 6 digits
7 = 7 digits
8 = 8 digits

returnDestPath

The URL address of the destination page that will be returned.

Example URL: https://www.2waystrong.com/ApiUsr

User-definable absolute URL

returnLoginPath

The URL address of the user login page that will be returned.

Example URL: https://www.2waystrong.com/Log

User-definable absolute URL

returnTokenPath

The URL address of the client token page that will be returned.

Example URL: https://www.2waystrong.com/Log/Tok

User-definable absolute URL