Session model

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

Session properties

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

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 was created in UTC.

  • Maximum length: 30
  • Minimum length:20
  • Format: date-time
currentStep Integer

The step number for the progress indicator.

Default value: 0
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}$

last_request String

The timestamp of the last request that was received in the context of this session.

  • Maximum length: 30
  • Minimum length: 20
  • Format: date-time
role String

The role associated with the session.

  • Maximum length: 32
  • Minimum length: 1

Default value: unknown
totalSteps Integer

The total number of steps for the progress indicator.

Default value: 0
user_agent String

User agent from the request header.
verifications Array

The list of verification workflows as defined for this tenant.

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

The version of the session record. Read-only property.

Default value: 0
view_state Object

This element carries information that defines the view that is displayed in the current workflow step.

For the list of view_state properties, see view_state properties.
view_state properties
Property Type Description
error  

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

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

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

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

This is a free JSON form that carries 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.

For the list of session_management properties, see session_management properties.
wait  

Schema: transaction.schema.3.0.ux-component-config.json
session_management properties
Property Type Description
active Boolean

Timestamp. Flag that indicates the active session.
end Integer

Timestamp. The time-out for this session.
warning Integer

Timestamp. Warning when the session ends.

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. }