Document Processor Activity Parameters

Document Processor Activities

Deprecated Regula Document Processor 7.2

Parameter Description Type Default
Document Key The identifier of the document. STRING doc1
Error navigation screen The screen the user will be navigated to in case of an error event occurs. STRING instructions
Exception Max Attempts Exception for max attempts. BOOLEAN ${true}
Image Profile The profile of the image; Cropped or Uncropped. STRING Cropped
Max Attempts The maximum number of allowed attempts. INTEGER ${3}
Measure System The unit of measurement to be used. Possible values are METRIC or IMPERIAL. STRING METRIC
Original Response Enabled If set to true, the response of additional checks will be returned (eg. Chip data). If false, additional checks will not be returned. BOOLEAN ${false}
Scenario Set the type of security check to perform where FullAuth will perform additional security checks. Possible values include FullAuth, FullProcess or DocType. STRING ${FullProcess}

Regula Document Processor 7.4

Parameter Description Type Default
Document Key The identifier of the document. STRING doc1
Error navigation screen The screen the user will be navigated to in case of an error event occurs. STRING instructions
Exception Max Attempts Exception for max attempts. BOOLEAN ${true}
Image Profile The profile of the image; Cropped or Uncropped. STRING Cropped
Max Attempts The maximum number of allowed attempts. INTEGER ${3}
Measure System The unit of measurement to be used. Possible values are METRIC or IMPERIAL. STRING METRIC
Original Response Enabled If set to true, the response of additional checks will be returned (eg. Chip data). If false, additional checks will not be returned. BOOLEAN ${false}
Scenario Set the type of security check to perform where FullAuth will perform additional security checks. Possible values include FullAuth, FullProcess or DocType. STRING ${FullProcess}

Deprecated ID Document Processor 7.5

Parameter Description Type Default
Document Key The identifier of the document. STRING doc1
Error navigation screen The screen the user will be navigated to in case of an error event occurs. STRING instructions
Exception Max Attempts Exception for max attempts. BOOLEAN ${true}
Image Profile The profile of the image; Cropped or Uncropped. STRING Cropped
Max Attempts The maximum number of allowed attempts. INTEGER ${3}
Measure System The unit of measurement to be used. Possible values are METRIC or IMPERIAL. STRING METRIC
Original Response Enabled If set to true, the response of additional checks will be returned (eg. Chip data). If false, additional checks will not be returned. BOOLEAN ${false}
Scenario Set the type of security check to perform where FullAuth will perform additional security checks. Possible values include FullAuth, FullProcess or DocType. STRING ${FullProcess}

ID Document Processor 7.7

Parameter Description Type Default
Document Key The identifier of the document. STRING doc1
Error navigation screen The screen the user will be navigated to in case of an error event occurs. STRING instructions
Exception Max Attempts Exception for max attempts. BOOLEAN ${true}
Fields to assign original values Enables customers to define a list of original values to be returned by the processor. LIST[STRING]
Image Profile The profile of the image; Cropped or Uncropped. STRING Cropped
Max Attempts The maximum number of allowed attempts. INTEGER ${3}
Measure System The unit of measurement to be used. Possible values are METRIC or IMPERIAL. STRING METRIC
Original Response Enabled If set to true, the response of additional checks will be returned (eg. Chip data). If false, additional checks will not be returned. BOOLEAN ${false}
Scenario Set the type of security check to perform where FullAuth will perform additional security checks. Possible values include FullAuth, FullProcess or DocType. STRING ${FullProcess}

Early Access ID Document Processor 8.2

Parameter Description Type Default
Already Cropped When enabled, will signal to the document processer that the document image is already cropped. boolean false
Document Key The identifier of the document. string doc1
Error navigation screen The screen the user will be navigated to in case of an error event occurs. string instructions
Exception Max Attempts Exception for max attempts. string ${true}
Fields to assign original values Enables customers to define a list of original values to be returned by the processor. list[string]
Image Profile The profile of the image; Cropped or Uncropped. string Cropped
Max Attempts The maximum number of allowed attempts. integer ${3}
Measure System The unit of measurement to be used. Possible values are METRIC or IMPERIAL. string METRIC
Original Response Enabled If set to true, the response of additional checks will be returned (eg. Chip data). If false, additional checks will not be returned. string ${false}
Scenario Set the type of security check to perform where FullAuth will perform additional security checks. Possible values include FullAuth, FullProcess or DocType. string ${FullProcess}

AID Capture Document Image

This activity captures a document image using the AuthenticID document processor.

Parameter Description Type Default
Auto Capture Check N Frames The number of frames to check during auto capture. INTEGER ${2}
Back Glare Threshold The back glare threshold. DOUBLE ${2.5}
Capture Mode The capture mode. STRING Auto
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 document side. STRING FRONT
Enable Location Detection Enable location detection. 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_STRING [ "instructions", "capture", "preview" ]
Starting Component ID The name of the capture step to be sent to the UI. STRING document-capture-aid
Timeout in Seconds Camera timeout in seconds. INTEGER ${60}
UI Component ID The name of the screen used in the capture UI. STRING instructions

Early Access PDF ID Upload V1

Enables Customers to upload ID Documents as a PDF file for processing by the ID Document Processor.

Parameter Description Type Default
Document Key The unique identifier of the external document. string externalDoc1
Format The format of the file to be uploaded. string pdf
Output Variable The variable representing the upload URL of the file upload. string uploadURL
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard