Documentation
HomeSupportStatusSign in ->
  • Developer guide
  • How it works?
  • Integration Quick Guide
    • Link Flow
    • Embedded Flow
    • Running Workflow
  • Production setup
  • Webhooks
  • Widget
    • Methods
    • Inline mode
  • Postman Collection
  • Changelog
  • Records
    • Introduction
    • Migration Guide: Migrating from Cases to Records
  • TRANSACTIONLINK API
    • API Reference
      • Authentication
      • Cases (deprecated)
      • Resources
      • Parameters
      • Token
      • Link
      • Workflows
      • Records
        • Attachments
    • API Changelog
    • API Versioning
  • Integrations
    • AIS
      • Data fields availability across banks
      • Testing data
    • Autopay
    • BIG Info Monitor
      • Company Report
      • Personal Report
      • Entrepreneur Report
      • Plus Sco Plus CR3 Report
    • BankID
      • 🇳🇴Norway
      • 🇩🇰Denmark
    • CEIDG
      • Get company
      • List companies
    • Companies House
      • Public Data Api
        • Exemptions
        • Persons with significant Control
        • UK Establishments
        • Filing History
        • Registers
        • Registered Office Address
        • Company Profile
        • Officers
        • Insolvency
        • Charges
      • Documents Api
    • ComplyAdvantage
    • ComplyCube
      • Identity Verification
        • Document Check
        • Proof of Address Check
        • Identity Check
      • Document Check
      • AML Screening Check
      • Face Authentication Check
    • Data Ninja
      • Labeling
      • Profiling
      • Scoring
    • eDO App
    • GUS
    • IAML
    • KRD
      • Company Report
      • Personal Report
      • Identity Card Verification
    • mObywatel
      • CitizenDetails
      • CitizenNationality
    • OnDato
    • Polish VAT Whitelist
    • Przelewy 24
    • PWG
    • QARD
    • Rejestr.io
    • Registru Centras
      • Get company
      • List documents
      • Get document
    • Smart-ID
    • SMS API
    • Twilio
    • MojeId
    • Veriff
      • Supported Browsers
    • VIES (Vat Validation)
      • vies
    • Zoho Sign
      • Adding document fields automatically using text tags
    • Idenfy
    • GBG
      • IDScan
      • Verifications
    • Visa
    • KYB
      • Company Profile
    • Handelsregister
      • Company profile
        • List companies
        • Get company
        • Get company documents
    • InfoCamere
      • Company profile
        • List companies
        • List persons
        • Get company
        • Get person
        • Get documents
    • CBE - Belgium Company Register
      • Company profile
        • List companies
        • Get company
        • List documents
        • Get document
    • Transparenzregister
      • Beneficial owners
        • List companies
        • List documents
        • Get documents
    • CVR (Danish Central Business Register)
      • Company profile
        • List Companies
        • Get Company
        • Get document
    • Malta Business Registry
      • Company profile
        • List Companies
        • Get Company
Powered by GitBook
On this page

Was this helpful?

  1. TRANSACTIONLINK API
  2. API Reference

Workflows

Workflows API enables you to run flow through api.

PreviousLinkNextRecords

Last updated 3 months ago

Was this helpful?

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

GET Check Workflow Status

GET Get Workflow Result

Check Workflow Status

get

Check the status of a workflow

Path parameters
workflowIdstring · uuidRequired

Workflow identifier

Responses
200
Returns the Workflow Status
404
Workflow not found
application/json
get
GET /workflows/{workflowId} HTTP/1.1
Host: api.transactionlink.io
Accept: */*
{
  "id": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
  "caseId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "status": "COMPLETED"
}

Get Workflow Result

get

Retrieve the result of a workflow

Path parameters
workflowIdstring · uuidRequired

Workflow identifier

Responses
200
Returns the workflow result
404
Workflow not found
application/json
get
GET /workflows/{workflowId}/result HTTP/1.1
Host: api.transactionlink.io
Accept: */*
{
  "createdDate": "text",
  "caseId": "text",
  "partyId": "text",
  "partyDetails": {
    "personal": {
      "firstName": "text",
      "lastName": "text",
      "personalNumber": "text",
      "email": "text",
      "phone": {
        "countryCode": "text",
        "number": "text"
      }
    },
    "business": {
      "companyNumber": "text",
      "companyName": "text",
      "companyAddress": "text"
    },
    "documents": [
      {
        "resourceId": "text",
        "resourceName": "text",
        "resourcePath": "text"
      }
    ]
  }
}
  • POST Run Workflow
  • POSTRun Workflow
  • GET Check Workflow Status
  • GETCheck Workflow Status
  • GET Get Workflow Result
  • GETGet Workflow Result

Run Workflow

post

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

Body
caseIdstring · uuidRequired

Case identifier for which we want to initiate the workflow

workflowDefinitionIdstringRequired

ID of the workflow definition

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

ID of the parameters used in workflow

Example: 4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302
Responses
200
Workflow has been run
404
Workflow Definition Not Found
application/json
post
POST /workflows/run HTTP/1.1
Host: api.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "caseId": "11111111-2222-3333-4444-555555555555",
  "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
  "parametersId": "4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302"
}
{
  "id": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
  "caseId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "status": "COMPLETED"
}