Embedded Flow

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 Token

A Token is generated to initiate the widget with the onboarding workflow for the individual represented by a Case. To generate the Token, both a case and a workflow definition are necessary. This step must be carried out on your backend server.

You must generate a new token each time you initialise the TransactionLink Widget

To import our Widget, you need to include it in your target page as follows. Use the transactionlink-widget tag to place the widget on your website.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
<transactionlink-widget />
<script>
    window.transactionlink_ready = () => {
        transactionlink.setOptions({
            token: 'exampleToken', // string
            ...otherOptions
        });
        transactionlink.open();
    }
</script>
<script src="https://widget.sandbox.transactionlink.io/transactionlink-widget.umd.js"></script>
</body>
</html>

PreviousLink Flow NextRunning Workflow

Last updated 3 months ago

Was this helpful?

POST /cases HTTP/1.1 Host: api.transactionlink.io Content-Type: application/json Accept: */* Content-Length: 646 { "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" } ] }

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

Embedded Flow

Flow Overview

Steps

Create Case

Generate Token

Set Token in the Widget

Flow Overview

Steps

Create Case

Generate Token

Set Token in the Widget

Generate widget token

Create case