Session Data Tables

Introduction

This page serves as a reference guide to Session Data attributes that are available. Session Data can be used by components such as Cloud Functions and Custom Pages to substitute variables (variable substitution) with data captured during a Process Instance/ session.

Info

_faces, _idDocs, _checks, etc. can be considered the root for each table. As such, '$' is not supported as a valid reference to the root and will cause a syntax error.

_faces

Face data captured as part of a process definition is available as the private process variable _faces within the Session Data.

Faces are stored as a name value pair (map) . By default the face captures is stored as “face1”. The name of the face can be changed as part of the process variable.

Face

Each face is stored as a ‘Face’ which has the following attributes:

Attribute	Type	Description	Example
currentCapture	FaceCapture	The current face capture. Each time a user is required to capture their face a new FaceCapture is created. The currentCapture points to the latest capture.
captures	<String,FaceCapture>	A name value pair map of all captures that have occurred for the Face (e.g. face1). This map contains all the previous captures as well as the current capture.

FaceCapture

A FaceCapture represents an attempt to capture a face image. For each attempt at face capture, a FaceCapture is created.

Attribute	Type	Description
format	FaceCapture	Image format of the captured image.
quality	<String,Object>	A name value pair map of results of quality assessment.
liveness	<String,Object>	A name value pair map of results of passive liveness assessment.
templateGeneration	<String,Object>	A name value pair map of results of template generation.
doc2FaceMatch	<String,Object>	A list of results for the matching of face images from a document to the image captured. Each element of the list contains a name value pair map of the results of the 1:1 match of the images.
error	Error	Records any error which may have occurred as part of the process of executing the activities of face capture.

_idDocs

Document data captured as part of a process definition is available as the private process variable _idDocs within the Session Data.

Documents are stored as a name value pair (map) . By default the document captures is stored as “doc1”. The name of the document can be changed as part of the process variable.

Document

Each document is stored as a 'Document' which have the following attributes:

Attribute	Type	Description
currentDocumentCapture	DocumentCapture	The current document that that the application needs to submit. Each time a user is required to capture a Document a new DocumentCapture is created. The currentDocumentCapture points to the latest capture.
captures	<String,DocumentCapture>	A name value pair map of Document which are to be captured (e.g. doc1, doc2 etc). This map contains all the previous captures as well as the current capture.
NFCDocumentCapture	<String, NFCDocumentCapture>	A name value pair map of NFC document captures.

DocumentCapture

A DocumentCapture represents an attempt to capture a document. For each attempt at document capture, a DocumentCapture is created.

Attribute	Type	Description
page	string	For ID docs this is typically FRONT or BACK but could also be Page1, Page2 etc.
processorResults	<String,Object>	A name value pair map of results of document processing results. Available keys-values pairs are: documentProcessorResultsPath, String documentProcessorDocInfo, DocumentInfo documentProcessorName, String
extractedText	ServerProcessedSensitiveData	The extracted text from document processing.
doc2FaceMatch	<String,Object>	A list of results for the matching of face images from a document to the image captured. Each element of the list contains a name value pair map of the results of the 1:1 match of the images.
acceptableDocCheck	<String,Object>	A name value pair map of results of template generation.
doc2FaceMatch	<String,Object>	A name value pair map of results of checking that the document is acceptable (i.e. meets the criteria related to expiry, document classification etc).
captures	<String,PageCapture>	The name value pair map of all captures for this DocumentCapture.
currentCapture	PageCapture	The current PageCapture in progress.
error	Error	Records any error which may have occurred as part of the process of executing the activities of document capture.

PageCapture

A PageCapture represents an attempt to capture a single page of a document. For each attempt to capture a page, a PageCapture is created.

Attribute	Type	Description
page	string	For ID docs this is typically FRONT or BACK but could also be Page1, Page2 etc.
format	string	Image format of the captured image.
barcodeType	string	The type of barcode captured from the document page.
quality	<String,Object>	A name value pair map of results of quality assessment.
liveness	<String,Object>	A name value pair map of results of passive liveness assessment.
blackAndWhiteCopyDetection	<String,Object>	A name value pair map of results of b&w (grayscale) detection.
colorCopyDetection	<String,Object>	A name value pair map of results of color copy detection.
photoSubstitionDetection	<String,Object>	A name value pair map of results of photo substitution detection.
screenDetection	<String,Object>	A name value pair map of results of screen detection detection.
error	Error	Records any error which may have occurred as part of the process of executing the activities of page capture.

DocumentInfo

DocumentInfo represents the key information extracted from the document

Attribute	Type	Description
type	String	The document type.
classification	String	The document classification.
expiryDate	String	The document expiry data represented in ISO format.
issuedDate	String	The document issue data represented in ISO format.
issuingStateName	String	The document issuer.

ServerProcessedSensitiveData

ServerProcessedSensitiveData represents the extracted document text resulting from document processing

Attribute	Type	Description
extractedImages	ExtractedDocumentImage[]	A list of extracted images from the document such as the portrait image
ocrData	DocProcessorOcrData	The OCR data extracted from the document
barcodeData	DocProcessorBarcodeData	The barcode data extracted from the document

DocProcessorOcrData

DocProcessorOcrData represents the extracted text from the document visual zone and MRZ.

Attribute	Type	Description
visualZone	<String, DocVizualZoneField>	The OCR data extracted from the document
mrz	<String,DocMRZField>	The barcode data extracted from the document

DocProcessorBarcodeData

DocProcessorBarcodeData represents the extracted text from the document barcode.

Attribute	Type	Description
barcode	<String, DocBarCodeField>	The barcode data extracted from the document

DocMRZField

A text field extracted from the document's MRZ.

Attribute	Type	Description
fieldId	String	The field id - a number representation of the field
name	String	The field name - a text label for the field
value	String	The field value

DocBarCodeField

A text field extracted from the document's barcode.

Attribute	Type	Description
fieldId	String	The field id - a number representation of the field
name	String	The field name - a text label for the field
value	String	The field value

DocVizualZoneField

A text field extracted from the document's visual zone.

Attribute	Type	Description
fieldId	String	The field id - a number representation of the field
name	String	The field name - a text label for the field
value	String	The field value

NFCDocumentCapture

Attribute	Type	Description
error	PSError	The processing server error.
documentFields	LdsDocumentFields	An object containing all fiends associated with the document.
face	NFCImage	The face image retrieved from the NFC scan.
String	activeAuthenticationChallenge	Contains a string that the document must sign that ensures the document is present. This serves as a form of security against replay attacks.
CheckResult	nfcValidationResults	Contains the validation results of the NFC document. This includes nested check results as well as an overall check result.

NFCFaceImage

Attribute	Type	Description
format	String	The image format.
relativePath	String	The relative path of the image extracted from the NFC scan.

LdsDocumentFields

Attribute	Type	Description
documentFields	<String, DocumentField>	A map containing document fields.

DocumentField

Attribute	Type	Description
fieldId	String	The unique identifier of the field.
name	String	The name of the document field.
value	String	The value associated with the document field.

NFCValidationResults

Contains the validation results of the NFC document. This includes nested check results as well as an overall check result. Below is an example JSON output that can be expected when results are returned:

"nfcValidationResults": { "microserviceId": "nfc", "nestedResults": { "aaChallengeSignatureCheck": { "metaData": {}, "displayName": "Active Authentication challenge signature validation", "description": "Check that the challenge signature calculated using the Active Authentication private key is valid.", "outcome": "NOT_AVAILABLE" }, "dscCscaPathRevocationCheck": { "metaData": {}, "displayName": "Document Signer Certificate path validation with revocation", "description": "Check that the Document Signer Certificate has not been revoked by the Country Signing CA.", "outcome": "NOT_AVAILABLE" }, "dscCscaPathCheck": { "metaData": { "failureMsg": "Signing certificate is expired" }, "displayName": "Document Signer Certificate path validation", "description": "Check that there is a valid path from the Document Signer Certificate to a valid Country Signing CA Certificate.", "failureMessage": "Signing certificate is expired", "outcome": "FAIL" }, "dgHashCheck": { "metaData": {}, "displayName": "Data Group hash check", "description": "Check that the hashes of the supplied LDS file contents match the hashes in the LDS security object (SOd).", "outcome": "NOT_AVAILABLE" }, "securityObjectChecks": { "metaData": {}, "displayName": "LDS Security Object checks", "description": "Validate the signature of the LDS Security Object and check its consistency against other document data.", "outcome": "NOT_AVAILABLE" } }, "service": "nfc", "outcome": "FAIL" }

_checks

Checks performed as part of a process definition is available as the private process variable _checks within the Session Data.

Checks

Each check is stored as part of a 'Check' object which have the following attributes:

Attribute	Type	Description
overallOutcome	ChecksOverallOutcome	The outcome of the check that was performed as part of the ID&V flow. Possible values include: PASS \| FAIL \| N/A
faceLiveness	<String, CheckResult>	Represents the face liveness check, providing an assessment on the presence of the applicant at the time of submission. The results are keyed on the 'face key' defined as part of the process definition.
faceQuality	<String, CheckResult>	The face quality result captured as part of the check. This result represents checks such as whether a face was present, has uniform lighting, and mask detection. The results are keyed on the 'face key' defined as part of the process definition.
doc2FaceMatch	<String,DocFaceMatchResult>	A list of results for the matching of face images from a document to the image captured. Each element of the list contains a name value pair map of the results of the 1:1 match of the images. The results are keyed on the 'face key' defined as part of the process definition.
acceptableDocument	<String, CheckResult>	The results of the acceptable document check - i.e. was the document type, document issuer, expiry, document age deemed to be acceptable. The results are keyed on the 'document key' defined as part of the process definition.
visualIntegrity	<String, VisualIntegrity>	The results of visual integrity checks such as black & white, color copy, screen replay and photo substitution as well as the document quality. The results are keyed on the 'document key' defined as part of the process definition.
cloudFunctions	<String, CheckResult>	The results of the associated Cloud Functions that were performed as part of the check.

DocFaceMatchData

The data associated with the document to Face Match check.

Attribute	Type	Description
DocFaceMatchData	<String, PageData>	The document to face match is keyed on a document page. For Identity Document this is `FRONT` or `BACK`.

PageData

Represents a check which is associated with a document page.

Attribute	Type	Description
visual	<String, CheckResult>	A check result which is keyed on a document page. For an Identity Document this is `FRONT` or `BACK`.

VisualIntegrity

Attribute	Type	Description
VisualIntegrity	<String, PageCheck>	A visual integrity check result which is keyed on a document page. For Identity Document this is `FRONT` or `BACK`.

PageCheck

A collection of checks performed on the document page including Document Quality, Black and White Copy, and more.

Attribute	Type	Description
documentQuality	CheckResult	Represents the results from the Document Quality check
documentBW	CheckResult	Results from the Black and White Copy detection which determines whether the captured document is genuine or a black and white photocopy.
documentColorCopy	CheckResult	Results from the Color Copy detection which determines whether the captured document is genuine or a color photocopy.
documentPhotoSub	CheckResult	Results from the Photo Substitution detection which determines whether the portrait image on the document has been tampered.
documentScreenRep	CheckResult	Results from the Document Screen Replay detection which determines whether the document image is genuine or a screen capture from a device such as a monitor.

CheckResult

This collection of data represents the final check result for the captured document.

Info

Note the value of 'metaData' key can be subject to change without notice.

Attribute	Type	Description
CheckResult	<String, Object>	This is a map of the individual result. At a minimum a check result will contain an 'outcome'. In addition a result may also contain 'metaData' which contains extra information about the result. Note that 'metaData' can be subject to change without notice.

Attribute

Type

Description

CheckResult

<String, Object>

This is a map of the individual result. At a minimum a check result will contain an 'outcome'.

In addition a result may also contain 'metaData' which contains extra information about the result. Note that 'metaData' can be subject to change without notice.

FacePlusCaptureLiveness

facePlusCaptureLiveness represents the liveness results retrieved from a Face Plus capture.

Attribute	Type	Description
face	<String, Object>	Represented by the face ID, this object contains all information from the face plus capture, including "metaData" and the "outcome".
metaData	<String, Object>	Contains "result", "threshold", and "serviceId"
result	<String, Object>	Contains the "capture_liveness" result from the Face Plus capture.
capture_liveness	<String, Object>	The capture liveness result contains the "probability" and "score" result.
probability	Integer	Represents the likelihood that the captured face image is a genuine face image.
score	Double	The score returned from the Face Plus check. The lower the value, the more likely the captured face is a genuine face image.
threshold	Double	The threshold value used to determine the strictness of the Face Plus check. The default value is 0.5.
serviceId	String	Represents the version of Face Plus that is used.
outcome	String	Provides the overall outcome of the Face Plus capture liveness result. Result can be "PASS" or "FAIL".

_customFormData

Custom Form Data is recorded as part of session data. i.e. when the form is submitted the data will be stored as follows:

form

Attribute	Type	Description
currentCaptureKey	String	The ID associated with the current form capture.
captures	<String,CustomFormCapture>	A list of form data captured during the ID&V process.
currentCapture	CustomFormCapture	Represents the current form capture.

CustomFormCapture

This data collection shows a list of all captures.

Attribute	Type	Description
captureTime	Date	The date the form data was captured
activityID	String	The ID of the Custom Data Form activity as defined in the Process Designer.
customDataFormId	String	The ID of the Custom Data Form.
customDataFormName	String	The name of the Custom Data Form.
customDataFormVersion	Integer	The Custom Data Form version number.
customDataFormPath	String	S3 location where the custom data form structure is saved as JSON.
customDataFormData	String	JSON string containing name value pair map of the captured custom form data.
customDataForm	String	Includes the full Custom Form specification in JSON format.
dataS3Path	String	S3 location where the values entered by the user in the custom data form are saved as JSON.

_customUis

Custom Pages are captured in session data within the _customUis process variable. When a Custom Page is present in the Process Definition, the following data will be accessible:

CustomPages

A collection of Custom Pages that are available to the Process Definition

Attribute	Type	Description
CustomPage	<String,CustomPage >	A map containing all Custom Pages included within the Process Definition.

CustomPage

Attribute	Type	Description
currentCaptureKey	String	The key associated with the current capture.
captures	<String, CustomPageCapture>	A map of all captures associated with the Custom Page.
currentCapture	CustomPageCapture	Contains data on the current capture.

CustomPageCapture

Attribute	Type	Description
id	String	The unique identifier of the current capture.
captureTime	LocalDateTime	The date and time that the Custom Page was captured.
activityId	String	The unique identifier of the Custom Page activity.
customPageId	String	The unique identifier of the Custom Page.
customPageName	String	The name of the Custom Page.
customPageVersion	Integer	The version of the Custom Page.
customPageType	CustomPageType	The type of Custom Page.
customPageUrl	String	The url of the Custom Page.
customPageParameters	<String, CustomPageParameter>	A map of parameters and associated values.

CustomPageParameter

Attribute	Type	Description
parameterName	String	The name of the parameter.
value	String	The value associated with the parameter.

_keyedAdditionalDocs

Additional Document data captured as part of a process definition is available as the process variable _keyedAdditionalDocs within the Session Data.

Documents are stored as a name value pair (map).

AdditionalDocument

Each document is stored as a 'AdditionalDocument' which have the following attributes:

Attribute	Type	Description
titles	<String, Object>	Contains a list of key value pairs representing the language and title of the document. For example: "en":"Electricity Bill"
currentAdditionalDocumentCaptureKey	String	A key used to identify the current additional document.
captures	<String, AdditionalDocumentCapture>	A name value pair map of AdditionalDocumentCapture which are to be captured. This map contains all the previous captures as well as the current capture.
currentDocumentCapture	AdditionalDocumentCapture	The current additional document capture

AdditionalDocumentCapture

A list of captures associated with the additional document.

Attribute	Type	Description
selectedAdditionalDocumentId	String	The ID associated with the selected additional document.
acceptedPages	<String, Object>	A key:value pair of accepted pages captured.
captures	<String, AdditionalDocumentPageCapture>	Contains a list of the captured document pages.
minNumPages	Integer	The minimum number of document pages required for capture.
maxNumPages	Integer	Available in a future release - The maximum number of document pages required for capture.
currentPageCaptureKey	String	The ID of the current capture page.
error	String	Records any error which may have been recorded
previousCaptureKeyWithError	String	Previous capture key with error
errorHolderMap	<String, Map>	Used to store all errors that have occurred during the execution of the activity.
currentCapture	AdditionalDocumentPageCapture	The current captured document page

AdditionalDocumentPageCapture

An AdditionalDocumentPageCapture represents an attempt to capture a single page of a document.

Attribute	Type	Description
captureTime	String	Timestamp representing the document capture time
page	String	The page name captured in the additional document
format	String	The format of the captured page image. Possible values include: jpeg, PNG.

_initVars

Attribute	Type	Description
params	<String, Object>	A list of initial variables captured in the Process Token as "Additional Parameters"

_identityStore

users

Users represents a collection of Users that exists within the Identity Store, defined by their 'User Key'. A User has the following attributes:

Attribute	Type	Description
tenantId	String	The unique ID of the tenant used to create the User.
storeName	String	The name of the Identity Store that the User belongs to.
id	String	A unique identifier of the User that is generated automatically upon creation.
extId	String	A unique identifier that can be defined upon creation. If no External ID is entered, TrustX will generation an ID automatically.
status	String	The current status of the User.
locale	String	A string containing the locale language, country, and variant of the User.
timezone	String	The timezone of the User's location.
createdDtm	DateTime	The date that the User was created.
lastUpdatedDtm	DateTime	The date that the User was last updated.
lastAuthenticatedDtm	DateTime	The date that the User last successfully authenticated.
lockedUntilDtm	DateTime	If a temporary lock is applied to the User, this represents the date on which the User will be unlocked.
type	String	An optional field used to organize Users into different types.
firstName	String	The first name of the User.
lastName	String	The last name of the User.
email	String	The User's email address.
phone	String	The User's phone number.
dateOfBirth	Date	The User's Date of Birth.
nationalities	List<String>	A list of nationalities associated with the User.
attributes	<String, String>	A collection of optional attributes to further define the User.

passkeys

The passkeys table contains a collection of registrations and authentications per passkey policy.

Registrations

The Registrations table contains a collection of registrations for each passkey. Each registration contained within the Registrations table is defined by their registration key.

A registration contains the following attributes:

Attribute	Type	Description
currentPasskeyRegistrationRecordId	String	A unique identifier for the current passkey registration record.
registrationRecords	registrationRecords	A collection of registration records where each record is defined by the currentPasskeyRegistrationRecordId.

registrationRecords

Attribute	Type	Description
createdDtm	DateTime	The date and time that the registration record was created.
storeName	String	The name of the associated Identity Store.
regPolicyName	String	The name of the associated registration policy.
rpId	String	The registration policy ID.
userId	String	The User ID.
extUserId	String	the external User ID.
userHandle	String (Base-64)	The User handle.
userName	String	The username of the User.
userDisplayName	String	The display name of the User.
challenge	String	The challenge associated with the registration.
userKey	String	The User key.
startPasskeyRegistrationResponse	startPasskeyRegistrationResponse	This object contains information about the start passkey registration response.
completePasskeyRegistrationResponse	completePasskeyRegistrationResponse	This object contains information about the complete passkey registration response.
passkeyRegBrowserResponse	passkeyRegBrowserResponse	This object contains information about the passkey registration browser response.
validationResults	validationResults	This object contains validation results.

startPasskeyRegistrationResponse

Attribute	Type	Description
clientRequest
timeout
excludeCredentials
authenticatorSelectionCriteria
attestation
extensions

completePasskeyRegistrationResponse

passkeyRegBrowserResponse

validationResults

Attribute	Type	Description
microserviceId	String	The ID associated with the microservice. In the context of Identity Store, this will be "id-store".
nestedResults	<String, Object>	A collection of results per check type.
service	String	The service used as part of validation. In the context of Identity Store, this will be "id-store".
outcome	String	The overall outcome of the validation.

Authentications

Attribute	Type	Description
currentPasskeyAuthenticationRecordId	String	A unique identifier for the current passkey authentication record.
authenticationRecords	authenticationRecords	A collection of authentication records where each record is defined by the currentPasskeyAuthenticationRecordId.

authenticationRecords

Attribute	Type	Description
createdDtm	DateTime	The date and time that the authentication record was created.
storeName	String	The name of the associated Identity Store.
authPolicyName	String	The name of the associated authentication policy.
rpId	String	The registration policy ID.
userId	String	The User ID.
extUserId	String	the external User ID.
challenge	String	The challenge associated with the authentication.
userKey	String	The User key.
startPasskeyAuthenticationResponse	startPasskeyAuthenticationResponse	This object contains information about the start passkey authentication response.
completePasskeyAuthenticationResponse	completePasskeyAuthenticationResponse	This object contains information about the complete passkey authentication response.
passkeyAuthBrowserResponse	passkeyAuthBrowserResponse	This object contains information about the passkey authentication browser response.
validationResults	validationResults	This object contains validation results.

Last updated on