Link

A single-use link with a specific workflow

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

Each newly generated link causes the previous one to expire.

POST Generate Link

Generate link with the onboarding workflow

Generate link with the onboarding worflow for specific case

POSThttps://api.transactionlink.io/link

Body

application/json

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

201400404

Link has been generated.

Body

application/json

link*string

Generated link to the workflow.

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

Request

JavaScriptCurlPython

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

201400404

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

POST Generate and send Link

Generate and send link with the onboarding workflow to the end user

Generate and send link with the onboarding workflow to the end user

POSThttps://api.transactionlink.io/link/send

Body

application/json

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"

personalizationobject

Response

204400404

Link has been generated and sent to the end-user.

Request

JavaScriptCurlPython

const response = await fetch('https://api.transactionlink.io/link/send', {
    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

400404

{
  "fingerprint": "a123bcd4-a123-1ab2-a123-ab1c2d3efg4h",
  "errors": [
    {
      "code": "ERROR_CODE",
      "message": "description of error code"
    }
  ]
}

DELETE Delete Link

Delete link

Delete link

DELETEhttps://api.transactionlink.io/link/{caseId}

Path parameters

caseId*string (uuid)

UUID of the case to delete

Response

204404

Link has been deleted.

Request

JavaScriptCurlPython

const response = await fetch('https://api.transactionlink.io/link/{caseId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

404

{
  "fingerprint": "a123bcd4-a123-1ab2-a123-ab1c2d3efg4h",
  "errors": [
    {
      "code": "ERROR_CODE",
      "message": "description of error code"
    }
  ]
}