API Overview

SignatureAPI API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and methods.

​

Base URL

The base URL is https://api.signatureapi.com for both test and live modes.

For example, to create an envelope, you do a POST request to https://api.signatureapi.com/v1/envelopes.

​

Concepts

An envelope is a container that holds documents to be sent to recipients. It organizes and manages the signing process for those documents.

When all recipients have completed an envelope, a deliverable containing the signed documents and an audit log is sent to the recipients.

​

HTTP Semantics

We use HTTP methods GET, POST, DELETE as defined in RFC 9110, and PATCH as defined in RFC 5789.

We use the following HTTP Status codes for successful responses:

• 200 OK: Request succeeded for a GET, POST, or PATCH call.
• 201 Created: Request succeeded for a POST request that created a new resource. The response includes a Location header pointing to the newly created resource.

​

Versioning

The current version of the API is 1. We will increment the version number if we make a change that breaks backward compatibility.

These are not breaking changes:

• Any additive change, such as adding endpoints, optional arguments, or enum values.
• Making a required request parameter optional.
• Making a validation less restrictive.
• Changes to error responses.
• Changes to the order of fields returned in a response.
• Changes to the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings.
• Adding new event types.