Link Flow

Link is a preconfigured and hosted widget with workflow that enables your customers to effortlessly complete a onboarding process within a matter of minutes by utilizing the provided link.

Flow Overview

Steps

Create Case

The initial step is to create a case, which represents an individual who will go through the workflow.

During case creation, you can provide additional data such as first name, last name, number, or company name. These details can be utilized when executing tasks in the workflow. This step must be carried out on your backend server.

Please ensure that you create a Case for every new end user, as it acts as their representation within the system. For returning users, you can utilize the previously created Case to streamline the process.

Generate Link

A Link is generated to initiate the onboarding workflow for the individual represented by a case. To generate the link, both a Case and a Workflow Definition are necessary. This process must be carried out on your backend server. This step must be carried out on your backend server.

PreviousIntegration Quick Guide NextEmbedded Flow

Last updated 8 months ago

Steps

Create Case

The initial step is to create a case, which represents an individual who will go through the workflow.

Create case

Create a case with provided data

POSThttps://api.transactionlink.io/cases

Body

firstNamestring

First name

lastNamestring

Last name

personalNumberstring

Personal Number

emailstring

phoneobject

Phone

companyNamestring

Comapny name

companyNumberstring

Company number

companyAddressstring

Company address

documentsarray of object

Response

Case was created successfully

Body

createdDate*string

Creation time

caseId*string

Case Id

partyId*string

Case id

partyDetails*object

Request

const response = await fetch('https://api.transactionlink.io/cases', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": "Jan",
      "lastName": "Nowak",
      "personalNumber": 17300211234,
      "email": "jn@mail.com",
      "phone": {
        "countryCode": 48,
        "number": 666666666
      },
      "companyName": "Company name",
      "companyNumber": "Company number",
      "companyAddress": "Company address",
      "documents": [
        {
          "resourceId": "20fd5007-008d-447c-8378-6f81ea48fe65",
          "resourceName": "File name.pdf",
          "resourcePath": "resources/e1413f5b-acb0-4995-919a-3fc60c9592c5/20fd5007-008d-447c-8378-6f81ea48fe65/File name.pdf"
        },
        {
          "resourceId": "20fd5007-008d-447c-8378-6f81ea48fe65",
          "resourceName": "File name.pdf",
          "resourcePath": "resources/e1413f5b-acb0-4995-919a-3fc60c9592c5/20fd5007-008d-447c-8378-6f81ea48fe65/File name.pdf"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "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"
      }
    ]
  }
}

Generate Link

Generate link with the onboarding workflow

Generate link with the onboarding worflow for specific case

POSThttps://api.transactionlink.io/link

Body

caseId*string (uuid)

Case identifier for which we want to initiate the workflow

workflowDefinitionId*string

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"

Response

Link has been generated.

Body

link*string

Generated link to the workflow.

Example: "https://link.transactionlink.io/0df7e442-720c-4afb-8fed-c2664d6cb803"

Request

const response = await fetch('https://api.transactionlink.io/link', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "caseId": "123e4567-e89b-12d3-a456-426614174000",
      "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c"
    }),
});
const data = await response.json();

Response

{
  "link": "https://link.transactionlink.io/0df7e442-720c-4afb-8fed-c2664d6cb803"
}

const response = await fetch('https://api.transactionlink.io/cases', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "firstName": "Jan", "lastName": "Nowak", "personalNumber": 17300211234, "email": "jn@mail.com", "phone": { "countryCode": 48, "number": 666666666 }, "companyName": "Company name", "companyNumber": "Company number", "companyAddress": "Company address", "documents": [ { "resourceId": "20fd5007-008d-447c-8378-6f81ea48fe65", "resourceName": "File name.pdf", "resourcePath": "resources/e1413f5b-acb0-4995-919a-3fc60c9592c5/20fd5007-008d-447c-8378-6f81ea48fe65/File name.pdf" }, { "resourceId": "20fd5007-008d-447c-8378-6f81ea48fe65", "resourceName": "File name.pdf", "resourcePath": "resources/e1413f5b-acb0-4995-919a-3fc60c9592c5/20fd5007-008d-447c-8378-6f81ea48fe65/File name.pdf" } ] }), }); const data = await response.json();

{ "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" } ] } }