API template library

Simulate the DocuSign Click API

A WireMock simulation of DocuSign's REST API — covering elastic templates (clickwraps) and their versions, user agreements, agreement documents and PDFs, the bulk agreement export, and service information.

Vendor
DocuSign
Functionality
Clickwraps, versions, user agreements
Spec version
1.0.0
Endpoints
20
Stubs
57
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 Click API

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

Base URL
https://zmkwde.wiremockapi.cloud

POST Create an elastic template (starts as draft 1.0)

curl -s -X POST 'https://zmkwde.wiremockapi.cloud/clickapi/v1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/clickwraps' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"clickwrapName":"Terms of Sale","displaySettings":{"displayName":"Terms of Sale","consentButtonText":"I agree","format":"modal","mustRead":true,"requireAccept":true,"documentDisplay":"document"},"documents":[{"documentName":"Terms of Sale","fileExtension":"txt","documentBase64":"VGVybXMgb2YgU2FsZQ==","order":0}]}'

GET List elastic templates and their versions

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

GET Get service information

curl -s -X GET 'https://zmkwde.wiremockapi.cloud/clickapi/service_information' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Method Path Summary
GET /clickapi/service_information Get Click API version and information
DELETE /clickapi/v1/accounts/{accountId}/clickwraps Deletes elastic templates for an account.
GET /clickapi/v1/accounts/{accountId}/clickwraps Gets all the elastic templates for a user.
POST /clickapi/v1/accounts/{accountId}/clickwraps Creates an elastic template for an account.
DELETE /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId} Deletes an elastic template and all of its versions.
GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId} Gets a single elastic template object.
PUT /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId} Update properties of an elastic template.
POST /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements Create embeddable agreement URL
GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements/{agreementId} Gets a specific agreement for a specified elastic template.
GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/agreements/{agreementId}/download Gets the completed user agreement PDF.
POST /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/bulk_agreements Export clickwrap agreements for date range
GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/users Get elastic signing agreements.
DELETE /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions Deletes the versions of an elastic template.
GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions Gets all the versions of an elastic template.
POST /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions Creates a new elastic template version.
DELETE /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId} Deletes an elastic template version by version ID.
GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId} Gets a specific version of an elastic template by version ID.
PUT /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId} Update elastic template version by version ID
GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}/documents/{orderOrDisclosure} Downloads a document at an order within the agreement.
GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}/users Get agreement responses for template version

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

What's inside the Click template

Click is DocuSign's clickwrap product, the "I agree" checkbox on a sign-up or checkout page, now branded elastic templates. Every account starts empty: you create a template with its documents and display settings, it begins life as version 1.0 in draft, and only an activated version can collect agreements. An agreement request comes back 201 with a one-off agreementUrl and the documents and settings of the active version captured at that moment, which is the record a compliance audit later relies on.

  • Elastic templates — create with documents and display settings, read the latest version, rename, transfer ownership, delete
  • Versions — minor or major versions depending on re-acceptance, activation that retires the previous active version
  • Agreements — per-user agreements with agreed or declined outcomes, repeat-request handling and listing
  • Documents — version documents by order, the consumer disclosure, and agreement PDF downloads
  • Service information — the API version list and build details at /clickapi/service_information

DocuSign Click mock API FAQ

A new elastic template has only its draft 1.0 version, and agreements need an active one. PUT the version with status active (it can be addressed by number, so …/versions/1.0 works) and the same agreement request then returns 201.

The outcome is keyed on clientUserId, since the real choice happens in a browser the API never sees. Ids beginning with decline read back as declined with a declinedOn timestamp; every other id reads back as agreed with agreedOn. The outcome appears on the next GET of the agreement.

They get their existing agreement back, still with a 201 since that's the only status the spec declares, but without an agreementUrl, which is how integrations know not to show the clickwrap again. A new major version created with requireReacceptance resets that.

Not while a version is active: the delete call answers 200 but reports deletionSuccess false with the message that an active version can't be deleted. Deactivate first. Templates you create here are visible to every sandbox visitor, and the token is never checked, so use made-up names and no real credentials.

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