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.
Create a case with provided data
First name
Last name
Personal Number
Comapny name
Company number
Company address
POST /cases HTTP/1.1
Host: api.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 646
{
"firstName": "Jan",
"lastName": "Nowak",
"personalNumber": 17300211234,
"email": "[email protected]",
"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"
}
]
}
}
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.
Generate link with the onboarding worflow for specific case
Case identifier for which we want to initiate the workflow
Id of the workflow definition
3b2d8a4f-579f-4e2e-a51c-f859e532fe8c
Id of the parameters used in workflow
4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302
POST /link HTTP/1.1
Host: api.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 165
{
"caseId": "123e4567-e89b-12d3-a456-426614174000",
"workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
"parametersId": "4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302"
}
{
"link": "https://link.transactionlink.io/0df7e442-720c-4afb-8fed-c2664d6cb803"
}
Last updated
Was this helpful?