Session model

The Session model defines data necessary for rendering and executing a current step in the e-agreement workflow. The session identifies the current signer, language preference, session time out information, presentation details, and other information.

Session properties

The session resource contains context information necessary for executing the interactive part of the e-agreement process by a user (participant). Session data is transient (from the perspective of transaction metadata).

Session properties lists the session properties in OneSpan Identity Verification.

  • Path: .../properties/transaction/properties/session
  • Type: object
Session properties
Property Type Description
created String

The date/time when the session is created in UTC.

Maximum length: 30

Minimum length:20

Format: date-time

id String

The session UUID.

Maximum length: 64

Minimum length: 36

Pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fAF0-9]{4}-[a-fA-F0-9]{12}$

verifications Array

A list of verification workflows, defined for this tenant.

Schema: ../common/common.schema.3.0.verification.json

last_request String

Timestamp of the last request received in the context of this session.

Maximum length: 30

Minimum length: 20

Format: date-time

role String

Role associated with the session.

Maximum length: 32

Minimum length: 1

Default value: unknown

currentStep Integer

The step number for the progress indicator.

Default value: 0

totalSteps Integer

The total number of steps for the progress indicator.

Default value: 0

user_agent String

User agent from the request header.

version Integer

Read-only property; version of the session record.

Default value: 0

view_state Object

This element carries information defining the view displayed in the current workflow step;

Property Type Description
header  

Schema: transaction.schema.3.0.ux-component-config.json

footer  

Schema: transaction.schema.3.0.ux-component-config.json

page  

Schema: transaction.schema.3.0.ux-component-config.json

error  

Schema: transaction.schema.3.0.ux-component-config.json

wait  

Schema: transaction.schema.3.0.ux-component-config.json

session_management Object

This is a free JSON form carrying all configuration data required by the page (workflow element) of a given type. The configuration data is retrieved from the configuration service and passed as is to CWF UX. This accepts anything, provided it is valid JSON format.

Property Type Description
warning Integer

Timestamp; warning when the session ends.

end Integer

Timestamp; timeout for this session.

active Boolean

Timestamp; flag indicating the active session

Example session

  1. {

  2.   "created": 1552498394341,
  3.   "id": "66e326gb-92ea-482b-8375-75f01e72d26a",
  4.   "verifications": [],

  5.   "last request": 1552498394362,

  6.   "role": "Role",

  7.   "currentStep": 0,

  8.   "totalSteps": 0,

  9.   "user_agent":"Mozilla/5.0",

  10.   "version": 1,

  11.   "view_state": {,

  12.     "header": {,
  13.       "type": "simple_header",
  14.       "config": {,
  15.         "logo": "logo.png",
  16.         "text": "OneSpan"
  17.         "text_url": "https://www.onespan.com",
  18.       },
  19.      "...": "..."
  20.     }
  21.     "footer" {
  22.       "type": "simple_footer"
  23.       "config": {
  24.         "links": [{
  25.           "text": "OneSpan"
  26.           "url": "https://www.onespan.com"
  27.                  }
  28.          ],
  29.         "copyright": "All rights reserved"
  30.       },
  31.       "...": "...":
  32.     },
  33.     "page": {
  34.       "type": "introduction:A",
  35.       "config": {
  36.         "...": "..."
  37.     },
  38.     "error": {
  39.       "type": "simple_error",
  40.         "...": "..."
  41.       },
  42.     "wait": {

  43.       "type": "simple_wait",
  44.         "...": "..."
  45.     },

  46.     "session_management": {
  47.       "warning": 240,
  48.       "end": 360,
  49.       "active": true
  50.       }

  51.   }
  52. }