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

Parameters

Parameters API enables you to send custom inputs to the workflow

PreviousResourcesNextToken

Last updated 3 months ago

Was this helpful?

POST Create Parameters

GET Parameters

Get parameters

get

Get a set of parameters for given workflow definition to use

Path parameters
parametersIdstring ยท uuidRequired

UUID of the parameters set to get

Responses
201
Set of parameters for given workflow was created successfully
application/json
400
Bad request body
application/json
404
Not Found request body
application/json
get
GET /parameters/{parametersId} HTTP/1.1
Host: api.transactionlink.io
Accept: */*
{
  "workflowDefinitionId": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
  "parametersId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "parameters": {
    "param1": "value1",
    "param2": true,
    "param3": "text"
  }
}
  • POST Create Parameters
  • POSTCreate parameters
  • GET Parameters
  • GETGet parameters

Create parameters

post

Create a set of parameters for given workflow definition to use

Body
workflowDefinitionIdstringRequired

Id of the workflow definition

Example: 3b2d8a4f-579f-4e2e-a51c-f859e532fe8c
parametersanyRequiredExample: {"param0":0,"param1":1.2222,"param2":true,"param3":"text"}
Responses
201
Set of parameters for given workflow was created successfully
application/json
400
Bad Request Body
application/json
404
Not Found request body
application/json
post
POST /parameters HTTP/1.1
Host: api.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
  "parameters": {
    "param0": 0,
    "param1": 1.2222,
    "param2": true,
    "param3": "text"
  }
}
{
  "workflowDefinitionId": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
  "parametersId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "parameters": {
    "param1": "value1",
    "param2": true,
    "param3": "text"
  }
}