User model

The OneSpan Identity Verification User model is a section of the Transaction model that contains a list of data structures defining participants of the e-agreement process. Elements of the User model provide a complete set of user identity and other metadata necessary and sufficient for executing an e-agreement workflow; these elements also capture sufficient evidence for facilitating legally enforceable e-agreement. Country names are abbreviated with 2-letter codes - the 2-letter codes as specified in the ISO 3166-1 alpha-2 standard are used.

For the United Kingdom of Great Britain and Northern Ireland, the ISO standard foresees the abbreviation GB (for "Great Britain") - this also applies for the User model, i.e. you must use GB as the 2-letter code, not UK!

User properties

This resource represents information about a single participant of an e-agreement process. The data contain personal identity information, address information, and other data used for online identity validation. This data can be used for verification through a request to the OneSpan Identity Verification module.

User properties lists the user properties in OneSpan Identity Verification.

  • Path: .../properties/transaction/properties/users/items
  • Type: object
User properties
Property Type Description
groups Array

List of groups the user belongs to. All users, except those with the Lender role, must be in the visible group.

items User group.
  type string
  maximum length: 64
  minimum length: 1

Maximum number of items: 512

Minimum number of items: 0

first_name String

The transaction participant's first name.

Maximum length: 1024

Minimum length: 1

middle_name String

The transaction participant's middle name.

Maximum length: 128

Minimum length: 0

last_name String

The transaction participant's last name (will appear on the signature).

Maximum length: 1024

Minimum length: 1

birth_surname String

The transaction participant's family name/surname/last name at birth, e.g. their maiden name.

Maximum length: 1024

Minimum length: 0

title String

The transaction participant's title.

Maximum length: 32

Minimum length: 0

role String

The role name. It has to be valid in the context of the workflow assigned to the transaction.

Maximum length: 32

Minimum length: 1

dob String

The transaction participant's date of birth.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0]{2}:[0]{2}:[0]{2}.[0]{3}Z$

Possible formats:

  • yyyy-mm-ddThh:mm:ssZ

  • yyyy-mm-dd
gender String

This property reflects a person's gender.

Possible values:

  • unspecified
  • male
  • female
  • other

Default value: unspecified

address Object

The address object of the transaction participant.

Property Type Description
country_code  

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

county_or_province String

County or province of the transaction participant's address.

Maximum length: 128

Minimum length: 1

city String

Name of the city of the transaction participant's address.

For addresses in the United Kingdom, a distinction must be made between city vs. town. (City status is granted by the monarch of the United Kingdom to a select group of communities).

Maximum length: 128

Minimum length: 1

town String

Name of the town of the transaction participant's address.

For addresses in the United Kingdom, a distinction must be made between city vs. town. (City status is granted by the monarch of the United Kingdom to a select group of communities).

Maximum length: 128

Minimum length: 1

street String

Street of the transaction participant's address.

Maximum length: 128

Minimum length: 1

house_name String

The house name of the transaction participant's address.

Maximum length: 128

Minimum length: 1

house_number String

The house number of the transaction participant's address.

Maximum length: 32

Minimum length: 1

flat_or_apartment_number String

The flat or appartment number of the transaction participant's address.

Maximum length: 32

Minimum length: 1

po_box String

The post office box number of the transaction participant's address.

Maximum length: 64

Minimum length: 1

post_code String

The postal code of the transaction participant's address.

Maximum length: 128

Minimum length: 1

phone number String

Phone number of the transaction participant.

Maximum length: 32

Minimum length: 1

Pattern: ^+?[d]{1,15}$

bank Object

The bank object of the transaction participant's.

Property Type Description
bank_account_number String

The bank account number of the transaction participant.

Maximum length: 128

Minimum length: 1

sort_code_number String

The sort code of the transaction participant.

In the British and Irish banking industries, sort codes are bank codes used to route money transfers between banks within their respective countries via their respective clearance organizations.

company String

The name of the company the user represents.

Maximum length: 128

Minimum length: 1

supplemental_verification_info Array

List of verification information to be matched with the verification result. Each item in this array is an object that contains the following properties:

Property Type Description
verification_id String

Example: document_id_authentication

Mandatory.

artefact_type String

Example: driver-license-front

Optional.

values Array

Array of name-value objects.

Example:

{ "name":"number", "value":"DL123456"}

Mandatory.

emails Array A comma-separated list of the transaction participant's email addresses.

Example user

  1. {

  2.   "groups": ["visible"],
  3.   "first_name": "John",
  4.   "middle_name": "",
  5.   "last_name": "Doe",

      "birth_surname": "John"

  6.   "title": "Mr.",

  7.   "role": "(signer1)",

  8.   "emails": ["[email protected]", "[email protected]"],

  9.   "dob": "2013-07-01T00:00:00.000Z",

  10.   "address":{

  11.     "country_code":"CA",

  12.     "county_or_province": "Quebec",

  13.     "city":"Montreal",

  14.     "town": "Bollington",
  15.     "street": "St-Laurent",
  16.     "house_name": "MeadowView",
  17.     "house_number": "97",
  18.     "flat_or_appartment_number": "125",
  19.     "po_box": "A64",
  20.     "post_code": "H2W2R2",
  21.   },
  22.   "bank": {
  23.     "bank_account_number": "138746"
  24.     "sort_code_number": "12-34-56"
  25.   }
  26.   "company": "MyCompany"
  27. }