LinX Workflow Object

The LinX Workflow object represents a workflow request that has been created for a Customer. This object contains a unique ID for the workflow, the workflow template details (if applicable), and a summary of the workflow steps.

Attributes

workflowId

string (UUID)

ID of the LinX workflow.

templateId

string (UUID)

ID of the LinX template used to create the workflow. Only returned if a template was used in the workflow request.

templateVersionId

string (UUID)

ID of the version of the LinX template used to create the workflow. Only returned if a template was used in the workflow request.

steps

array

Steps included in the workflow. For more information, see LinX Workflow Steps.

stepName

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:

notification Send an SMS message to the Customer with a link to the request.
customer-account Create a new Customer Account. Use this step if the workflow is for a new Customer.
lookup-profile Find an existing Customer Account. Use this step if the workflow is for an existing Customer.
enhance-profile Prompt the Customer to enter additional profile information, such as their address. This step can be used for both new and existing Customers.
financial-account Create a new external bank or card Financial Account for the Customer. This step can be used for both new and existing Customers.
lookup-financial-account Find an existing Financial Account for the Customer. This step can be used for existing Customers.
document-acceptance Require the Customer to accept one or more documents, such as a privacy policy or terms and conditions agreement. This step can be used for both new and existing Customers.
move-money Create a transaction using the Customer’s Financial Account from financial-account or lookup-financial-account. This step can be used for both new and existing Customers.

stepId

string (UUID)

ID of the workflow step.

LinX Workflow Object

				
					{
  "workflowId": "b6c0d73e-bd7b-4447-a30f-971ecad5fa8b",
  "templateId": "eacdf965-e9d8-408f-9cdf-3c7902d26ea7",
  "templateVersionId": "81f0f547-679c-4059-a6d7-1060021518cf",
  "steps": [
    {
      "stepName": "notification",
      "stepId": "07b6944a-70e1-48f0-bbb9-bf07b3c74820"
    },
    {
      "stepName": "lookup-profile",
      "stepId": "37fd1a41-d5bb-4b08-8474-86a329210c4b"
    },
      "stepName": "enhance-profile",
      "stepId": "63bae94f-12a2-40b8-be02-1b31f1d6c066"
    },
    {
      "stepName": "lookup-financial-account",
      "stepId": "ed2c04d9-a1e2-4821-91c0-51b898e70213"
    },
      "stepName": "document-acceptance",
      "stepId": "7894f1c1-6861-47c2-831c-c4b9b5d87e5f"
    },
    {
      "stepName": "move-money",
      "stepId": "c0168342-57d9-43fd-9cb3-8f30fc0605f5"
    }
  ]
}