User Model

Updated on 07 Oct 2024
3 Minutes to read

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

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

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, where 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

Property	Type	Description
User properties
address	Object	The address object of the transaction participant. For the list of address properties, see address properties.
bank	Object	The bank object of the transaction participant. For the list of bank properties, see bank properties.
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
company	String	The name of the company the user represents. Maximum length: 128 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
emails	Array	A comma-separated list of the transaction participant's email addresses.
first_name	String	The transaction participant's first name. Maximum length: 1024 Minimum length: 1
gender	String	This property reflects a person's gender. Possible values: unspecified male female other Default value: unspecified
groups	Array	List of groups to which the user belongs. All users, except those with the Lender role, must be in the visible group. Maximum number of items: 512 Minimum number of items: 0 Items: User group Type: string Maximum length: 64 Minimum length: 1
last_name	String	The transaction participant's last name (will appear on the signature). Maximum length: 1024 Minimum length: 1
middle_name	String	The transaction participant's middle name. Maximum length: 128 Minimum length: 0
phone number	String	The transaction participant's phone number. Maximum length: 32 Minimum length: 1 Pattern: ^+?[d]{1,15}$
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
supplemental_verification_info	Array	Verification information to be matched with the verification result. Each item in this array is an object that contains the properties described in supplemental_verification_info properties.
title	String	The transaction participant's title. Maximum length: 32 Minimum length: 0

Property	Type	Description
address properties
city	String	The name of the city in the transaction participant's address. For addresses in the United Kingdom, a distinction must be made between city and town. The city status is granted by the monarch of the United Kingdom to a selected group of communities. Maximum length: 128 Minimum length: 1
country_code		Schema: ../common/common.schema.3.0.countrycode.json
county_or_province	String	County or province in the transaction participant's address. Maximum length: 128 Minimum length: 1
flat_or_apartment_number	String	The flat or appartment number in the transaction participant's address. Maximum length: 32 Minimum length: 1
house_name	String	The house name in the transaction participant's address. Maximum length: 128 Minimum length: 1
house_number	String	The house number in the transaction participant's address. Maximum length: 32 Minimum length: 1
po_box	String	The post office box number in the transaction participant's address. Maximum length: 64 Minimum length: 1
post_code	String	The postal code in the transaction participant's address. Maximum length: 128 Minimum length: 1
street	String	The street in the transaction participant's address. Maximum length: 128 Minimum length: 1
town	String	The name of the town in the transaction participant's address. For addresses in the United Kingdom, a distinction must be made between city and town. The city status is granted by the monarch of the United Kingdom to a selected group of communities. Maximum length: 128 Minimum length: 1

bank properties
Property	Type	Description
bank_account_number	String	The transaction participant's bank account number. Maximum length: 128 Minimum length: 1
sort_code_number	String	The transaction participant's sort code. In the British and Irish banking industries, sort codes are bank codes that are used to route money transfers between banks within their respective countries via their respective clearance organizations.

bank properties

Property

Type

Description

bank_account_number

String

The transaction participant's bank account number.

Maximum length: 128
Minimum length: 1

sort_code_number

String

The transaction participant's sort code.

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

Property	Type	Description
supplemental_verification_info properties
artefact_type	String	Optional. Example: driver-license-front
values	Array	Required. Array of name-value objects. Example: { "name":"number", "value":"DL123456"}
verification_id	String	Required. Example: document_id_authentication

Example user

{

  "groups": ["visible"],
  "first_name": "John",
  "middle_name": "",
  "last_name": "Doe",
  "birth_surname": "Doe"
  "title": "Mr.",
  "role": "(signer1)",
  "emails": ["john.doe1@host.com", "john.doe2@host.com"],
  "dob": "2013-07-01T00:00:00.000Z",
  "address":{
    "country_code":"CA",
    "county_or_province": "Quebec",
    "city":"Montreal",
    "town": "MyTown",
    "street": "MyStreet",
    "house_name": "MyHouse",
    "house_number": "123",
    "flat_or_appartment_number": "456",
    "po_box": "MyPObox",
    "post_code": "MyPostCode",
  },
  "bank": {
    "bank_account_number": "123456"
    "sort_code_number": "12-34-56"
  }
  "company": "MyCompany"
}

Was this article helpful?

What's Next

Session Model

Table of contents

User properties
Example user