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

 

Response Messages

The following table describes messages that would be returned as a result of sending a request to the Two-way Strong User Authentication System.

Message

Description

Follow-up Action

API Key must be provided.

The system found that the submitted apiKey had no value. The apiKey is a required data field.

Return to a user-created error page or to the Two-way Strong provided key access page.

API Key is not valid.

The system found that the submitted apiKey doesn't match with an existing apiKey.

Return to a user-created error page or to the Two-way Strong provided key access page.

Session ID must be provided.

The system found that the submitted sessionID had no value. If the message is returned, then the sessionID is a required data field.

An option is to redirect the user to the user login page. Or the user may be directed to a user-created error page or to the Two-way Strong provided key access page.

User ID is not valid.

The system found that the submitted userID is associated with a user account that cannot be used at the present time. The user account may be locked, for example.

Return to a user-created error page or to the Two-way Strong provided user lock page.

User has logged out.

The system has successfully logged out the user.

Return to the user login page.

Login session remains active.

The system found that a matching session associated with a user and an apiKey is currently valid within a defined time period.

Show the content of the secured page.

Login session has expired or is no longer active.

The system found that a matching session associated with a user and an apiKey had timed out or that a user had logged out.

Return to the user login page or to another page that the user may create.

An unknown error has occurred.

The system encountered an error that didn't allow the process to continue as designed. This is a rare case that may not affect the user's experience. Contact technical support if this error message occurs often.

Return to the requesting page or to another page that the user may create.