Configuring FolderIT Integration

FolderIT is a flexible multi-account architecture Document Management System (DMS) that allows a single set of login credentials to access and manage multiple independent sub-accounts. This is useful for multi-tenant environments needing strict data separation.

Key Features of FolderIT

• Unified Login, Isolated Data: Switch between accounts (e.g. Finance, HR) from a single dashboard. Each account operates as a separate instance with its own API key, storage and audit logs.

• Independent Permissions: Each sub-account maintains unique User Groups and permissions to ensure sensitive documents are visible only to authorized personnel.

• Cross-Account Sharing: Users can selectively share specific folders or files between accounts to facilitate cross-departmental workflows.

Configuring API Credentials

Before setting up OptimiDoc, you must create a set of API credentials within your FolderIT account.

1. Login to your FolderIT account

2. Navigate to the API Credentials Page

3. Click Add Client

Path: Login > Manage Accounts > API

Configure the client using the following values:

After saving, copy the Client ID and Client Secret and store them securely.

Advanced List Folder Destination (Optional)

If you prefer not to manually enter the folder IDs, you can use an Advanced List to fetch all available folders for scan delivery using the FolderIT API.

1. Create another API Client in your FolderIT account

2. Call it: OptimiDoc Advanced List (Folders)

3. Set the Redirect URI & Post Logout Redirect URI to https://eu.optimidoc.cloud/AdvancedLists/OAuthCallback

Copy the Client ID and Client Secret

4. Navigate to your OptimiDoc Tenant > Admin Console > Workflows management > Advanced Lists

5. Create a new Advanced List

6. Configure the list accordingly
   

   

• Name: Anything you’d like

• Type: Online List

• Import Format: JSON

• Import Label Path: name

• Import Value Path: uid

• List Source URL: https://api.folderit.com/v2/accounts/[UID]/entities/all?folders=true

  • Note: Replace [UID] with your FolderIT account ID

• Authentication Type: OAuth 2.0

• Authorization Endpoint URL: https://auth.folderit.com/oauth2/auth

• Token Endpoint URL: https://auth.folderit.com/oauth2/token

• Client ID: Replace with the Client ID you copied previously

• Client Secret: Replace with the Client Secret you copied previously

• Toggle On Is preloaded

Creating the Workflow

Once the API credentials are created, set up the scan workflow within the OptimiDoc portal.

1. Navigate to your OptimiDoc tenant

2. Go to Admin Console > Workflows management

3. Select Document Workflows

4. Click Add Workflow

Path: Admin Console > Workflows management > Document Wortkflows

Configure Workflow: Parameters

Create two parameters as shown below.

Configure Workflow: Output Setting

• In the Filename box, enter the parameter you just created: [fileName]

Scan Destination API

Configure the destination as follows

• Destination Type: API

• Authentication Type: OAuth 2.0

• Authorization Endpoint URL: https://auth.folderit.com/oauth2/auth

• Token Endpoint URL: https://auth.folderit.com/oauth2/token

• Client ID: The Client ID you created previously

• Client Secret: The Client Secret you created previously

Using the Add Request button (as shown below) add two more requests and a proceed to drag and re-arrange the requests in the following order.

• Request 1 → Delivery → Request 2

Configure Request 1 (Initiate Upload)

• Request Method: POST

• Request URL: https://api.folderit.com/v2/accounts/[UID]/files/upload

  • Note: Replace [UID] with your FolderIT account ID

• Request Body Type: JSON

• JSON Body Source: JSON editor

• JSON Body Template & Response Parameters

  JSON

  {
    "action": "create",
    "fileSize": [file_size],
    "fileName": "[fileName]",
    "contentType": "application/pdf",
    "folderUid": "[folderID]",
    "parts": {
      "1": [file_size]
    }
  }
  

Configure Delivery (Transfer Data)

• Request Method: PUT

• Request URL: [upload_url]

• Delivery body type: Raw body

• Name of file form field: file

• Use authentication for request Toggle: Off (If left toggled On the request will error)

Configure Request 2 (Complete Upload

• Request Method: POST

• Request URL: https://api.folderit.com/v2/accounts/[UID]/files/upload

  • Note: Replace [UID] with your FolderIT account ID

• Request Body Type: JSON

• JSON Body Source: JSON editor

• JSON Body Template

  JSON

  {
    "action": "complete",
    "fileSize": [file_size],
    "fileName": "[fileName]",
    "contentType": "application/pdf",
    "folderUid": "[folderID]",
    "uploadId": "[UploadID]",
    "key": "[key]"
  }