Dynamic Form Data on Case Management

Overview

We have introduced a new Dynamic Form Card component to display dynamic form data submitted to the audit portal via the Thomas API.

Prerequisites

• GitHub access.

Purpose & use case

Who is this for?

• SA/IE team
• Support team

When should this be used? When clients want to see the data for a dynamic form on case management.

Step-by-step guide

1. Setting up — integration

Steps to integrate in a workflow:

1. Add an API module in the workflow.
2. Configure the parameters to be displayed.
3. Set Content-Type to multipart/form-data.
4. Send the dynamic form content to the Thomas API endpoint.

Thomas API endpoint:

POST https://ind-thomas.hyperverge.co/v1/dynamic-form-data-sync

Headers

• Content-Type: multipart/form-data
• appId: <appId>
• transactionId: <transactionId>
• moduleId: <moduleId>
• appKey: <appKey>

Form data

• custom-file: File
• key: value

Example:

{
  "name": "example_name",
  "age": "25"
}

cURL example

curl --location 'https://ind-thomas.dev.hyperverge.co/v1/fault' \
  --header 'transactionid: fb2ba67f7c' \
  --header 'moduleid: test-form-module-2' \
  --header 'appkey: 512079c7b96d514750e1' \
  --header 'appId: 55a3a6' \
  --form 'name="abcd"' \
  --form 'age="1234"'

Configuration

Config structure:

{
  "parse": "no",
  "moduleName": "User Form",
  "cardType": "genericCardV2",
  "refreshSupportedS3URLs": "yes",
  "endpoint": "/v1/dynamic-form-data-sync",
  "maxCardHeight": "800px",
  "showDynamicFormResponse": true,
  "blackListedFields": ["photoOfCanditate", "transactionId"],
  "videoExtensionsToRender": ["mp4", "webm"],
  "mediaExtensionsToRender": ["jpg", "jpeg", "png", "pdf", "tiff"]
}

Field filtering

• blackListedFields — fields excluded from display.
  • Hides sensitive or unnecessary info.
  • warning

    Changing this impacts all workflows.

  • Best practice: configure the Thomas API to send only required fields.

Media support

• videoExtensionsToRender — supported video formats (mp4, webm).
• mediaExtensionsToRender — supported media formats (jpg, jpeg, png, pdf, tiff).

warning

Add only formats supported by the portal.

tip

Only files uploaded to the audit portal bucket via this API call are displayed in the media section.

2. How it works

Data processing:

• Form data is received from Thomas API.
• Each field is checked for audit-portal S3 URLs.

Content rendering:

• Text data is rendered in table format.
• Media URLs are rendered by matching the extension against supported lists.

Field filtering:

• Blacklisted fields are automatically excluded.
• Media fields are separated from text fields.

3. Best practices

Data submission:

• Send only necessary fields through the Thomas API.
• Use standard media file formats.

Configuration:

• Use a generic config across all workflows.
• Carefully maintain blackListedFields.
• Verify portal support before adding new media formats.

FAQs

Q: Is dynamic form data stored by default? A: No, it has to be enabled by adding the API call as mentioned above.