What to Include When Reporting a Quik! API Issue

What to Include When Reporting a Quik! API Issue

 

Overview

Providing complete reproduction details when reporting an API issue helps Quik! Support understand the workflow and investigate the behavior more efficiently.

This page lists the information that is most useful when submitting an API-related support request.

Important: Remove passwords, OAuth tokens, private keys, and sensitive client information before sending request or response examples.


Minimum Information to Include

Please include the following whenever possible:

Information

Example

API endpoint

POST /rest/quikformsengine/qfe/execute/html

Environment

Production or test/demo environment

HTTP status code

400, 401, 403, 500, or successful response

Request body

Sanitized JSON used when the issue occurred

Response body

Complete response or error message

Timestamp

Include date, time, and time zone

Reproduction steps

Exact sequence required to reproduce the behavior

Expected result

What you expected the API to return or create

Actual result

What happened instead

Previous behavior

Whether the same workflow previously worked


Include the Exact Request That Produced the Issue

Whenever possible, send the same request body that produced the issue.

Avoid recreating the request from memory. Small differences in field names, values, nested objects, or optional properties can change API behavior.

Before sharing the request:

  • remove OAuth tokens
  • remove passwords and secrets
  • replace personal information with safe example values when the exact value is not needed to reproduce the issue
  • preserve the request structure and relevant configuration values

Include the Complete Response

Include the full response rather than only the first line of the error.

Useful response information includes:

  • HTTP status code
  • response body
  • Quik! error code, when present
  • message text
  • validation details

If the request succeeds but produces the wrong output, include the successful response as well.


Include the Endpoint and Environment

Always identify which API operation was called.

For example:

POST /rest/quikformsengine/qfe/execute/html

Also identify the environment used for the request.

This is especially important for e-signature workflows because the Quik! environment and the e-signature environment must be understood when reproducing the issue.


Include a Timestamp and Time Zone

Provide the approximate time the request was made.

Example:

2026-08-07 10:42 AM Central Time

A timestamp is most useful when it includes:

  • date
  • local time
  • time zone

If the request was repeated several times, provide the timestamp for a specific example that produced the issue.


Describe the Expected and Actual Results

Use a simple comparison.

Expected

Form 123 should generate with the account type radio button selected.

Actual

The generated form is correct, but the radio button is not selected in the DocuSign envelope.

This makes it clear whether the issue involves:

  • request validation
  • form generation
  • field mapping
  • recipient configuration
  • e-signature data
  • envelope creation
  • final e-signature behavior

For Multi-Call Workflows, Include Every Relevant Call

Some workflows require multiple API requests.

For Direct to DocuSign, troubleshooting may require both:

  1. the execute/html request and response that generates PrintData and SignData
  2. the DocuSign envelope request and response that uses the generated data

If only the second call is provided, it may not be possible to determine whether the unexpected value originated during form generation or envelope creation.

Direct to DocuSign documentation:

Direct to DocuSign Model


For Form or Field Issues

Include:

  • form ID or IDs
  • field name or names involved
  • submitted field value
  • expected generated value
  • actual generated value
  • whether the issue is visible in the generated form, SignData, or only in the final e-signature envelope

If the issue involves repeated forms or form instances, identify which instance is affected.


For Recipient or E-Signature Issues

Include:

  • recipient role
  • send type
  • signing order
  • authentication type, when relevant
  • whether the recipient is a signer or extra recipient
  • document visibility settings, when relevant
  • e-signature environment
  • whether the envelope is created as a draft or sent immediately, when relevant

Do not send personal contact information unless it is required to reproduce the issue. Safe placeholder values are preferred whenever possible.


For Authentication Issues

If the API returns 401 Unauthorized:

  • do not send your token to Support
  • generate a new token
  • confirm the Bearer token is included in the request
  • confirm whether the new token changes the result

Authentication documentation:

REST Authentication


Helpful Reproduction Format

You can use the following format when opening a support request:

Endpoint: Environment: Timestamp and time zone: HTTP status: Expected result: Actual result: Steps to reproduce: 1. 2. 3. Sanitized request: Sanitized response: Additional workflow calls, if applicable:


What Not to Send

Do not include:

  • OAuth access tokens
  • passwords
  • private keys
  • credentials
  • unnecessary client personal information
  • screenshots containing secrets

If you are unsure whether a value is sensitive, replace it with a placeholder and describe what type of value it represents.


REST APIs (Preferred Method)

REST Authentication

Direct to DocuSign Model

How to Configure Recipient Settings