DocuSign

DocuSign Click API

DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.

Endpoints 21

ClickWraps

  • GETGets the current version and other information about the Click API./service_informationThe response includes information about the version of the Click API. { "serviceVersions": [ { "version": "v1", "versionUrl":…
  • GETGets all the clickwraps for an account./v1/accounts/:accountId/clickwraps?from_date=string&ownerUserId=string&page_number=string&shared=string&status=string&to_date=stringGets all the clickwraps for an account.
  • POSTCreates a clickwrap for an account./v1/accounts/:accountId/clickwrapsCreates a clickwrap for an account and returns the response with created agreement.
  • DELETEDeletes clickwraps for an account./v1/accounts/:accountId/clickwraps?clickwrapIds=stringDeletes all clickwraps for an account or only the ones specified in the clickwrapIds query parameter.
  • GETGets a single clickwrap object./v1/accounts/:accountId/clickwraps/:clickwrapIdGets a single clickwrap object.
  • PUTUpdates the user ID of a clickwrap./v1/accounts/:accountId/clickwraps/:clickwrapIdUpdates the user ID of a clickwrap. You specify the old and the new user ID in the request body.
  • DELETEDeletes a clickwrap and all of its versions./v1/accounts/:accountId/clickwraps/:clickwrapId?versions=stringDeletes the clickwrap specified by clickwrapId and all of its versions. Active clickwraps are not deleted
  • POSTChecks if a user has agreed to a clickwrap./v1/accounts/:accountId/clickwraps/:clickwrapId/agreementsChecks if a user has agreed to a clickwrap and returns a response with the agreement URL. Returns HTTP status code OK if the user has no pending agreement.
  • GETGets a specific agreement for a specified clickwrap./v1/accounts/:accountId/clickwraps/:clickwrapId/agreements/:agreementIdGets the agreement specified by agreementId. You can omit agreementId to get the latest agreement.
  • GETGets the completed user agreement PDF./v1/accounts/:accountId/clickwraps/:clickwrapId/agreements/:agreementId/downloadGets the PDF of agreementId for the clickwrap specified by ciickwrapId. The response to this method is the bytes of the PDF file. The response includes the…
  • GETGet user agreements/v1/accounts/:accountId/clickwraps/:clickwrapId/users?client_user_id=string&from_date=string&page_number=string&status=string&to_date=stringGet user agreements
  • POSTCreates a new clickwrap version./v1/accounts/:accountId/clickwraps/:clickwrapId/versionsCreates a new clickwrap version.
  • DELETEDeletes the versions of a clickwrap./v1/accounts/:accountId/clickwraps/:clickwrapId/versions?clickwrapVersionIds=stringDeletes all versions of a clickwrap, or only the ones specified in the clickwrapVersionIds query parameter.
  • GETGets a specific version from a clickwrap./v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionIdGets the version specified by versionId from the clickwrap clickwrapId.
  • PUTUpdates a specific version of a clickwrap./v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionIdUpdates the clickwrap version versionId of the clickwrap clickwrapId.
  • DELETEDeletes a specific version of a clickwrap./v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionIdDeletes the clickwrap version versionId of the clickwrap clickwrapId.
  • GETGets the agreement responses for a clickwrap version./v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionId/users?client_user_id=string&from_date=string&page_number=string&status=string&to_date=stringGets the agreement responses for a specific version.
  • GETGets a clickwrap version by specifying its version number./v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionNumberGets the clickwrap version specified by versionNumber from the clickwrap clickwrapId.
  • PUTUpdates a clickwrap version by specifying its version number./v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionNumberUpdates the clickwrap version specified by versionNumber of the clickwrap clickwrapId.
  • DELETEDeletes a clickwrap version from a clickwrap by specifying its version number./v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionNumberDeletes the clickwrap version specified by versionNumber from the clickwrap clickwrapId.
  • GETGets the agreement responses for a clickwrap version/v1/accounts/:accountId/clickwraps/:clickwrapId/versions/:versionNumber/users?client_user_id=string&from_date=string&page_number=string&status=string&to_date=stringGets the agreement responses for a clickwrap version

API details

Base URL
https://www.demo.docusign.net/clickapi
Authentication
None declared in the description
Operations
21 operations on 12 pathsGET 10DELETE 5PUT 3POST 3
Main resources
ClickWraps 21
Response formats
application/json
Description format
Swagger 2.0, API version v1

How to test the DocuSign Click API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the DocuSign Click API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Gets the current version and other information about the Click API.” (GET /service_information), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the DocuSign Click API?

DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy… It is listed under Other and has 21 endpoints.

Who publishes the DocuSign Click API?

It is listed from DocuSign's public API description (an OpenAPI document), not published by DocuSign on Swastik Codes. Anyone who controls docusign.com can claim the profile by adding a DNS TXT record.

What is the base URL of the DocuSign Click API?

Requests go to https://www.demo.docusign.net/clickapi. Endpoint paths are added to this base URL.

How do I authenticate with the DocuSign Click API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the DocuSign Click API have?

21 operations on 12 paths (10 GET, 5 DELETE, 3 PUT, 3 POST). The largest groups are ClickWraps.

Is forking the DocuSign Click API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.