Troubleshooting Quik! API Requests with Postman
Overview
Postman is a useful tool for testing Quik! REST API requests outside of your application. Reproducing a request in Postman can help determine whether an issue is caused by the request itself, authentication, configuration, form generation, or a later step in a multi-call workflow.
This guide describes a repeatable troubleshooting process for Quik! API requests.
Important: Do not share passwords, OAuth access tokens, private client data, or other sensitive information in screenshots, examples, or support requests. Replace sensitive values with safe placeholders before sharing them.
Before You Begin
Before reproducing an API request, collect the following information:
|
Item |
Why it matters |
|---|---|
|
Endpoint |
Confirms which Quik! service and operation is being called |
|
HTTP method |
Confirms whether the request is using GET, POST, PUT, DELETE, or another supported method |
|
Request body |
Allows the exact request structure and values to be reviewed |
|
Response body |
Often contains the most useful error or validation details |
|
HTTP status code |
Helps identify authentication, authorization, validation, or server-side failures |
|
Environment |
Confirms whether the request is targeting production or a test environment |
|
Timestamp and time zone |
Helps correlate the request with other system activity if Support review is needed |
|
Workflow sequence |
Important when more than one API call is involved |
When possible, reproduce the same request that failed in your application rather than creating a simplified request first.
Step 1 - Confirm the Endpoint and HTTP Method
Start by confirming the exact endpoint and method used by your application.
For example, a Quik! Forms Engine HTML generation request uses:
POST /rest/quikformsengine/qfe/execute/html
Use the Quik! API Guide and Swagger documentation for the service you are calling to confirm the current endpoint, request model, and required fields.
Related documentation:
Step 2 - Configure Authentication
Quik! REST APIs use OAuth authentication.
In Postman, add your current OAuth access token as a Bearer token:
Authorization: Bearer <access_token>
If the API returns 401 Unauthorized, generate a new token and retry the request. A 401 response indicates that the token is missing, expired, or invalid.
Security: Never paste an active access token into a support ticket, email, screenshot, or shared document.
REST authentication documentation:
Step 3 - Reproduce the Exact Request
Copy the request body used by your application into Postman.
For JSON requests:
- Select Body.
- Select raw.
- Choose JSON as the content type.
- Paste the request body.
- Confirm that the request includes the same form IDs, field values, recipient settings, and configuration values used when the issue occurred.
Avoid changing multiple values at once. If the original request fails in Postman, you have reproduced the behavior in a controlled environment.
Step 4 - Inspect the Full Response
After sending the request, review all of the following:
- HTTP status code
- response body
- error message or validation details
- response headers, if relevant
- response time
Do not rely only on the HTTP status code. The response body may contain additional information that identifies the specific field or configuration that needs attention.
For a successful Quik! Forms Engine request, the response may include generated output such as HTML, a UNID, form IDs, or optional generated data objects depending on the request properties used.
Step 5 - Compare a Failing Request with a Known-Good Request
If you have a similar request that succeeds, compare the two requests carefully.
Focus first on differences in:
- endpoint and environment
- form IDs
- request properties
- nested object structure
- field names and values
- recipient configuration
- authentication-related values
- optional properties that are present in only one request
Change one variable at a time and resend the request. This makes it easier to identify which difference changes the result.
Step 6 - Identify Which Call Is Failing
Some Quik! workflows use more than one API call. In these cases, identify the exact step where the behavior changes.
For example, Direct to DocuSign uses a two-call flow:
- Generate form and signing data with:
POST /rest/quikformsengine/qfe/execute/html
If Call 1 is successful but Call 2 fails, collect the request and response for both calls. This helps separate form-generation behavior from envelope-creation behavior.
Direct to DocuSign documentation:
Step 7 - Reduce the Request Carefully
After reproducing the issue, you can simplify the request to isolate the cause.
Examples:
- test one form instead of several
- remove optional properties one at a time
- test one recipient instead of several
- remove unrelated prefill fields
- compare the result with and without a specific configuration property
Do not remove values that are required to reproduce the issue. Keep a copy of the original failing request before reducing it.
Common Troubleshooting Pattern
A practical troubleshooting sequence is:
- Confirm the endpoint and environment.
- Confirm authentication.
- Reproduce the exact request.
- Capture the full response.
- Identify the exact API call where the issue occurs.
- Compare against a known-good request if available.
- Change one variable at a time.
- Document the smallest request that still reproduces the issue.
When Contacting Quik! Support
If you are unable to resolve the issue, include the information needed to reproduce it.
At minimum, provide:
- endpoint and HTTP method
- environment
- sanitized request body
- complete response or error message
- HTTP status code
- timestamp and time zone
- reproduction steps
- whether the workflow worked previously
- request and response from each relevant API call in a multi-call workflow
See also:

