Document Activity Parameters

Document Activities

Deprecated Document Quality Assessment

Perform a document quality assessment to ensure that the captured document image meets the threshold values as defined in the input parameters.

Input Parameters

Parameter	Description	Type	Default
Crop Image	Whether the received document image will be cropped.	BOOLEAN	${true}
Document Key	The identifier of the document.	STRING	doc1

Document Quality Assessment 1.6.5

Perform a document quality assessment to ensure that the captured document image meets the threshold values as defined in the input parameters.

Input Parameters

Parameter	Description	Type	Default
Crop Image	Whether the received document image will be cropped.	BOOLEAN	${true}
Document Key	The identifier of the document.	STRING	doc1

Document Quality Assessment 2.0

Perform a document quality assessment to ensure that the captured document image meets the threshold values as defined in the input parameters.

Input Parameters

Parameter	Description	Type	Default
Crop Image	Whether the received document image will be cropped.	BOOLEAN	${true}
Document Key	The identifier of the document.	STRING	doc1

Document Quality Assessment 2.0.1

Perform a document quality assessment to ensure that the captured document image meets the threshold values as defined in the input parameters.

Note: Activity now supports configuring of error navigation screen, input validation (errorNavigation screen can be empty) and saving of activity history.

Input Parameters

Parameter	Description	Type	Default
Crop Image	Whether the received document image will be cropped.	boolean	${true}
Document Key	The identifier of the document.	string	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	string	true

Capture Document Image - Front v2

The Capture Document Image - Front v2 activity prompts the end user to capture the front-side of a document.

Input Parameters

Parameter	Description	Type	Default
Camera Height	The height of the camera set during capture.	INTEGER	${1080}
Camera Width	The width of the camera set during capture.	INTEGER	${1920}
Capture Orientation	Orientation for camera capture.	STRING	PORTRAIT
Cropping Tolerance	The cropping tolerance.	DOUBLE	${0.06}
Document Aspect Ratio	Document aspect ratio.	DOUBLE	${1.58}
Document Image Format	The format of the image to be captured.	STRING	jpeg
Document Key	The identifier of the document.	STRING	doc1
Document Side	The identifier of the document.	STRING	FRONT
Flash experience	Determines whether a flash is triggered upon successful capture of a document image.	BOOLEAN	${true}
List of Screens	The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview.	LIST_STRINGS	["instructions", "capture"]
PDF417 Enabled	Set whether PDF417 scanning will be enabled. By default, PDF417 scanning is disabled.	BOOLEAN	${false}
Report Metrics	When enabled, report metrics will send document capture session data to TrustX for debugging purposes. This functionality is enabled by default.	BOOLEAN	${true}
Starting Component ID	The name of the capture step to be sent to the UI	STRING	document-capture
Timeout in Seconds	Camera timeout in seconds.	INTEGER	${60}
UI Component ID	The name of the screen used in the capture UI.	STRING	instructions
Use Native Capture	Use the native capture process.	BOOLEAN	${false}

Capture Document Image - Front v3

The Capture Document Image - Front v3 activity prompts the end user to capture the front-side of a document.

Input Parameters

Parameter	Description	Type	Default
Advance configuration	An optional field that will allow the override of capture parameters without explicitely naming all the parameters.	STRING	{"idCaptureCropEnabled": false,"shouldDownscaleFrame": true, "delayStartInMilliseconds": 200}
Allow back	Allow the scanning of the back of the document.	BOOLEAN	{$false}
Camera Height	The height of the camera set during capture.	INTEGER	${1440}
Camera Width	The width of the camera set during capture.	INTEGER	${2560}
Capture Orientation	Orientation for camera capture.	STRING	PORTRAIT
Cropping Tolerance	The cropping tolerance.	DOUBLE	${0.06}
Disable switch camera	Disable switching between front and back cameras.	BOOLEAN	${false}
Document Aspect Ratio	Document aspect ratio.	STRING	${_documentType == 'PASSPORT' ? 1.42 : 1.58}
Document Image Format	The format of the image to be captured.	STRING	jpeg
Document Key	The identifier of the document.	STRING	doc1
Document Side	Which side of the document will be scanned by this activity.	STRING	FRONT
Flash experience	Determines whether a flash is triggered upon successful capture of a document image.	BOOLEAN	${true}
List of Screens	The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview.	LIST_STRINGS	["instructions", "capture"]
MRZ Enabled	Set whether MRZ scanning will be enabled. By default, MRZ scanning is enabled for passport documents.	STRING	${_documentType == "PASSPORT"}
PDF417 Enabled	Set whether PDF417 scanning will be enabled. By default, PDF417 scanning is disabled.	BOOLEAN	${false}
Report Metrics	When enabled, report metrics will send document capture session data to TrustX for debugging purposes. This functionality is enabled by default.	BOOLEAN	${true}
Starting Component ID	The name of the capture step to be sent to the UI	STRING	document-capture
Tag 1	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 2	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 3	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Timeout in Seconds	Camera timeout in seconds.	INTEGER	${60}
UI Component ID	The name of the screen used in the capture UI.	STRING	instructions
Use Native Capture	Use the native capture process.	BOOLEAN	${false}

Beta Capture Document Image - Front v4

The Capture Document Image - Front v4 activity prompts the end user to capture the front-side of a document.

Input Parameters

Parameter	Description	Type	Default
Advance configuration	An optional field that will allow the override of capture parameters without explicitely naming all the parameters.	STRING	{"delayStartInMilliseconds": 200,"lastPassedFrameDelayInMilliseconds":150}
Allow back	Allow the scanning of the back of the document.	BOOLEAN	{$false}
Camera Height	The height of the camera set during capture.	INTEGER	${1440}
Camera Width	The width of the camera set during capture.	INTEGER	${2560}
Capture Orientation	Orientation for camera capture.	STRING	PORTRAIT
Cropping Tolerance	The cropping tolerance.	DOUBLE	${0.06}
Disable switch camera	Disable switching between front and back cameras.	BOOLEAN	${false}
Document Aspect Ratio	Document aspect ratio.	STRING	${_documentType == 'PASSPORT' ? 1.42 : 1.58}
Document Image Format	The format of the image to be captured.	STRING	jpeg
Document Key	The identifier of the document.	STRING	doc1
Document Side	Which side of the document will be scanned by this activity.	STRING	FRONT
Flash experience	Determines whether a flash is triggered upon successful capture of a document image.	BOOLEAN	${true}
List of Screens	The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview.	LIST_STRINGS	["instructions", "capture"]
Manual Capture Delay	A list of integer values that determine the intervals when the popup modal will appear. The value is in seconds. Removing all values so that the input parameter is blank will disable the manual capture delay.	LIST_INTEGER	[30, 45]
MRZ Enabled	Set whether MRZ scanning will be enabled. By default, MRZ scanning is enabled for passport documents.	STRING	${_documentType == "PASSPORT"}
PDF417 Enabled	Set whether PDF417 scanning will be enabled. By default, PDF417 scanning is disabled.	BOOLEAN	${false}
Report Metrics	When enabled, report metrics will send document capture session data to TrustX for debugging purposes. This functionality is enabled by default.	BOOLEAN	${true}
Scale Frames Down if Slow	When set to true, the number of frames required for a successful capture will be reduced.	BOOLEAN	${true}
Starting Component ID	The name of the capture step to be sent to the UI	STRING	document-capture
Tag 1	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 2	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 3	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Timeout in Seconds	Camera timeout in seconds.	INTEGER	${60}
UI Component ID	The name of the screen used in the capture UI.	STRING	instructions
Use Legacy Processing Screen	If enabled, the legacy processing screen will be used during document capture. When disabled, a newer version of the processing screen will be shown. Both screens are customizable via Themes.	BOOLEAN	${false}
Use Native Capture Only	Use the native capture process.	BOOLEAN	${false}

Capture Document Image - Back v2

The Capture Document Image - Back v2 activity prompts the end user to capture the back-side of a document.

Input Parameters

Parameter	Description	Type	Default
Advanced configuration		STRING	{}
Camera Height	The height of the camera set during capture.	INTEGER	${1080}
Camera Width	The width of the camera set during capture.	INTEGER	${1920}
Capture Orientation	Orientation for camera capture.	STRING	PORTRAIT
Cropping Tolerance	The cropping tolerance.	DOUBLE	${0.06}
Document Aspect Ratio	Document aspect ratio.	DOUBLE	${1.58}
Document Image Format	The format of the image to be captured.	STRING	jpeg
Document Key	The identifier of the document.	STRING	doc1
Document Side	The identifier of the document.	STRING	FRONT
Flash experience	Determines whether a flash is triggered upon successful capture of a document image.	BOOLEAN	${true}
List of Screens	The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview.	LIST_STRINGS	["instructions", "capture"]
PDF417 Enabled	Set whether PDF417 scanning will be enabled. By default, PDF417 scanning is disabled.	STRING	${_documentType == "DRIVERS_LICENSE" && _documentCountry == "us"}
Report Metrics	When enabled, report metrics will send document capture session data to TrustX for debugging purposes. This functionality is enabled by default.	BOOLEAN	${true}
Starting Component ID	The name of the capture step to be sent to the UI	STRING	document-capture
Timeout in Seconds	Camera timeout in seconds.	INTEGER	${60}
UI Component ID	The name of the screen used in the capture UI.	STRING	instructions
Use Native Capture	Use the native capture process.	BOOLEAN	${false}

Capture Document Image - Back v3

The Capture Document Image - Back v3 activity prompts the end user to capture the back-side of a document.

Input Parameters

Parameter	Description	Type	Default
Advance configuration	An optional field that will allow the override of capture parameters without explicitely naming all the parameters.	STRING	{"idCaptureCropEnabled": false,"shouldDownscaleFrame": true, "delayStartInMilliseconds": 200}
Camera Height	The height of the camera set during capture.	INTEGER	${1440}
Camera Width	The width of the camera set during capture.	INTEGER	${2560}
Capture Orientation	Orientation for camera capture.	STRING	PORTRAIT
Cropping Tolerance	The cropping tolerance.	DOUBLE	${0.06}
Disable switch camera	Disable switching between front and back cameras.	BOOLEAN	${false}
Document Aspect Ratio	Document aspect ratio.	DOUBLE	${1.58}
Document Image Format	The format of the image to be captured.	STRING	jpeg
Document Key	The identifier of the document.	STRING	doc1
Document Side	The identifier of the document.	STRING	BACK
Flash experience	Determines whether a flash is triggered upon successful capture of a document image.	BOOLEAN	${true}
List of Screens	The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview.	LIST_STRINGS	["instructions", "capture"]
MRZ Enabled	Set whether MRZ scanning will be enabled. By default, MRZ scanning is enabled for passport documents.	STRING	${false}
PDF417 Enabled	Set whether PDF417 scanning will be enabled. By default, PDF417 scanning is disabled.	STRING	${_documentType == "DRIVERS_LICENSE" && _documentCountry == "us"}
Report Metrics	When enabled, report metrics will send document capture session data to TrustX for debugging purposes. This functionality is enabled by default.	BOOLEAN	${true}
Starting Component ID	The name of the capture step to be sent to the UI	STRING	document-capture
Tag 1	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 2	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 3	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Timeout in Seconds	Camera timeout in seconds.	INTEGER	${60}
UI Component ID	The name of the screen used in the capture UI.	STRING	instructions
Use Native Capture	Use the native capture process.	BOOLEAN	${false}

Beta Capture Document Image - Back v4

The Capture Document Image - Back v4 activity prompts the end user to capture the back-side of a document.

Input Parameters

Parameter	Description	Type	Default
Advance configuration	An optional field that will allow the override of capture parameters without explicitely naming all the parameters.	STRING	{"delayStartInMilliseconds": 200,"lastPassedFrameDelayInMilliseconds":150}
Camera Height	The height of the camera set during capture.	INTEGER	${1440}
Camera Width	The width of the camera set during capture.	INTEGER	${2560}
Capture Orientation	Orientation for camera capture.	STRING	PORTRAIT
Cropping Tolerance	The cropping tolerance.	DOUBLE	${0.06}
Disable switch camera	Disable switching between front and back cameras.	BOOLEAN	${false}
Document Aspect Ratio	Document aspect ratio.	DOUBLE	${1.58}
Document Image Format	The format of the image to be captured.	STRING	jpeg
Document Key	The identifier of the document.	STRING	doc1
Document Side	The identifier of the document.	STRING	BACK
Flash experience	Determines whether a flash is triggered upon successful capture of a document image.	BOOLEAN	${true}
List of Screens	The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview.	LIST_STRINGS	["instructions", "capture"]
Manual Capture Delay	A list of integer values that determine the intervals when the popup modal will appear. The value is in seconds. Removing all values so that the input parameter is blank will disable the manual capture delay.	LIST_INTEGER	[30, 45]
MRZ Enabled	Set whether MRZ scanning will be enabled. By default, MRZ scanning is enabled for passport documents.	STRING	${false}
PDF417 Enabled	Set whether PDF417 scanning will be enabled. By default, PDF417 scanning is disabled.	STRING	${_documentType == "DRIVERS_LICENSE" && _documentCountry == "us"}
Report Metrics	When enabled, report metrics will send document capture session data to TrustX for debugging purposes. This functionality is enabled by default.	BOOLEAN	${true}
Scale Frames Down if Slow	When set to true, the number of frames required for a successful capture will be reduced.	BOOLEAN	${true}
Starting Component ID	The name of the capture step to be sent to the UI	STRING	document-capture
Tag 1	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 2	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 3	The name of the capture step to be sent to the UI	STRING	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Timeout in Seconds	Camera timeout in seconds.	INTEGER	${60}
UI Component ID	The name of the screen used in the capture UI.	STRING	instructions
Use Legacy Processing Screen	If enabled, the legacy processing screen will be used during document capture. When disabled, a newer version of the processing screen will be shown. Both screens are customizable via Themes.	BOOLEAN	${false}
Use Native Capture Only	Use the native capture process.	BOOLEAN	${false}

Confirm Document Image

This activity prompts the end user to confirm that the document image captured is acceptable before advancing to the next step of the ID&V process.

Input Parameters

Parameter	Description	Type	Default
Allow Retake	Determines whether the user is allowed to retake the document image.	BOOLEAN	${false}
Document Key	The identifier of the document.	STRING	doc1
List of Screens	The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview.	LIST_STRINGS	["instructions", "capture", "preview"],
Starting Component ID	The name of the capture step to be sent to the UI	STRING	document-capture
UI Component ID	The name of the screen used in the capture UI.	STRING	instructions

Confirm Document Image v3

This activity prompts the end user to confirm that the document image captured is acceptable before advancing to the next step of the ID&V process.

Input Parameters

Parameter	Description	Type	Default
Allow Retake	Determines whether the user is allowed to retake the document image.	BOOLEAN	${false}
Document Key	The identifier of the document.	STRING	doc1
List of Screens	The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview.	LIST_STRINGS	["instructions", "capture", "preview"],
Starting Component ID	The name of the capture step to be sent to the UI	STRING	document-capture-v3
UI Component ID	The name of the screen used in the capture UI.	STRING	instructions

Select Document Type

The Select Document Type activity page will present the user with the ability to choose which document is expected to be captured. For example, a passport or driver's licence.

Input Parameters

Parameter	Description	Type	Default
Allowed Countries	Only allow certain countries to be selected. This is a list of two letter ISO 2 country codes. For example: gb	LIST_STRING
Custom Countries Configuration	Custom document configuration for countries. A JSON example can be found below.	STRING	{}
Default Country	The country code of the default country. This value must be a two letter ISO 2 country code. For example: gb. This field must not be blank.	STRING	us
Document Key	The identifier of the document.	STRING	doc1
Document Types	The list of document types to be presented to the user. Possible values include: DRIVERS_LICENSE, ID_CARD, PASSPORT, and OTHER.	LIST_STRING	[ "DRIVERS_LICENSE", "ID_CARD", "PASSPORT", "OTHER" ],
List of Screens	The list of screens to be presented to the user during this activity.	LIST_STRINGS	[ "document-type-selection", "country-selection" ],
Starting Component ID	The name of the capture step ID for this activity.	STRING	document-capture
UI Component ID	The name of the screen used in the capture UI.	STRING	document-type-selection

Select Document Type v3

The Select Document Type v3 activity page will present the user with the ability to choose which document is expected to be captured. For example, a passport or driver's licence.

Input Parameters

Parameter	Description	Type	Default
Allowed Countries	Only allow certain countries to be selected. This is a list of two letter ISO 2 country codes. For example: gb	LIST_STRING
Custom Countries Configuration	Custom document configuration for countries. A JSON example can be found below.	STRING	{}
Default Country	The country code of the default country. This value must be a two letter ISO 2 country code. For example: gb. This field must not be blank.	STRING	us
Document Key	The identifier of the document.	STRING	doc1
Document Types	The list of document types to be presented to the user. Possible values include: DRIVERS_LICENSE, ID_CARD, PASSPORT, and OTHER.	LIST_STRING	[ "DRIVERS_LICENSE", "ID_CARD", "PASSPORT", "OTHER" ],
List of Screens	The list of screens to be presented to the user during this activity.	LIST_STRINGS	[ "document-type-selection", "country-selection" ],
Starting Component ID	The name of the capture step ID for this activity.	STRING	document-capture-v3
UI Component ID	The name of the screen used in the capture UI.	STRING	document-type-selection

Beta Select Document Type v4

The Select Document Type v4 activity page will present the user with the ability to choose which document is expected to be captured. For example, a passport or driver's license.

Input Parameters

Parameter	Description	Type	Default
Allowed Countries	Only allow certain countries to be selected. This is a list of two letter ISO 2 country codes. For example: gb	LIST_STRING
Custom Countries Configuration	Custom document configuration for countries. A JSON example can be found below.	STRING	{}
Default Country	The country code of the default country. This value must be a two letter ISO 2 country code. For example: gb. This field must not be blank.	STRING	us
Document Key	The identifier of the document.	STRING	doc1
Document Types	The list of document types to be presented to the user. Possible values include: DRIVERS_LICENSE, ID_CARD, PASSPORT, and OTHER.	LIST_STRING	[ "DRIVERS_LICENSE", "ID_CARD", "PASSPORT", "OTHER" ],
List of Screens	The list of screens to be presented to the user during this activity.	LIST_STRINGS	[ "document-type-selection", "country-selection" ],
Starting Component ID	The name of the capture step ID for this activity.	STRING	document-capture-v3
UI Component ID	The name of the screen used in the capture UI.	STRING	document-type-selection

Early Access Define Document Type

Behaves similarly to 'Select Document Type' and can be used in conjunction with 'Accepted Document Type' but does not require input from the end-user.

Input Parameters

Parameter	Description	Type	Default
Acceptable Countries	A list of document countries that will be accepted.	List[String]
Country Code	The two-letter country code of the document	STRING	us
Document Key	The unique key associated with the document type.	STRING	doc1
Document Type	The accepted document type.	STRING	DRIVERS_LICENSE

Custom Countries Example

The example below demonstrates two custom countries. If the user chooses US as the issuing country, only Driver's licenses will be shown as a document type, meaning that the default document types will be overridden. If Ireland is selected as the issuing country, only Driver's license and Passport will be shown.

JSON
    
 
{  "us": {    "label": "United States",    "labelCode": "us",    "isoCode": "us",    "documents": [      {        "label": "Drivers License",        "scanBarCodeFrontSide": false,        "scanBarCodeBackSide": true,        "labelCode": "DRIVERS_LICENSE",        "type": "DRIVERS_LICENSE"      }    ]  },  "ie": {    "documents": [      {        "label": "Drivers License",        "labelCode": "DRIVERS_LICENSE",        "type": "DRIVERS_LICENSE"      },      {        "labelCode": "PASSPORT",        "type": "PASSPORT"      }    ]  }}
Copy

Acceptable Document Type

This activity determines whether the submitted document matches the document type selected from the Document Type field.

Input Parameters

Parameter	Description	Type	Default
Document Key	The identifier of the document.	STRING	doc1
Document Types	The list of accepted document types.	LIST_STRING	[DRIVERS_LICENSE, ID_CARD, PASSPORT]
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown.	BOOLEAN	${true}
Expiration Check Enable	Is the expiration check enabled for the document.	BOOLEAN	${true}
Expiration Tolerance Period	How long after a document has expired, the document will be accepted.	STRING	P0D
Lenient Check Enabled	Whether the checks will use a more lenient threshold.	STRING	${false}
Issue Date Age Check	Determines if the maximum document age check is applied.	BOOLEAN	${true}
Issue Date Age Period	The maximum age a document may be i.e. the time since issuance.	STRING	P10Y
Max Attempts	The number of failed attempts of face liveness before the exceedFailedLivenessCount exception is thrown.	INTEGER	${3}

Fuse Results

Input Parameters

Parameter	Description	Type	Default
Color Copy Threshold	Determines the threshold value for Color Copy Detection.	STRING	convenience
Document Key	The identifier of the document.	STRING	doc1
Grayscale Copy Threshold	Determines the threshold value for Black and White Copy Detection.	STRING	convenience
Max Attempts	The maximum number of failed attempts allowed.	INTEGER	${3}
Photosub Threshold	Determines the threshold value for Photo Substitution Detection.	STRING	convenience
Screen Replay Threshold	Determines the threshold value for Screen Replay Detection.	STRING	convenience

Black and White Copy Detection

The Black and White Copy Detection activity will determine whether the captured document image is an original image or a black and white copy of the original document.

Deprecated Black and White Copy Detection

Input Parameters

Parameter	Description	Type	Default
Detection Threshold	The detection threshold.	DOUBLE	${0.014}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Cropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}

Deprecated Black and White Copy Detection v2.1.0

Please note that from this version (Black and White Copy Detection v2.1.0) of the activity thresholds as specified as raw scores rather than a probability based threshold.

Input Parameters

Parameter	Description	Type	Default
Detection Threshold (raw)	The detection threshold.	DOUBLE	${0.9321}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Cropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}

Early Access Black and White Copy Detection v2.1.0 v2

Input Parameters

Parameter	Description	Type	Default
Crop expansion	The crop expansion value.	DOUBLE	${6.0}
Detection Threshold (raw)	The detection threshold.	DOUBLE	${0.9321}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Cropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}

Screen Replay Detection

The Screen Replay Detection activity will determine whether the captured document image is an original image or a captured image of the real document taken from a screen

Deprecated Screen Replay Detection v2.2.0

Input Parameters

Parameter	Description	Type	Default
Detection Threshold	The detection threshold.	DOUBLE	${0.13572}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Uncropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Pipeline	The support pipeline to be used. Daon does not rcommend updating this value.	STRING	ibis-sr
Result Output Variable Name	The name of the variable that the results will be outputted to.	STRING	screenReplayDetected
Service ID	Daon does not recommend updating this value. This input parameter will be removed in a future update.	STRING	idlive-doc-v2-2-0

Screen Replay Detection v2.5.0

Please note that from this version (Screen Replay Detection v2.5.0) of the activity thresholds as specified as raw scores rather than a probability based threshold.

Input Parameters

Parameter	Description	Type	Default
Detection Threshold (raw)	The detection threshold. This threshold is based on the raw score.	DOUBLE	${0.1252}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Uncropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Pipeline	The support pipeline to be used. Daon does not rcommend updating this value.	STRING	vulture-sr
Result Output Variable Name	The name of the variable that the results will be outputted to.	STRING	screenReplayDetected

Early Access Screen Replay Detection v3.3.0

Input Parameters

Parameter	Description	Type	Default
Detection Threshold (raw)	The detection threshold. This threshold is based on the raw score.	DOUBLE	${0.1252}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Uncropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Pipeline	The support pipeline to be used. Daon does not rcommend updating this value.	STRING	screen-replay_2024-09
Result Output Variable Name	The name of the variable that the results will be outputted to.	STRING	screenReplayDetected

Photo Substitution Detection

This activity determines whether the face image associated with the captured document matches the original document or has been substituted for a different face image.

Deprecated Photo Substitution Detection v1.4.1

Input Parameters

Parameter	Description	Type	Default
Detection Threshold	The detection threshold.	DOUBLE	${0.007808}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Cropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Service ID	Daon does not recommend updating this value. This input parameter will be removed in a future update.	STRING	photosub-v1-1

Photo Substitution Detection v1.5.0

Please note that from this version (Photo Substitution Detection v2.5.0) of the activity thresholds as specified as raw scores rather than a probability based threshold.

Input Parameters

Parameter	Description	Type	Default
Crop expansion		double	${6.0}
Document Key	The unique ID of the captured document.	string	doc1
Error navigation screen	The screen to show in the event that an error occurs.	string	preview
Exception on Max Attempts Exceeded	If enabled, an error exception will occur when the maximum number of attempts is exceeded.	boolean	${true}
Detection Threshold	The detection threshold.	DOUBLE	${0.9057}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	boolean	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	string	Cropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	integer	${3}
Threshold (raw)	The Photo Substitution Threshold.	double	${0.9057}

Early Access Photo Substitution Detection v1.5.1.2

Input Parameters

Parameter	Description	Type	Default
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	boolean	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	string	Cropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	integer	${3}
Threshold (raw)	The Photo Substitution Threshold.	double	${0.8974}

Color Copy Detection

Color Copy Detection determines whether the captured document image is an original document image or a color photocopy of the original document.

Deprecated Color Copy Detection v1.3.0

Input Parameters

Parameter	Description	Type	Default
Detection Threshold	The detection threshold.	DOUBLE	${0.04}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Cropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Service ID	Daon does not recommend updating this value. This input parameter will be removed in a future update.	STRING	colorcopy-v1-1

Color Copy Detection v.1.4.0

Please note that from this version (Color Copy Detection v1.4.0) of the activity thresholds as specified as raw scores rather than a probability based threshold.

Input Parameters

Parameter	Description	Type	Default
Crop expansion	The crop expansion value.	DOUBLE	${6.0}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Cropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Threshold (raw)	The detection threshold.	DOUBLE	${0.7245}

Early Access Color Copy Detection v2.2.0

Input Parameters

Parameter	Description	Type	Default
Crop expansion	The crop expansion value.	DOUBLE	${6.0}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Cropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Threshold (raw)	The detection threshold.	DOUBLE	${0.5961}

Portrait Substitution Detection

An attacker presents an authentic ID, except that the identifying photo has been replaced. This attack is often an attempt to associate a victim's identity with the attacker's likeness, in order to trick human agents and/or facial recognition systems.

Much like Photo Substitution Detection, Portrait Substitution will determine whether the identifying photo of a document has been replaced.

Deprecated Portrait Substitution Detection v2.2.0

Input Parameters

Parameter	Description	Type	Default
Detection Threshold	The detection threshold.	DOUBLE	${0.5}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Uncropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Pipeline	The support pipeline to be used. Daon does not rcommend updating this value.	STRING	quail-ps
Result Output Variable Name	The name of the variable that the results will be outputted to.	STRING	portraitSubstitutionDetected
Service ID	Daon does not recommend updating this value. This input parameter will be removed in a future update.	STRING	idlive-doc-v2-2-0

Portrait Substitution Detection v2.5.0

Please note that from this version (Portrait Substitution Detection v2.5.0) of the activity thresholds as specified as raw scores rather than a probability based threshold.

Input Parameters

Parameter	Description	Type	Default
Detection Threshold (raw)	The detection threshold.	DOUBLE	${0.3623}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Uncropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Pipeline	The support pipeline to be used. Daon does not rcommend updating this value.	STRING	umbrellabird-ps
Result Output Variable Name	The name of the variable that the results will be outputted to.	STRING	portraitSubstitutionDetected

Early Access Portrait Substitution Detection v3.3.0

Input Parameters

Parameter	Description	Type	Default
Detection Threshold (raw)	The detection threshold.	DOUBLE	${0.3623}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Uncropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Pipeline	The support pipeline to be used. Daon does not rcommend updating this value.	STRING	portrait-substitution_2024-05
Result Output Variable Name	The name of the variable that the results will be outputted to.	STRING	portraitSubstitutionDetected

Paper Copy Detection

Similar to a screen replay attack, Paper Copy Detection determines whether the camera is presented with a physical, paper copy of the original document or whether the document has been altered.

This service is used together with Screen Replay Detection to maximize the best possible results when determining the legitimacy of a document.

Deprecated Paper Copy Detection v2.2.0

Input Parameters

Parameter	Description	Type	Default
Detection Threshold	The detection threshold.	DOUBLE	${0.5}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Uncropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Pipeline	The support pipeline to be used. Daon does not rcommend updating this value.	STRING	penguin-pc
Result Output Variable Name	The name of the variable that the results will be outputted to.	STRING	paperCopyDetected
Service ID	Daon does not recommend updating this value. This input parameter will be removed in a future update.	STRING	idlive-doc-v2-2-0

Paper Copy Detection v2.5.0

Please note that from this version (Paper Copy Detection v2.5.0) of the activity thresholds as specified as raw scores rather than a probability based threshold.

Input Parameters

Parameter	Description	Type	Default
Detection Threshold (raw)	The detection threshold.	DOUBLE	${0.5}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Uncropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Pipeline	The support pipeline to be used. Daon does not rcommend updating this value.	STRING	woodpecker-pc
Result Output Variable Name	The name of the variable that the results will be outputted to.	STRING	paperCopyDetected

Early Access Paper Copy Detection v3.3.0

Input Parameters

Parameter	Description	Type	Default
Detection Threshold (raw)	The detection threshold.	DOUBLE	${0.5}
Document Key	The identifier of the document.	STRING	doc1
Error navigation screen	The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event.	STRING	preview
Exception on Max Attempts Exceeded	If the maxAttempts is exceeded, should exceedFailedLivenessCount exception be thrown	BOOLEAN	${true}
Image Profile	The profile of the image; Cropped or Uncropped.	STRING	Uncropped
Max Attempts	The number of attempts before the document is rejected or the failed flag is set.	INTEGER	${3}
Pipeline	The support pipeline to be used. Daon does not rcommend updating this value.	STRING	printed-copy_2025-05
Result Output Variable Name	The name of the variable that the results will be outputted to.	STRING	paperCopyDetected

Additional Document Capture

Additional Capture Decider

The Additional Capture Decider activity is used to determine whether all required documents have been captured. For more information, see Additional Documents Collection guide.

### Capture Additional Document V2

The Capture Additional Document activity is used to capture or upload the selected document based on the ID that is sent from the client web application. For more information, see the Additional Documents Collection guide.

Input Parameters

Parameter	Description	Type	Default
Document File Format	The accepted image format of the captured document image. Possible values include: .jpeg, .png, and .pfd /td>	STRING	jpeg
Starting Component ID	The unique identifier associated with the activity screen.	STRING	additional-documents
List of Screens	A list of screens to display to the user	LIST_STRING	['instructions','processing']
timeoutInSeconds	The allotted time required to complete the capture before a timeout error occurs.	INTEGER	${60}
UI Component Id	Unique identifier associated with the UI component.	STRING	instructions
useNativeCapture	A boolean value to determine whether to use native capturing.	BOOLEAN	false

Capture Additional Document V3

Input Parameters

Parameter	Description	Type	Default
List of Screens	A list of screens to display to the user	LIST_STRING	instructions
Starting component ID	Unique identifier for the starting component.	STRING	additional-documents
UI Component Id	Unique identifier associated with the UI component.	STRING	instructions

Beta Capture Additional Document v4

Input Parameters

Parameter	Description	Type	Default
List of Screens	A list of screens to display to the user	LIST_STRING	instructions
Starting component ID	Unique identifier for the starting component.	STRING	additional-documents
UI Component Id	Unique identifier associated with the UI component.	STRING	instructions

Deprecated Capture Additional Document Image

This activity is maintained only for backwards compatibility purposes with older Process Definitions. For new Process Definitions, please use the Capture Additional Document activity.

The Capture Additional Document Image activity is used to capture or upload the selected document image based on the ID that is sent from the client web application. For more information, see the Additional Documents Collection guide.

Input Parameters

Parameter	Description	Type	Default
docImageFormat	The accepted image format of the captured document image./td>	STRING	jpeg
screenID	The unique identifier associated with the activity screen.	STRING	selection
screens	The list of screens to be shown to the end user.	LIST_STRING	selection
stepId	The unique identifier associated with the step.	STRING	additional-documents
timeoutInSeconds	The allotted time required to complete the capture before a timeout error occurs.	INTEGER	${60}
useNativeCapture	A boolean value to determine whether to use native capturing.	BOOLEAN	${false}

Deprecated Select Additional Document Type

Select Additional Document Type is used to choose the appropriate document that will be captured via picture or file upload. For more information, see the Additional Documents Collection guide.

Input Parameters

Parameter	Description	Type	Default
additional document configuration	The JSON schema used to define the additional documents to be captured.	STRING	JSON Sample
List of Screens	The list of screens to be shown to the end user.	LIST_STRING	selection
Starting component ID	The unique identifier associated with the activity.	STRING	additional-documents
UI Component Id	The unique identifier of the UI component.	STRING	selection

Select Additional Document Type V2

Select Additional Document Type is used to choose the appropriate document that will be captured via picture or file upload. For more information, see the Additional Documents Collection guide.

Input Parameters

Parameter	Description	Type	Default
additional Document Key		STRING	addDoc1
additional document configuration	The JSON schema used to define the additional documents to be captured.	STRING	JSON Sample
List of Screens	The list of screens to be shown to the end user.	LIST_STRING	selection
Starting component ID	The unique identifier associated with the activity.	STRING	additional-documents
UI Component Id	The unique identifier of the UI component.	STRING	selection

Text Substitution Detection

Beta

Text substitution detection performs a check against a captured document to determine whether any text on the document has been altered, substituted or obscured from the original document.

Input Parameters

Parameter	Description	Type	Default
Document Key	The unique key of the document that text substitution will be performed against.	String	doc1
Error navigation screen	The screen that will be shown on TrustWeb when an error returns.	String	preview
Exception On Max Attempts Exceeded	If enabled, an exception will be thrown once the defined maximum attempt have been exceeded.	Boolean	${true}
Image Profile	The image profile that will be used for text substitution detection.	String	Cropped
Max Attempts	The maximum number attempts allowed before an exception is returned.	Integer	${3}

Capture Document Image & Video - Front v4

Beta

Prompts the end-user to capture a document image and video of the front-side of their identity document.

Input Parameters

Parameter	Description	Type	Default
Advanced configuration	An optional field that will allow the override of capture parameters without explicitely naming all the parameters.	string	{"delayStartInMilliseconds": 150}
Allow back	If enabled, allow back cameras for document capture.	boolean	${true}
Camera Height	The height of the camera set during capture.	integer	${1440}
Camera Width	The width of the camera set during capture.	integer	${2560}
Capture Orientation	Orientation for camera capture.	string	PORTRAIT
Cropping Tolerance	The cropping tolerance.	double	${0.06}
Disable switch camera	Disable switching between front and back cameras.	boolean	${false}
Document Aspect Ratio	Document aspect ratio.	string	${_documentType == 'PASSPORT' ? 1.42 : 1.58}
Document Image Format	The format of the image to be captured.	string	jpeg
Document Key	The identifier of the document.	string	doc1
Document Side	The identifier of the document.	string	FRONT
Flash experience	Determines whether a flash is triggered upon successful capture of a document image.	boolean	${false}
List of Screens	The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview.	list[strings]	["instructions", "capture"]
Manual Capture Delay	A list of integer values that determine the intervals when the popup modal will appear. The value is in seconds.	list[integer]	[30, 45]
MRZ Enabled	Set whether MRZ scanning will be enabled. By default, MRZ scanning is enabled for passport documents.	string	${_documentType == "PASSPORT"}
PDF417 Enabled	Set whether PDF417 scanning will be enabled. By default, PDF417 scanning is disabled.	string	${false}
Report Metrics	When enabled, report metrics will send document capture session data to TrustX for debugging purposes. This functionality is enabled by default.	boolean	${true}
SDK version	The SDK version used for the capture.	string	v4.1.x
Scale Frames Down If Slow	When enabled, reduces the number of required frames of a document capture in the event that the capture processing is too slow.	boolean	${true}
Starting Component ID	The name of the capture step to be sent to the UI	string	document-capture-v4
Video Sequence	If enabled, the end-user will be requested to capture a video of their document.	boolean	${true}
Tag 1	The name of the capture step to be sent to the UI	string	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 2	The name of the capture step to be sent to the UI	string	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 3	The name of the capture step to be sent to the UI	string	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Timeout in Seconds	Camera timeout in seconds.	integer	${60}
UI Component ID	The name of the screen used in the capture UI.	string	instructions
Use Native Capture	Use the native capture process.	boolean	${false}
Video Checks Settings	Provides various configurations to video check settings.	map<string, string>
Video Settings	Provides various configurations to video settings.	map<string, string>
Video User Action	The actions that the end-user will be requested to perform. The instructions are intended for manual verification purposes. TrustX will not verify the correct actions have been performed. Possible values include: TILT_LEFT TILT_RIGHT	list[string]

Video Check Settings

Map Entry	Description	Default Value
FPS Enabled	If enabled, FPS set in the Video Settings will be tested against the captured video.	true
FPS Tolerance	The tolerance level of the FPS check.	5%
Length Enabled	If enabled, the length of the video will be checked to ensure it meets the configured length set in the Video Settings.	true
Length Tolerance	The tolerance level of the length check.	1s
Resolution Enabled	If enabled, the resolution of the captured video will be checked against the VideoHeight and VideoWidth values configured in the Video Settings.	true
Upload Integrity Enabled	If enabled, perform a file upload integrity check against the captured video.	true

Video Settings

Map Entry	Description	Default Value
Bitrate	The minimum required bitrate of the captured video.
FPS	The minimum required frames-per-second of the captured video.	25
Length	The minimum required length of the video.	5
VideoHeight	The minimum required height of the video.	720
VideoWidth	The minimum required width of the video.	1280

Capture Document Image & Video - Back v4

Beta

Prompts the end-user to capture a document image and video of the back-side of their identity document.

Input Parameters

Parameter	Description	Type	Default
Advanced configuration	An optional field that will allow the override of capture parameters without explicitely naming all the parameters.	string	{"delayStartInMilliseconds": 200,"lastPassedFrameDelayInMilliseconds":150}
Camera Height	The height of the camera set during capture.	integer	${1440}
Camera Width	The width of the camera set during capture.	integer	${2560}
Capture Orientation	Orientation for camera capture.	string	PORTRAIT
Cropping Tolerance	The cropping tolerance.	double	${0.06}
Disable switch camera	Disable switching between front and back cameras.	boolean	${false}
Document Aspect Ratio	Document aspect ratio.	double	${1.58}
Document Image Format	The format of the image to be captured.	string	jpeg
Document Key	The identifier of the document.	string	doc1
Document Side	The identifier of the document.	string	BACK
Flash experience	Determines whether a flash is triggered upon successful capture of a document image.	boolean	${false}
List of Screens	The list of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview.	list[strings]	["instructions", "capture"]
Manual Capture Delay	A list of integer values that determine the intervals when the popup modal will appear. The value is in seconds.	list[integer]	[30, 45]
MRZ Enabled	Set whether MRZ scanning will be enabled. By default, MRZ scanning is enabled for passport documents.	boolean	${false}
PDF417 Enabled	Set whether PDF417 scanning will be enabled. By default, PDF417 scanning is disabled.	boolean	${false}
Report Metrics	When enabled, report metrics will send document capture session data to TrustX for debugging purposes. This functionality is enabled by default.	boolean	${true}
SDK version	The SDK version used for the capture.	string	v4.1.x
Scale Frames Down If Slow	When enabled, reduces the number of required frames of a document capture in the event that the capture processing is too slow.	boolean	${true}
SDK version	Determines which version of the document capture SDK is used.	string	v4.1.x
Starting Component ID	The name of the capture step to be sent to the UI	string	document-capture-v4
Video Sequence	If enabled, the end-user will be requested to capture a video of their document.	boolean	${true}
Tag 1	The name of the capture step to be sent to the UI	string	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 2	The name of the capture step to be sent to the UI	string	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Tag 3	The name of the capture step to be sent to the UI	string	Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional.
Timeout in Seconds	Camera timeout in seconds.	integer	${60}
UI Component ID	The name of the screen used in the capture UI.	string	instructions
Use Native Capture	Use the native capture process.	boolean	${false}
Video Checks Settings	Provides various configurations to video check settings.	map<string, string>
Video Settings	Provides various configurations to video settings.	map<string, string>
Video User Action	The actions that the end-user will be requested to perform. The instructions are intended for manual verification purposes. TrustX will not verify the correct actions have been performed. Possible values include: TILT_LEFT TILT_RIGHT	list[string]

Video Check Settings

Map Entry	Description	Default Value
FPS Enabled	If enabled, FPS set in the Video Settings will be tested against the captured video.	true
FPS Tolerance	The tolerance level of the FPS check.	5%
Length Enabled	If enabled, the length of the video will be checked to ensure it meets the configured length set in the Video Settings.	true
Length Tolerance	The tolerance level of the length check.	1s
Resolution Enabled	If enabled, the resolution of the captured video will be checked against the VideoHeight and VideoWidth values configured in the Video Settings.	true
Upload Integrity Enabled	If enabled, perform a file upload integrity check against the captured video.	true

Video Settings

Map Entry	Description	Default Value
Bitrate	The minimum required bitrate of the captured video.
FPS	The minimum required frames-per-second of the captured video.	25
Length	The minimum required length of the video.	5
VideoHeight	The minimum required height of the video.	720
VideoWidth	The minimum required width of the video.	1280

Last updated on