Troubleshooting a Direct to DocuSign API Workflow
Compare each stage of the request sequence to identify where the generated form, recipient, field, or envelope behavior first changes.
Confirm the workflow first
Using DocuSign or calling
execute/htmldoes not automatically mean you are using Direct to DocuSign. This guide applies when Quik! creates or sends the DocuSign envelope through the API.
How to identify a Direct to DocuSign workflow
A Direct to DocuSign workflow commonly includes the following sequence:
- Call
POST /rest/QuikFormsEngine/qfe/execute/html. - Receive generated form output and
SignDatafrom Quik!. - Use the generated
SignDatain a request to/rest/esignature/docusign/envelope/sign. - Quik! creates or sends the DocuSign envelope.
If your application creates the DocuSign envelope independently after generating the form, the issue may belong to a different workflow and should be investigated accordingly.
Find where the behavior first appears
|
Checkpoint |
Questions to answer |
|---|---|
|
Original |
Were the expected properties, form fields, recipients, and e-sign settings included? |
|
|
Did Quik! return the expected form output, identifiers, and |
|
Generated |
Do field tabs, recipient values, locking, sharing, and send types match the intended configuration? |
|
Envelope-sign request and response |
Was the generated data passed through without being changed or omitted? Did the endpoint return an error? |
|
Created DocuSign envelope |
Do the final recipients, document visibility, fields, routing order, and authentication settings match the request? |
Common troubleshooting patterns
Fields appear flattened or are not editable
- Confirm your request enables the intended editable-field behavior.
- Review the
execute/htmlresponse andSignDatato confirm expected field tabs were generated. - Determine whether the fields are already flattened before the envelope-sign request is sent.
Recipients can edit fields that should be read-only
- Review the values used for
FillableFieldSharingandLockRecipientFields. - Inspect the generated
SignDatavalues forSharedandLockedon the affected tabs. - If the generated tab is already unlocked, the behavior began before DocuSign created the envelope.
- Remember that the sender may still be able to edit fields in DocuSign Draft or Correct mode.
An expected extra recipient or carbon copy is missing
- Confirm
ExtraRecipientswas included in theexecute/htmlrequest. - Check whether the recipient appears in the
execute/htmlresponse and generatedSignData. - Confirm the recipient was carried into the envelope-sign request.
- Review recipient order, send type, exclusions, and linked-account configuration when applicable.
Values are correct in one output but wrong in the envelope
- Compare the HTML preview, generated PDF or print output,
SignData, and final DocuSign envelope. - Record the first stage where the value becomes missing, changed, selected, unselected, locked, or editable.
- Use the exact Quik! field name and generated DocuSign tab name in the issue report.
Information to provide to Quik! Support
- Customer ID and environment
- Full sanitized
execute/htmlrequest and response - Generated
SignData - Full sanitized envelope-sign request and response
- DocuSign envelope ID
- Timestamp and time zone
- Affected Form IDs, roles, field names, and recipient order
- Expected and actual behavior
- Screenshots showing the final DocuSign behavior
- Confirmation of whether the workflow previously worked
Security and testing notes
Sanitize before sharing
Remove passwords, tokens, client secrets, access codes, and personal information from requests, responses, screenshots, and Postman collections.
- Use a demo or UAT DocuSign environment whenever possible.
- Avoid creating production envelopes solely for troubleshooting unless the test is approved.
- Do not change generated
SignDatabefore sending it when you are trying to identify whether Quik! generated the unexpected value.

