Session Data Tables

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.

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.

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.

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.

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.

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.

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

visualZone

<String, DocVizualZoneField>

The OCR data extracted from the document

mrz

<String,DocMRZField>

The barcode data extracted from the document

barcode

<String, DocBarCodeField>

The barcode data extracted from the document

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

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

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

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

<String, PageData>

The document to face match is keyed on a document page. For Identity Document this is FRONT or BACK.

visual

<String, CheckResult>

A check result which is keyed on a document page. For an Identity Document this is FRONT or BACK.

VisualIntegrity

<String, PageCheck>

A visual integrity check result which is keyed on a document page. For Identity Document this is FRONT or BACK.

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

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

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

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.

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.

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

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

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.

params

<String, Object>

A list of initial variables captured in the Process Token as "Additional Parameters"