How to Validate Form Generation Before E-Signing

How to Validate Form Generation Before E-Signing

 

Overview

When an e-signature workflow produces an unexpected result, first determine whether the issue is present in the generated form data or only appears later when the e-signature envelope is created.

Validating the form-generation step first can help isolate the problem and avoid troubleshooting multiple systems at the same time.

This guide describes a practical validation sequence for Quik! Forms Engine workflows.


Why Validate Before E-Signing?

A typical e-signature workflow can involve several stages:

  1. Quik! receives form IDs, prefill data, recipient settings, and other configuration.
  2. Quik! Forms Engine generates the form output.
  3. Signing data is generated for e-signature fields and recipients.
  4. An e-signature envelope is created.
  5. The e-signature provider displays the final documents and signing fields.

If you identify the first stage where the output becomes incorrect, troubleshooting becomes much more focused.


Step 1 - Reproduce the Form Generation Request

Reproduce the same request that is used by your application.

For HTML generation:

POST /rest/quikformsengine/qfe/execute/html

Use the same:

  • form IDs
  • prefill fields
  • recipient settings
  • e-signature configuration
  • environment
  • optional generation properties

When troubleshooting, avoid changing values until you have reproduced the original behavior.


Step 2 - Confirm the Request Succeeded

Review:

  • HTTP status code
  • Quik! error code and message, when present
  • returned form IDs
  • generated output

A successful API call confirms that the request was processed, but you should still verify that the generated content matches your expectations.


Step 3 - Inspect the Generated Form Output

Confirm that the generated form contains the expected:

  • forms
  • prefilled values
  • checkbox/radio selections
  • names and contact information
  • form instances
  • calculated or mapped values relevant to the workflow

If the generated form is already incorrect, focus troubleshooting on the execute/html request, form configuration, or prefill data before moving on to the e-signature request.


Step 4 - Generate PrintData and SignData When Needed

For workflows that require deeper validation, request generated data by including:

{
  "GeneratePrintData": true,
  "GenerateSignData": true
}

This allows you to inspect the document-generation data and the e-signature mapping data separately.

PrintData

Use PrintData to verify the structured form data and rendering information being generated.

SignData

Use SignData to verify recipient mappings and signing-field/tab information before the envelope is created.

Related guide:

Direct To Docusign Model


Step 5 - Compare the Form Output with SignData

A useful comparison is:

Observation

Where to investigate first

Form value is wrong and SignData is also wrong

Form-generation request, prefill data, or form configuration

Form value is correct but SignData is wrong

SignData generation or e-signature mapping

Form output and SignData are correct, but envelope is wrong

Envelope request or downstream e-signature behavior

Call 1 fails before data is generated

Request structure, authentication, configuration, or endpoint validation

Call 1 succeeds and Call 2 fails

Envelope request, authorization, required envelope settings, or downstream e-signature configuration

This comparison identifies the earliest point where the actual result differs from the expected result.


Step 6 - Validate Recipient Data Separately

If the issue involves recipients, confirm:

  • expected roles are present
  • recipient names and email addresses are populated as expected
  • signing order is correct
  • send type is correct
  • authentication settings are correct
  • extra recipients are configured as intended
  • document visibility settings are configured separately when documents need to be excluded

Recipient documentation:

How to Configure Recipient Settings

Document visibility documentation:

Configuring Document Visibility


Step 7 - Validate the Envelope Request

If form generation and signing data are correct, move to the request that creates the e-signature envelope.

For Direct to DocuSign, verify that:

  • the correct PrintData is being passed
  • the correct SignData is being passed
  • signSettings is present
  • packagesData contains the expected package or packages
  • the customer/account context is correct
  • the expected environment is used

The Direct to DocuSign guide contains the current two-call flow and envelope request structure:

Direct to DocuSign Model


Step 8 - Use a Minimal Reproduction if Needed

If the request is large, create a smaller reproduction only after saving the full failing request.

Examples:

  • one form instead of multiple forms
  • one recipient instead of multiple recipients
  • only the fields required to reproduce the problem
  • one optional property at a time

The goal is to identify the smallest request that still shows the same behavior.


Example Troubleshooting Sequence

Suppose a checkbox appears selected on the generated form but is not selected in the e-signature envelope.

A useful sequence is:

  1. Confirm the submitted field value in the original request.
  2. Confirm the checkbox is selected in the generated form output.
  3. Inspect the related checkbox or radio information in SignData.
  4. If SignData is already incorrect, stop there and troubleshoot the generation step.
  5. If SignData is correct, inspect the envelope request and final envelope behavior.

This approach avoids treating the entire workflow as one undifferentiated problem.


When Contacting Quik! Support

Provide:

  • original sanitized execute/html request
  • complete execute/html response
  • generated output showing the expected or unexpected result
  • PrintData and SignData when relevant
  • downstream envelope request and response when relevant
  • exact step where the expected and actual results first differ
  • timestamp and time zone

Do not include OAuth tokens, passwords, or sensitive client information.