LinX Workflow Update

linx.workflow-updated

This event occurs when a LinX workflow is updated.

Payload Object

id

string (UUID)

Event ID.

type

string

Event type. Value is linx.workflow-updated.

createdAt

string (date-time)

Date and time the event occurred.

data

object

Data related to the event.

workflowId

string (UUID)

ID of the LinX workflow.

previousStepStatus

object

Status of the previous workflow step.

id

string

ID of the step.

status

string enum, values: ACTIVE, COMPLETED, DECLINED, CREATED, FAILED

Status of the step.

name

string

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.

displayName

string

Short display name for the step (example: Lookup customer account).

updateAt

string (date-time)

Date and time the step status was updated.

currentStepStatus

object

Status of the current workflow step.

id

string

ID of the step.

status

string enum, values: ACTIVE, COMPLETED, DECLINED, CREATED, FAILED

Status of the step.

name

string

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.

displayName

string

Short display name for the step (example: Lookup customer account).

updateAt

string (date-time)

Date and time the step status was updated.

nextStepStatus

object

Status of the next workflow step.

id

string

ID of the step.

status

string enum, values: ACTIVE, COMPLETED, DECLINED, CREATED, FAILED

Status of the step.

name

string

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.

displayName

string

Short display name for the step (example: Lookup customer account).

updateAt

string (date-time)

Date and time the step status was updated.

Sample Payload Object

				
					{
  "id": "a74c1b69-1aaf-411a-b179-3aacfc53bc2a",
  "type": "linx.workflow-updated",
  "createdAt": "2025-04-10T21:10:53.857Z",
  "data": {
    "workflowId": "d03dfc57-cd61-493e-b50c-797528a5aa98",
    "previousStepStatus" {
      "id": "21545913-2b4f-4684-bbd2-29e255437b2f",
      "status": "COMPLETED",
      "name": "notification",
      "displayName": "Notification",
      "updateAt": "2025-04-08T21:10:53.857Z"
    },
    "currentStepStatus" {
      "id": "bccff2ea-e8d1-41d7-868b-1a38ca7ea08f",
      "status": "ACTIVE",
      "name": "lookup-profile",
      "displayName": "Lookup Customer Account",
      "updateAt": "2025-04-09T21:10:53.857Z"
    },
    "nextStepStatus" {
      "id": "e94e875f-7fee-44d3-a01a-3235c4c5beab",
      "status": "CREATED",
      "name": "lookup-financial-account",
      "displayName": "Lookup Financial Account",
      "updateAt": "2025-04-09T21:10:53.857Z"
    }
  }
}

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.

Terms of Use     |     Privacy Policy
Exit mobile version