Skip to content

docusign/OpenAPI-Specifications

Repository files navigation

alt text

DocuSign OpenAPI Specifications

DocuSign uses the OpenAPI (OAI) Specification - formerly known as "Swagger" - to describe its REST APIs. The goal of the OAI specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service. For more info see the official OAI spec.

The Swagger file

esignature.rest.swagger-v2.1.json - the full swagger file for DocuSign's eSignature REST API v2.1

esignature.rest.swagger-v2.json - the full swagger file for DocuSign's eSignature REST API v2

rooms.rest.swagger-v2.json - the full swagger file for DocuSign's Rooms API v2

click.rest.swagger-v2.json - the full swagger file for DocuSign's Click API v1

admin.rest.swagger-v2.json - the full swagger file for DocuSign's Admin API v2 and v2.1

What can I do with a Swagger file?

We use OpenAPI/Swagger files to build many of our developer tools including our client SDKs using swagger-codegen. We also use the OAI specification to build our API Docs and API Explorer tools. What will you build? Let us know by filing an issue in this repository.

Vendor-specific extensions

Some post-processing is performed on our eSignature Swagger spec which includes adding a number of vendor-specific extensions prefixed with x-ds-. See the DocuSign-Extensions.md file for more information.

Releases

The DocuSign eSignature REST API is updated monthly. The Swagger file in this repository is also updated monthly. See the "Releases" tab for version information. The current release information is available from the Developer Account (demo) and production platforms.

Support

Please log issues through GitHub. We also have an active developer community on Stack Overflow, search the DocuSignAPI tag.

License

The DocuSign OpenAPI (Swagger) Files are licensed under the following License.