The LinX Template Detail object represents detailed information for a workflow template. This object contains the template ID and version information, statistics regarding the template use, and the workflow steps and related parameters.
templateId
string (UUID)
ID of the LinX template. This ID is the same for all versions of the template.
templateVersionId
string (UUID)
ID of this version of the template.
version
integer
Version number of the LinX template.
name
string
Name for the LinX template. This name is used internally and should describe the purpose of the workflow (example: create-customer-and-enhance-profile). If name is not provided, a unique name for the template will be generated automatically.
displayName
string
Short readable name for the template.
description
string
Description of the template’s purpose.
customerMemo
string
Introductory message to display to the Customer at the start of the workflow.
Note You can override the this setting when creating a new workflow.
defaultExpiryDays
integer
Request expiry period (in days). The request and link provided to the Customer will expire at this time. If defaultExpiryDays is not provided, the system default value will be used.
Note You can override the this setting when creating a new workflow.
state
string enum, values: ACTIVE, ARCHIVED, SUSPENDED, DELETED
Current status of the template.
stats
object
Statistics tracking the template use.
allVersionsActiveWorkflows
integer
Number of active workflows (state = active) created by the template. Includes all versions of the template.
allVersionsWorkflows
integer
Number of workflows (all states) created by the template. Includes all versions of the template.
allVersionsLastExecutedAt
string (date-time)
Date and time the template was last used to create a workflow request. Includes all versions of the template.
currentVersionActiveWorkflows
integer
Number of active workflows (state = active) created by this version of the template.
currentVersionWorkflows
integer
Number of workflows (all states) created by this version of the template.
currentVersionLastExecutedAt
string (date-time)
Date and time this version of the template was last used to create a workflow request.
steps
array of objects
Steps included in the workflow. The steps must be listed in the following order:
For more information, see LinX Workflow Steps.
name
string enum, values: notification, customer-account, lookup-profile, enhance-profile, financial-account, lookup-financial-account, document-acceptance, move-money
Name of the step. The following values are supported:
displayName
string
Short readable name for the template.
description
string
Description of the template’s purpose.
input
object
Parameters for the step. You can define parameters for the following categories:
user Select parameters to be entered by the Customer. When the Customer completes the workflow steps, they will be prompted to provide this information. User input parameters are required for the enhance-profile and document-acceptance steps.
preDefined
ordered map
Template parameters with predefined values. The following parameters can be predefined for each step.
Note For detailed information about each parameter, see Workflow Parameter Definitions.
Note Required parameters for the workflow request are marked with *. These parameters can be provided in the template or when creating the request.
|
Step |
Template Parameters |
|---|---|
|
notification |
channel introductoryMessage |
|
customer-account |
none |
|
lookup-profile |
none |
|
financial-account |
* financialAccountSubType |
|
lookup-financial-account |
none |
|
move-money |
* transactionType * solution * currency * priority (required for ACH and Wire) * description (required for Wire) memo (available for Wire) * paymentReasonId |
user
ordered map
Parameters to be entered by the Customer. The Customer will be prompted to provide this information when completing the workflow. The following parameters can be provided for each step.
Note For detailed information about each parameter, see Workflow Parameter Definitions.
Note These parameters must be defined in the template (they cannot be defined in the workflow request). Required fields for each step are marked with *.
|
Step |
Template Parameters |
|---|---|
|
enhance-profile |
* At least one of the following parameters must be provided: personalInfo [salutation, dateOfBirth] addresses [SHIPPING, MAILING, PHYSICAL] phoneNumber [HOME or WORK] |
|
document-acceptance |
* documents [documentId, documentGroup] |
createdAt
string (date-time)
Date and time the LinX template was created in the RocketKOR system.
createdBy
object
Entity that created the LinX template.
id
string (UUID)
ID of the entity. Will be blank if createdBy.type is internal.
type
string enum, values: employee, service-account, internal
Type of entity. The following values are supported:
updatedBy
string
Entity that last updated the LinX template.
id
string (UUID)
ID of the entity. Will be blank if updatedBy.type is internal.
type
string enum, values: employee, service-account, internal
Type of entity. The following values are supported:
updatedAt
string (date-time)
Date and time the LinX template was last updated.
LinX Template Detail Object
{
"templateId": "6746d9f8-eb72-45d3-81c9-d53f386d6ce3",
"templateVersionId": "0e96b2ef-0642-4666-bc35-3c9e81eaf0b7",
"version": 2,
"name": "transaction-for-new-customer",
"displayName": "Create a transaction for a new Customer",
"description": "Create a new Customer and a new Financial Account, accept required documents, and create a transaction",
"customerMemo": "Complete Your Purchase",
"defaultExpiryDays": 2,
"state": "ACTIVE",
"stats": {
"allVersionsActiveWorkflows": 2,
"allVersionsWorkflows": 5,
"allVersionsLastExecutedAt": "2024-02-01T23:38:06.437Z",
"currentVersionActiveWorkflows": 1,
"currentVersionWorkflows": 3,
"currentVersionLastExecutedAt": "2024-02-01T23:38:06.437Z"
},
"steps": [
{
"name": "notification",
"displayName": "Notification",
"description": "Send notifications.",
"input": {
"preDefined": {
"channel": "SMS",
"introductoryMessage": "Please complete the following steps to set up your account and complete your purchase."
}
}
},
{
"name": "customer-account",
"displayName": "string",
"description": "string",
},
{
"name": "financial-account",
"displayName": "string",
"description": "string",
"input": {
"preDefined": {
"financialAccountSubType": "CHECKING",
}
}
},
{
"name": "document-acceptance",
"displayName": "string",
"description": "string",
"input": {
"user": {
"documents": [
{
"documentId": "fncl-privacy-policy",
"documentGroup": "rocket-financial"
}
]
}
}
},
{
"name": "move-money",
"displayName": "Transaction Summary",
"description": "Review and confirm your transaction summary.",
"input": {
"preDefined": {
"transactionType": "REQUEST",
"solution": "ACH",
"currency": "USD",
"priority": "IMMEDIATE",
"paymentReasonId": "bill-payment"
}
}
}
],
"createdBy": {
"id": "3f3e3100-95e6-48ec-bf51-dbba391a2942",
"type": "employee"
},
"createdAt": "2024-02-01T23:38:06.437Z",
"updatedBy": {
"id": "3f3e3100-95e6-48ec-bf51-dbba391a2942",
"type": "employee"
},
"updatedAt": "2024-02-01T23:38:06.437Z"
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2024 RocketKOR, Inc. All rights reserved.
