TransactionLink

https://docs.transactionlink.io
Admin
TransactionLink is a no-code platform that simplifies digital onboarding flows by handling...
Tokens:74,204
Snippets:263
Trust Score:7.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Query Documentation Dynamically

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/records/attachments

To get more information not directly present on the page, perform an HTTP GET request with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.transactionlink.io/docs/transactionlink-api/api-reference/records/attachments.md?ask=<question>
```

--------------------------------

### Query Documentation API

Source: https://docs.transactionlink.io/docs/workflows/quickstarts/run-the-workflow-on-a-transactionlink-hosted-page

This example shows how to query the TransactionLink documentation API using an HTTP GET request with an 'ask' query parameter to retrieve specific information.

```http
GET https://docs.transactionlink.io/docs/workflows/quickstarts/run-the-workflow-on-a-transactionlink-hosted-page.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/workspace-memberships

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. The question should be specific and self-contained.

```http
GET https://docs.transactionlink.io/docs/transactionlink-api/api-reference/workspace-memberships.md?ask=<question>
```

--------------------------------

### Get Record by ID Request Example

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/records

This example demonstrates a GET request to retrieve a record by its ID. Ensure you include the correct record ID in the URL.

```http
GET /v1/records/rec_1234567890abcdef HTTP/1.1
Host: api.transactionlink.io
Authorization: Bearer YOUR_API_KEY
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/enrollments

To get more information not present on the page, make an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.transactionlink.io/docs/transactionlink-api/api-reference/enrollments.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.transactionlink.io/docs/records

Use this method to ask questions about the documentation dynamically. The response includes direct answers and relevant excerpts.

```http
GET https://docs.transactionlink.io/docs/records.md?ask=<question>
```

--------------------------------

### Initiate Workflow with Parameters

Source: https://docs.transactionlink.io/docs/workflows/parameters

This command-line example shows how to send a POST request to initiate a workflow, including a JSON payload with various parameters like userId, transactionId, and countryCode.

```bash
curl -X POST https://api.transactionlink.io/workflows \
  -H "Content-Type: application/json" \
  -d '{ \
        "recordId": "6f1a8b43-0e69-4c27-b123-f715aa6a01ef", \
        "workflowDefinitionId": "9ac5e4b8-fd54-4df2-987d-215acc92ea43", \
        "expiresAt": "2025-12-01T23:59:59Z", \
        "uiMode": "EMBEDDED", \
        "locale": "en-US", \
        "parameters": { \
          "userId": "usr_123456789", \
          "transactionId": "txn_987654321", \
          "countryCode": "US", \
          "clientSegment": "enterprise", \
          "externalRecordReference": "ext_ref_4521abc123" \
        } \
      }'
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference

To get more information not directly present on the page, make an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and in natural language.

```HTTP
GET https://docs.transactionlink.io/docs/transactionlink-api/api-reference.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.transactionlink.io/docs/postman-collection

To get more information not present on this page, make an HTTP GET request to this page's URL with the 'ask' query parameter. The question should be specific and in natural language.

```HTTP
GET https://docs.transactionlink.io/docs/postman-collection.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.transactionlink.io/docs/workflows/quickstarts/run-the-workflow-as-a-background-process

Use this method to ask questions about the documentation. Perform an HTTP GET request on the current page URL with the 'ask' query parameter.

```bash
GET https://docs.transactionlink.io/docs/workflows/quickstarts/run-the-workflow-as-a-background-process.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.transactionlink.io/docs/records/overview

To get information not directly present on a page, make an HTTP GET request to the page URL with an 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.transactionlink.io/docs/records/overview.md?ask=<question>
```

--------------------------------

### Inline Widget Container Setup

Source: https://docs.transactionlink.io/docs/workflows/js-api/inline-mode

Place the widget element inside a container with fixed width and height for optimal rendering in inline mode.

```haml
<div class="widget-wrapper">
    <div id="transactionlink-widget" />
</div>
```

--------------------------------

### Dynamic Documentation Query

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/organization

Send an HTTP GET request to the current page URL with the 'ask' query parameter to ask a question about the documentation. The question should be specific and self-contained. The response will include a direct answer and relevant excerpts.

```http
GET https://docs.transactionlink.io/docs/transactionlink-api/api-reference/organization.md?ask=<question>
```

--------------------------------

### Initialize and Launch Transactionlink Widget (Vanilla JS)

Source: https://docs.transactionlink.io/docs/workflows/quickstarts/run-the-workflow-inside-your-application

Appends the widget script to the page and defines the `window.transactionlink_ready` callback. This callback is executed when the script is ready, allowing you to set options and open the widget. Includes a button to trigger the widget launch.

```html
<script>
async function launchWidget() {
    const { workflowId, token } = await createWorkflowExecution();

    window.transactionlink_ready = () => {
        transactionlink.setOptions({ token });
        transactionlink.open();
    };

    const script = document.createElement('script');
    script.src = 'https://widget.transactionlink.io/transactionlink-widget.umd.js';
    document.head.appendChild(script);
}

document.getElementById('launch-widget')
    .addEventListener('click', launchWidget);
</script>

<!-- Button to trigger the widget -->
<button id="launch-widget">Launch Embedded Widget</button>

<transactionlink-widget />
```

--------------------------------

### Get Public Key for Webhooks

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/authentication

This snippet shows how to retrieve the public key used for webhook verification. It specifies the HTTP method and the path for the GET request.

```http
GET https://docs.transactionlink.io/docs/transactionlink-api/api-reference/authentication.md?ask=<question>
```

--------------------------------

### Dynamic Documentation Query

Source: https://docs.transactionlink.io/docs/workflows/quickstarts/run-the-workflow-inside-your-application

Use this method to ask specific questions about the documentation. The response includes direct answers and relevant excerpts.

```bash
GET https://docs.transactionlink.io/docs/workflows/quickstarts/run-the-workflow-inside-your-application.md?ask=<question>
```

--------------------------------

### Querying API Documentation

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference

To get additional information not directly available on the page, perform an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific, self-contained, and in natural language.

```APIDOC
## Querying This Documentation

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.transactionlink.io/docs/transactionlink-api/api-reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
```

--------------------------------

### GET Public key

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/authentication

Retrieves the public key associated with a given key ID.

```APIDOC
## GET Public key

### Description
Retrieves the public key for a given key ID.

### Method
GET

### Endpoint
/auth/webhooks/key/{keyId}

### Parameters
#### Path Parameters
- **keyId** (string) - Required - The ID of the public key to retrieve.
```

--------------------------------

### Get link of a specific attachment

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/records/attachments

Retrieves a pre-signed URL for downloading a specific attachment. This operation requires the `can_read_attachments` permission on the table.

```APIDOC
## GET /tables/{tableId}/records/{recordId}/attachments/{attachmentId}

### Description
Get link of a specific attachment. Requires `can_read_attachments` permission on the table.

### Method
GET

### Endpoint
/tables/{tableId}/records/{recordId}/attachments/{attachmentId}

### Parameters
#### Path Parameters
- **tableId** (string) - Required - Table identifier
- **recordId** (string) - Required - Record identifier
- **attachmentId** (string) - Required - Attachment identifier

#### Header Parameters
- **Authorization** (string) - Required - Organization token (`tot_`) — preferred method, or legacy Bearer JWT token. Pass the `tot_` token directly without Bearer prefix; use `Bearer <jwt>` for legacy JWT auth.

### Response
#### Success Response (200)
- **link** (string) - Pre-signed URL to download the attachment

#### Response Example
```json
{
  "link": "https://example.com/path/to/your/attachment.pdf?signature=..."
}
```

#### Error Responses
- **400** Bad Request – invalid request parameters
- **401** Unauthorized – JWT token missing or invalid
- **403** Forbidden – insufficient permissions
- **404** Not Found – resource does not exist
- **500** Internal Server Error – unexpected server error
```

--------------------------------

### Get a record by ID

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/records

Retrieves a specific record from a table using its unique ID. This operation requires the `can_read_data` permission on the target table.

```APIDOC
## GET /tables/{tableId}/records/{id}

### Description
Get a record by ID. Requires `can_read_data` permission on the table.

### Method
GET

### Endpoint
/tables/{tableId}/records/{id}

### Parameters
#### Path Parameters
- **tableId** (string) - Required - Identifier of the table containing the record
- **id** (string) - Required - Identifier of the record to retrieve

#### Header Parameters
- **Content-Type** (string) - Required - Content type of the response
- **Authorization** (string) - Required - Organization token (`tot_`) — preferred method, or legacy Bearer JWT token. Pass the `tot_` token directly without Bearer prefix; use `Bearer <jwt>` for legacy JWT auth.

### Response
#### Success Response (200)
- **Content-Type** (string) - Content type of the response
- **body** (RecordDetailsResponse) - Details of the retrieved record

#### Error Response (400)
- **body** (ErrorResponse) - Bad Request – invalid request parameters
```

--------------------------------

### Get User Details

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/users

Retrieves details for a specific user by their ID. This operation requires the `can_manage_users` permission and uses an organization API token for authentication.

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "TransactionLink API",
    "version": "v3"
  },
  "servers": [
    {
      "url": "https://api.transactionlink.io",
      "description": "Production"
    }
  ],
  "security": [
    {
      "organizationToken": []
    }
  ],
  "components": {
    "securitySchemes": {
      "organizationToken": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix."
      }
    },
    "schemas": {
      "UserResponse": {
        "title": "UserResponse",
        "required": [
          "id",
          "email",
          "roleId",
          "profile",
          "createdDateTime"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Unique identifier of the user"
          },
          "email": {
            "type": "string",
            "description": "Email address of the user"
          },
          "idpId": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "Identifier in the identity provider (Cognito)"
          },
          "roleId": {
            "type": "string",
            "format": "uuid",
            "description": "Identifier of the organization role"
          },
          "profile": {
            "$ref": "#/components/schemas/UserProfileResponse",
            "description": "Profile details of the user"
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the user was created"
          }
        }
      },
      "UserProfileResponse": {
        "title": "UserProfileResponse",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Unique identifier of the profile"
          },
          "firstName": {
            "type": "string",
            "nullable": true,
            "description": "First name"
          },
          "lastName": {
            "type": "string",
            "nullable": true,
            "description": "Last name"
          },
          "title": {
            "type": "string",
            "nullable": true,
            "description": "Job title"
          },
          "organizationId": {
            "type": "string",
            "format": "uuid",
            "description": "Identifier of the organization"
          },
          "roleId": {
            "type": "string",
            "format": "uuid",
            "description": "Identifier of the organization role"
          },
          "status": {
            "type": "string",
            "description": "Current status of the user",
            "enum": [
              "ACTIVE",
              "INACTIVE",
              "TERMINATED",
              "FORGOTTEN",
              "REMOVED"
            ]
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the profile was created"
          },
          "lastSignedInAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Timestamp of last sign-in"
          }
        }
      },
      "ErrorResponse": {
        "required": [
          "errors",
          "fingerprint"
        ],
        "type": "object",
        "properties": {
          "fingerprint": {
            "type": "string",
            "description": "Unique identifier for this error instance"
          },
          "errors": {
            "type": "array",
            "description": "List of error details",
            "items": {
              "required": [
                "code",
                "message"
              ],
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Error code representing the type of error"
                },
                "message": {
                  "type": "string",
                  "description": "Error message providing more details about the error"
                }
              }
            }
          }
        }
      }
    }
  },
  "paths": {
    "/organizations/users/{userId}": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Get user details",
        "description": "Returns details of a single user in the organization. Requires `can_manage_users` permission.",
        "operationId": "view-user",
        "parameters": [
          {
            "name": "userId",
            "in": "path",
            "description": "Identifier of the user",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "Organization token (`tot_`). Pass the token directly without Bearer prefix.",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "headers": {
              "Content-Type": {
                "description": "Content type of the response",
                "style": "simple",
                "explode": false,
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json;charset=UTF-8": {
                "schema": {
                  "$ref": "#/components/schemas/UserResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request – invalid request parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized – JWT token missing or invalid",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden – insufficient permissions",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found – resource does not exist",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error – unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Get a record by ID

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/records

Retrieves a specific record by its unique identifier. This endpoint is useful for fetching detailed information about a single record when its ID is known.

```APIDOC
## GET /records/{id}

### Description
Retrieves a specific record by its unique identifier.

### Method
GET

### Endpoint
/records/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the record to retrieve.

### Response
#### Success Response (200)
- **record** (object) - The retrieved record object.

#### Response Example
```json
{
  "record": {
    "id": "string",
    "field1": "value1",
    "field2": "value2"
  }
}
```

#### Error Responses
- **401** (Unauthorized) - JWT token missing or invalid.
- **403** (Forbidden) - Insufficient permissions.
- **404** (Not Found) - Resource does not exist.
- **500** (Internal Server Error) - Unexpected server error.
```

--------------------------------

### Show TransactionLinks Widget

Source: https://docs.transactionlink.io/docs/workflows/js-api/methods

Use the `open()` method to make the TransactionLinks widget visible.

```javascript
window.transactionlink.open();
```

--------------------------------

### Create New Resource

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/resources

Use this endpoint to upload a new file and create a resource. Ensure you have the necessary `can_view_workspace` permission. The request requires a `multipart/form-data` content type with the file included.

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "TransactionLink API",
    "version": "v3"
  },
  "servers": [
    {
      "url": "https://api.transactionlink.io",
      "description": "Production"
    }
  ],
  "security": [
    {
      "organizationToken": []
    },
    {
      "bearerAuthJWT": []
    }
  ],
  "components": {
    "securitySchemes": {
      "organizationToken": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix."
      },
      "bearerAuthJWT": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Legacy JWT Bearer token — deprecated in favor of organization tokens (tot_). Still supported for backwards compatibility."
      }
    },
    "schemas": {
      "CreateResourceResponse": {
        "title": "CreateResourceResponse",
        "required": [
          "resourceId",
          "resourceName",
          "resourcePath"
        ],
        "type": "object",
        "properties": {
          "resourceId": {
            "type": "string",
            "description": "Unique identifier of the created resource"
          },
          "resourcePath": {
            "type": "string",
            "description": "Path to access the created resource"
          },
          "resourceName": {
            "type": "string",
            "description": "Name of the created resource"
          }
        }
      },
      "ErrorResponse": {
        "required": [
          "errors",
          "fingerprint"
        ],
        "type": "object",
        "properties": {
          "fingerprint": {
            "type": "string",
            "description": "Unique identifier for this error instance"
          },
          "errors": {
            "type": "array",
            "description": "List of error details",
            "items": {
              "required": [
                "code",
                "message"
              ],
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Error code representing the type of error"
                },
                "message": {
                  "type": "string",
                  "description": "Error message providing more details about the error"
                }
              }
            }
          }
        }
      }
    }
  },
  "paths": {
    "/resources": {
      "post": {
        "tags": [
          "Resources"
        ],
        "summary": "Create a new resource",
        "description": "Create a new resource. Requires `can_view_workspace` permission on the workspace.",
        "operationId": "create-resource",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Organization token (`tot_`) — preferred method, or legacy Bearer JWT token. Pass the `tot_` token directly without Bearer prefix; use `Bearer <jwt>` for legacy JWT auth.",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Content-Type",
            "in": "header",
            "description": "Content type of the request - multipart/form-data",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Upload file request",
          "content": {
            "multipart/form-data": {
              "schema": {
                "required": [
                  "file"
                ],
                "type": "object",
                "properties": {
                  "file": {
                    "description": "The file to upload",
                    "format": "binary"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "201",
            "headers": {
              "Content-Type": {
                "description": "Content type of the response - application/json",
                "style": "simple",
                "explode": false,
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json;charset=UTF-8": {
                "schema": {
                  "$ref": "#/components/schemas/CreateResourceResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request – invalid request parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized – JWT token missing or invalid",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden – insufficient permissions",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found – resource does not exist",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error – unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Set Widget Options

Source: https://docs.transactionlink.io/docs/workflows/js-api/methods

Configure widget behavior by setting options, such as the authentication token.

```javascript
window.transactionlink.setOptions({
  token: 'exampleToken'
});
```

--------------------------------

### Get User Details

Source: https://docs.transactionlink.io/docs/transactionlink-api/api-reference/users

Retrieves the details of a specific user identified by their unique ID. This operation requires the `can_manage_users` permission and is authenticated using an organization token.

```APIDOC
## GET /organizations/users/{userId}

### Description
Returns details of a single user in the organization. Requires `can_manage_users` permission.

### Method
GET

### Endpoint
/organizations/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - Identifier of the user

#### Headers
- **Authorization** (string) - Required - Organization token (`tot_`). Pass the token directly without Bearer prefix.

### Responses
#### Success Response (200)
- **id** (string) - Unique identifier of the user
- **email** (string) - Email address of the user
- **idpId** (string) - Identifier in the identity provider (Cognito)
- **roleId** (string) - Identifier of the organization role
- **profile** (object) - Profile details of the user
- **createdDateTime** (string) - Timestamp when the user was created

#### Response Example (200)
```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "user@example.com",
  "idpId": "123e4567-e89b-12d3-a456-426614174001",
  "roleId": "123e4567-e89b-12d3-a456-426614174002",
  "profile": {
    "id": "123e4567-e89b-12d3-a456-426614174003",
    "firstName": "John",
    "lastName": "Doe",
    "title": "Software Engineer",
    "organizationId": "123e4567-e89b-12d3-a456-426614174004",
    "roleId": "123e4567-e89b-12d3-a456-426614174005",
    "status": "ACTIVE",
    "createdDateTime": "2023-10-27T10:00:00Z",
    "lastSignedInAt": "2023-10-27T12:00:00Z"
  },
  "createdDateTime": "2023-10-27T09:00:00Z"
}
```

#### Error Responses
- **400** Bad Request – invalid request parameters
- **401** Unauthorized – JWT token missing or invalid
- **403** Forbidden – insufficient permissions
- **404** Not Found – resource does not exist
- **500** Internal Server Error – unexpected server error
```
Tokens:
Raw