Parameters of a Transaction

Following are descriptions of the parameters available when you are creating a transaction from the portal.

General Parameters

Rules Management

Advanced Settings

Customer Input (Prepared Data)

General Parameters

Parameter Description
Workflow

Select the workflow that will process the transaction. Options are as follows:

  • Standalone ID

  • Standalone ID and Identity Verification

  • Document Verification

Alternatively, you can enter a workflow key (see below).

Workflow Key

You can enter a workflow key in this field instead of selecting one from the Workflow list.

Locale Select the default language that will be displayed in the web client for the end user.
User Reference Enter an ID you will use during searches and reporting to identify the end user who will scan their ID and selfie to perform this verification, such as a user’s internal customer ID.

Customer Reference

Enter an ID you will use during searches and reporting to identify this specific verification transaction.

Reporting Criteria

Enter any additional data you want to use to track the verifications. This data will show up in callbacks and retrievals but not in the Jumio reports.

Token Lifetime

Enter the time in minutes until the redirect link expires. The default value is 30 minutes.

Rules Management

Parameter Description
Ruleset ID for Decision Label Enter the UUID number of the ruleset to be used to assign decision labels to the transaction.
Ruleset ID for Risk Scoring Enter the UUID number of the ruleset to be used to assign risk scores to the transaction.
Ruleset ID for Additional Risk Scoring Enter the UUID number of the ruleset to be used for additional risk scoring.

Advanced Settings

Parameter Description
Document Type The type of document being verified (for example, CC, PB, etc.). For a list of document types, see Supported Documents
Document Country The country of the document being verified.
Watchlist Screening The watchlist screening search profile to be used in the request body. See Watchlist Screening for more information.

Document Credential Extraction

Select True or False to indicate whether or not document credentials are to be extracted,

Customer Input (Prepared Data)

Customer Input parameters are available only when the selected workflow is configured to accept prepared data.

This section allows you to submit prepared data for use by the workflow executing the transaction. Prepared data is used to upload values for data fields that are required by a capability or risk signal in a workflow, but are not extracted from another credential such as an ID or document.

You can enter the prepared data either as values on the Individual Fields tab or as a JSON object on the Entire JSON tab.

See Prepared Data for more information, including descriptions of individual fields and an example of a JSON object used to upload prepared data.