API template library

Simulate the DocuSign Web Forms API

A WireMock simulation of DocuSign's REST API — covering web form configurations with their draft and active versions, and embedded and remote form instances with their tokens, status progression and envelopes.

Vendor
DocuSign
Functionality
Form configurations and instances
Spec version
1.0.0
Endpoints
6
Stubs
36
Protocol
REST
Validation
AI-validated Before publication, an AI agent exercised these endpoints against the real DocuSign API through WireMock's recording proxy, and the recorded traffic was used to verify each stub's request and response shapes.

Live sandbox · no signup, no API key

DocuSign Web Forms API

A running WireMock Cloud instance of this template, callable right now from a terminal, a script, or an AI agent.

Base URL
https://ej7dz9.wiremockapi.cloud

GET List web form configurations

curl -s -X GET 'https://ej7dz9.wiremockapi.cloud/api/webforms/v1.1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/forms' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

GET Read the published version of the Customer Account Application

curl -s -X GET 'https://ej7dz9.wiremockapi.cloud/api/webforms/v1.1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/forms/5a62ae76-3b1c-4d2e-9f80-1a2b3c4d5e01?state=active' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

POST Create an embedded form instance

curl -s -X POST 'https://ej7dz9.wiremockapi.cloud/api/webforms/v1.1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/forms/5a62ae76-3b1c-4d2e-9f80-1a2b3c4d5e01/instances' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"clientUserId":"customer-1042","formValues":{"full_name":"Sam Ortiz"}}'
Method Path Summary
GET /api/webforms/v1.1/accounts/{accountId}/forms Returns a list of web form configurations.
GET /api/webforms/v1.1/accounts/{accountId}/forms/{formId} Retrieves a web form configuration.
GET /api/webforms/v1.1/accounts/{accountId}/forms/{formId}/instances Lists the instances of a given web form configuration.
POST /api/webforms/v1.1/accounts/{accountId}/forms/{formId}/instances Creates a secure web form instance.
GET /api/webforms/v1.1/accounts/{accountId}/forms/{formId}/instances/{instanceId} Gets a web form instance.
POST /api/webforms/v1.1/accounts/{accountId}/forms/{formId}/instances/{instanceId}/refresh Refreshes the instance token.

Unauthenticated WireMock Cloud demo sandbox for DocuSign — not an official DocuSign sandbox, and it returns simulated example data only.

What's inside the Web Forms template

Web Forms turns a DocuSign template into a fill-in page whose answers land in an envelope. Lucky Shrub Sales has four form configurations, chosen so that each creation rule has a form that trips it: a Customer Account Application whose draft version 3 adds a referral_source field the published version 2 lacks, a standalone Garden Design Consultation Request that can't be sent remotely, a Supplier Onboarding Questionnaire that has never been published, and a Volunteer Day Waiver that is published but switched off. Creating an instance returns a formUrl to embed, a short-lived instanceToken and the INITIATED status.

  • Form configurations — list with owner, standalone and published filters, search, sorting and paging; read a draft or active version
  • Embedded instances — created with clientUserId and prefilled formValues, returning formUrl and instanceToken
  • Remote instances — sendOption now with a recipient list, allowed only on forms with sending enabled
  • Instance lifecycle — INITIATED, IN_PROGRESS and SUBMITTED on successive reads, with envelopes and token refresh

DocuSign Web Forms mock API FAQ

It advances one step each time you read it. The first GET after creation shows IN_PROGRESS, the next SUBMITTED with a submittedDateTime, and the template-based Customer Account Application gains an envelope at that point. Polling code therefore sees every transition within two reads.

The disabled Volunteer Day Waiver answers 400 FORM_NOT_ACTIVE. Asking the consultation form for a remote instance with sendOption now answers 400 SENDING_NOT_ALLOWED, because its configuration doesn't allow sending. Recipients without a sendOption are rejected as an invalid request body.

It has never been published, so there is no active version to return and the answer is 404 FORM_NOT_FOUND. Reading it without state returns its draft. The Customer Account Application shows the difference most clearly: its draft includes referral_source and its active version doesn't.

The tokenExpirationDateTime is five minutes out, as DocuSign issues it, but the mock doesn't enforce it, so an older token keeps working. The refresh action issues a new token while the instance is still open; once it is submitted, refresh answers 400 INSTANCE_NOT_ACTIVE. Instances you create are shared with every sandbox visitor; requests with no Bearer header answer 401.

Vendor names identify APIs represented by WireMock template sources. This page does not imply vendor endorsement, certification, partnership, or official integration status.