Workflows

Workflows API enables you to run flow through api.

To enable the workflow to be triggered via the public API, ensure proper configuration while avoiding any tasks that necessitate interaction with the end user.

POST Run Workflow

Run Workflow

Differences between versions: version 1 relies on caseId and is scheduled for deprecation, whereas version 2 uses recordId and no longer returns partyDetails.

post

/workflows/run

Body

application/jsonapplication/json;version=2

caseIdstring · uuidrequired

Case identifier for which we want to initiate the workflow

workflowDefinitionIdstringrequired

ID of the workflow definition

Example: 3b2d8a4f-579f-4e2e-a51c-f859e532fe8c

parametersIdstring

ID of the parameters used in workflow

Example: 4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302

Responses

application/jsonapplication/json;version=2

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.transactionlink.io/workflows/run' \
  --header 'Content-Type: application/json' \
  --data '{"caseId":"11111111-2222-3333-4444-555555555555","workflowDefinitionId":"3b2d8a4f-579f-4e2e-a51c-f859e532fe8c","parametersId":"4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302"}'

200

404

200

application/json

application/json;version=2

application/json

{
  "id": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
  "caseId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "status": "COMPLETED"
}

Workflow has been run

GET Check Workflow Status

Check Workflow Status

Check the status of a workflow

get

/workflows/{workflowId}

Path parameters

workflowIdstring · uuidrequired

Workflow identifier

Responses

application/jsonapplication/json;version=2

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.transactionlink.io/workflows/{workflowId}'

200

404

200

application/json

application/json;version=2

application/json

{
  "id": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
  "caseId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "status": "COMPLETED"
}

Returns the Workflow Status

GET Get Workflow Result

Get Workflow Result

Retrieve the result of a workflow

get

/workflows/{workflowId}/result

Path parameters

workflowIdstring · uuidrequired

Workflow identifier

Responses

application/jsonapplication/json;version=2

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.transactionlink.io/workflows/{workflowId}/result'

200

404

200

application/json

application/json;version=2

application/json

{
  "createdDate": "text",
  "caseId": "text",
  "partyId": "text",
  "partyDetails": {
    "business": {
      "companyNumber": "text",
      "companyName": "text",
      "companyAddress": "text"
    },
    "documents": [
      {
        "resourceId": "text",
        "resourceName": "text",
        "resourcePath": "text"
      }
    ],
    "personal": {
      "firstName": "text",
      "lastName": "text",
      "personalNumber": "text",
      "email": "text",
      "phone": {
        "countryCode": "text",
        "number": "text"
      }
    }
  }
}

Returns the workflow result