LinX Templates Overview

What are LinX Workflow Templates?

Use a LinX workflow template to save a specific workflow configuration. You can then use the template to quickly configure a new LinX request.

You can create workflow templates for a variety of use cases. For example, you can create a workflow template that will:

Create a new Customer Account and enhance the Customer’s profile.
Create a new Customer Account, create a new external card Financial Account for the Customer, require the Customer to accept a privacy policy, and create a Push to Card transaction.
Lookup an existing Customer Account, lookup an existing external bank Financial Account for the Customer, and create an ACH transaction.

What Does a Workflow Template Contain?

A workflow template can contain some or all of the workflow settings, including:

Introductory message shown to the Customer at the start of the workflow (optional; if included, can be overridden when creating a new LinX request)
Workflow request expiry period (optional; if included, can be overridden when creating a new LinX request)
Workflow steps (required)
Workflow step parameters (user input parameters are required; other parameters are optional)

User Input Parameters

If the workflow contains steps that require input from the Customer, the parameters for these steps must be configured in the template. This includes the following steps:

enhance-profile Select the profile information the Customer will be prompted to enter, such as a phone number and address.
document-acceptance Select the documents that the Customer will be prompted to accept.

Predefined Parameters

You can set predefined values for many workflow step parameters, including:

notification Add a standard introductory message.
financial-account Select the type of Financial Account to be created.
move-money Select the transaction type, solution, currency, priority, and payment reason ID for a transaction.

How Do I Use a Workflow Template?

When creating a new LinX request for a Customer, select a template with the workflow configuration you want to use. The request will be created using the latest version of the template.

The workflow steps must be included in the template. Some of the step parameters can be set in the template, while other parameters can be (or must be) provided in the request body. For details, see Workflow Based on a Template: Required/Optional Parameters.