Docusign Envelopes API
Create, send, and manage envelopes. An envelope is the fundamental unit of a DocuSign transaction, containing the documents to be signed, the recipients who will sign them, and the workflow rules.
Docusign Envelopes API is one of 134 APIs that Docusign publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Envelopes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, a getting-started guide, rate-limit docs, and 1 JSON Schema.
This API exposes 21 operations across 13 paths, and defines 156 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 5 base URLs: https://demo.docusign.net/restapi/v2.1, https://www.docusign.net/restapi/v2.1, https://eu.docusign.net/restapi/v2.1, https://au.docusign.net/restapi/v2.1, https://www.docusign.net/restapi.
21 operations
13 paths
156 schemas
1 DELETE11 GET2 POST7 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Docusign Envelopes API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode and implicit flows, exposing 3 scopes.
OAuth2— DocuSign uses OAuth 2.0. Supports Authorization Code Grant for user-present applications and JWT Grant for service integrations.
Paths & Operations 21
Across 13 paths, the API surfaces 21 operations — 1 DELETE, 11 GET, 2 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.
Envelopes 21
Create, send, and manage envelopes. An envelope is the fundamental unit of a DocuSign transaction, containing the documents to be signed, the recipients who will sign them, and th…
POST
/accounts/{accountId}/envelopes
Docusign Create an Envelope
GET
/accounts/{accountId}/envelopes
Docusign List Envelopes
GET
/accounts/{accountId}/envelopes/{envelopeId}
Docusign Get an Envelope
PUT
/accounts/{accountId}/envelopes/{envelopeId}
Docusign Update an Envelope
GET
/v2/accounts/{accountId}/envelopes
Docusign Gets status changes for one or more envelopes.
POST
/v2/accounts/{accountId}/envelopes
Docusign Creates an envelope.
GET
/v2/accounts/{accountId}/envelopes/{envelopeId}
Docusign Gets the status of a single envelope.
PUT
/v2/accounts/{accountId}/envelopes/{envelopeId}
Docusign Send, void, or modify a draft envelope. Purge documents from a completed envelope.
GET
/v2/accounts/{accountId}/envelopes/{envelopeId}/audit_events
Docusign Gets the envelope audit events for an envelope.
GET
/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages
Docusign Returns document page image(s) based on input.
DELETE
/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}
Docusign Deletes a page from a document in an envelope.
GET
/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image
Docusign Gets a page image from an envelope for display.
PUT
/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image
Docusign Rotates page image from an envelope for display.
GET
/v2/accounts/{accountId}/envelopes/{envelopeId}/notification
Docusign Gets envelope notification information.
PUT
/v2/accounts/{accountId}/envelopes/{envelopeId}/notification
Docusign Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
GET
/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image
Docusign Gets the initials image for a user.
PUT
/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image
Docusign Sets the initials image for an accountless signer.
GET
/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature
Docusign Gets signature information for a signer or sign-in-person recipient.
GET
/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image
Docusign Retrieve signature image information for a signer/sign-in-person recipient.
PUT
/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image
Docusign Sets the signature image for an accountless signer.
PUT
/v2/accounts/{accountId}/envelopes/status
Docusign Gets the envelope status for the specified envelopes.
Schemas 156
The contract defines 156 schemas that model the data the API accepts and returns. The most detailed are witness (65 properties), signer (62 properties), envelopeDefinition (61 properties), inPersonSigner (59 properties). Each schema is shown below with its type and property counts.
Document
object
A document to be included in an envelope. Documents can be provided as base64-encoded content or by reference.
10 properties
TemplateRole
object
Maps a recipient to a role defined in a template. Used when creating an envelope from a template.
9 properties
Intermediary
object
An intermediary recipient who can forward the envelope to another person.
5 properties
EmailTab
object
A tab for email address input.
9 properties
ListTab
object
A dropdown list tab for selecting from predefined options.
11 properties
CustomFields
object
Envelope custom fields for metadata and integrations.
2 properties
EnvelopeSummary
object
Summary information about a newly created envelope.
4 properties
Signer
object
A signer recipient who must sign the envelope documents.
19 properties
EnvelopesInformation
object
Contains information about the envelopes returned by a list request, including the result set and pagination details.
7 properties
Checkbox
object
A checkbox tab for boolean selection.
11 properties
Decline
object
A decline button tab for document rejection.
9 properties
Recipients
object
Contains the recipient collections for an envelope, organized by recipient type.
10 properties
CompositeTemplate
object
A composite template that combines server templates and inline templates for complex envelope workflows.
4 properties
FormulaTab
object
A calculated field tab using formulas.
10 properties
CarbonCopy
object
A carbon copy recipient who receives a copy of the completed documents but does not need to take any action.
7 properties
SignHere
object
A signature tab placed on a document.
14 properties
EnvelopeDefinition
object
The envelope definition object that contains all the properties needed to create and send an envelope.
13 properties
ErrorDetails
object
Contains error information returned by the API.
2 properties
Agent
object
An agent recipient who can designate a recipient to sign in their place.
5 properties
InitialHere
object
An initial tab placed on a document.
10 properties
Editor
object
An editor recipient who can modify the envelope before it is sent.
5 properties
NumberTab
object
A tab for numeric input.
9 properties
RadioGroup
object
A group of radio buttons for single-choice selection.
5 properties
InPersonSigner
object
An in-person signer recipient for face-to-face signing where a host manages the signing session.
8 properties
CertifiedDelivery
object
A certified delivery recipient who must confirm receipt of the envelope documents.
5 properties
Text
object
A text input tab for free-form text entry.
23 properties
Notification
object
Envelope notification settings including reminders and expirations.
3 properties
Witness
object
A witness recipient who verifies the identity of a signer.
6 properties
RecipientEmailNotification
object
Custom email notification settings for a recipient.
3 properties
Approve
object
An approve button tab for document approval.
8 properties
Envelope
object
Contains the properties of an envelope.
28 properties
EnvelopeRecipientTabs
object
Contains the tab collections for an envelope recipient, organized by tab type.
15 properties
DateTab
object
A tab for date selection.
9 properties
EnvelopeUpdateSummary
object
Summary of an envelope update operation.
6 properties
FullName
object
A tab auto-filled with the recipient full name.
9 properties
NoteTab
object
A read-only note tab for displaying text.
8 properties
EventNotification
object
Configuration for envelope event notifications via DocuSign Connect webhooks.
12 properties
DateSigned
object
A tab that displays the date the recipient signed.
9 properties
UserInfo
object
Information about a DocuSign user.
4 properties
addressInformationInput
object
Contains address input information.
3 properties
recipientPhoneAuthentication
object
A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderPr…
4 properties
recipientIdentityPhoneNumber
object
3 properties
fullName
object
A tab that displays the recipient's full name.
34 properties
textCustomField
object
7 properties
number
object
A tab that allows the recipient to enter numbers and decimal (.) points.
49 properties
eventResult
object
4 properties
listItem
object
One of the selectable items in the listItems property of a [list](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/crea…
3 properties
pageImages
object
7 properties
editor
object
45 properties
userInfo
object
10 properties
page
object
Description of a page of a document.
8 properties
eventNotification
object
Register a Connect webhook for a specific envelope
16 properties
compositeTemplate
object
5 properties
documentHtmlDisplayAnchor
object
6 properties
authenticationStatus
object
Contains information about the authentication status.
19 properties
paymentLineItem
object
A line item describes details about an individual line item in a payment request.
4 properties
firstName
object
A tab that displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on s…
34 properties
AccountCustomFields
object
Custom Fields
2 properties
recipientProofFile
object
1 property
dobInformationInput
object
Complex type containing: dateOfBirth displayLevelCode receiveInResponse
3 properties
formulaTab
object
The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the…
52 properties
envelopeEvent
object
For which envelope events should your webhook be called?
2 properties
recipientIdentityVerification
object
2 properties
paymentDetails
object
When a formula tab has a paymentDetails property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuS…
15 properties
ssn9InformationInput
object
2 properties
agent
object
Contains information about agent recipients.
46 properties
recipientUpdateResponse
object
3 properties
inPersonSigner
object
An in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about fields used for eNotary…
59 properties
recipientEmailNotification
object
3 properties
initialHere
object
A tab that allows the recipient to initial the document. May be optional.
29 properties
templateRole
object
13 properties
pageRequest
object
2 properties
checkbox
object
A tab that allows the recipient to select a yes/no (on/off) option.
32 properties
approve
object
A tab that allows the recipient to approve documents without placing a signature or initials on the document.
35 properties
signHere
object
A tab that allows the recipient to sign a document. May be optional.
31 properties
envelopeNotificationRequest
object
3 properties
idCheckInformationInput
object
A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to s…
4 properties
radio
object
One of the selectable radio buttons in the radios property of a [radioGroup](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipie…
18 properties
expirations
object
A complex element that specifies the expiration settings for the envelope.
3 properties
dateStampProperties
object
4 properties
email
object
A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same paramet…
47 properties
errorDetails
object
This object describes errors that occur. It is only valid for responses, and ignored in requests.
2 properties
envelopeId
object
A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab.
33 properties
mergeField
object
Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
5 properties
lastName
object
A tab that displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on sp…
34 properties
envelope
object
52 properties
ssn4InformationInput
object
3 properties
smartSectionCollapsibleDisplaySettings
object
10 properties
witness
object
65 properties
bulkEnvelope
object
9 properties
emailSettings
object
3 properties
EnvelopeRecipientTabs_2
object
All of the tabs associated with a recipient. Each property is a list of a type of tab.
27 properties
bulkEnvelopeStatus
object
14 properties
document
object
A document object.
22 properties
dateSigned
object
A tab that displays the date that the recipient signed the document.
34 properties
company
object
A tab that displays the recipient's company name.
41 properties
recipientSignatureProviderOptions
object
Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](htt…
4 properties
recipientAttachment
object
6 properties
recipientIdentityInputOption
object
3 properties
radioGroup
object
This group tab is used to place radio buttons on a document. The radios property contains a list of [radio](https://developers.docusign.com/esign-rest-api/refe…
12 properties
envelopeSummary
object
4 properties
carbonCopy
object
49 properties
signerAttachment
object
A tab that allows the recipient to attach supporting documents to an envelope.
29 properties
socialAuthentication
object
1 property
emailAddress
object
A tab that displays the recipient's email as entered in the recipient information.
34 properties
zip
object
A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or with…
48 properties
view
object
This tab is used with the Approve tab to handle supplemental documents.
37 properties
smartSection
object
33 properties
attachment
object
Contains information about an attachment.
7 properties
money
object
Describes information about the total of a payment.
3 properties
envelopesInformation
object
Result set for the Envelopes: listStatusChanges method
10 properties
certifiedDelivery
object
49 properties
documentVisibility
object
5 properties
notarize
object
A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.
27 properties
title
object
A tab that displays the recipient's title.
41 properties
envelopeTransactionStatus
object
4 properties
bccEmailAddress
object
Contains information about the BCC email address.
2 properties
note
object
A tab that displays additional information, in the form of a note, for the recipient.
37 properties
envelopeAuditEvent
object
1 property
envelopeDefinition
object
61 properties
EnvelopeLocks
object
Envelope locks
8 properties
matchBox
object
5 properties
samlAssertionAttribute
object
4 properties
text
object
A tab that allows the recipient to enter any type of text.
50 properties
intermediary
object
46 properties
recipientSignatureInformation
object
Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipi…
3 properties
ssn
object
A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Tex…
47 properties
recipientSignatureProvider
object
An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-ap…
4 properties
signer
object
A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add…
62 properties
date
object
A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this ta…
47 properties
recipientSAMLAuthentication
object
Contains the name/value pair information for the SAML assertion attributes: name - The name of the SAML assertion attribute. value - The value associated with…
1 property
smartSectionDisplaySettings
object
12 properties
reminders
object
A complex element that specifies reminder settings for the envelope
3 properties
inlineTemplate
object
5 properties
addressInformation
object
Contains address information.
9 properties
listCustomField
object
8 properties
list
object
This tab offers a list of options to choose from. The listItems property contains a list of [listItem](https://developers.docusign.com/esign-rest-api/reference…
41 properties
envelopeAuditEventResponse
object
1 property
envelopeIdsRequest
object
2 properties
decline
object
A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided.
36 properties
serverTemplate
object
2 properties
userSignature
object
21 properties
paymentSignerValues
object
1 property
nameValue
object
4 properties
notification
object
A complex element that specifies the notification options for the envelope. It consists of: useAccountDefaults - When set to true, the account default notifica…
3 properties
envelopeUpdateSummary
object
8 properties
sealSign
object
Specifies one or more electronic seals to apply on documents. json "recipients": { "seals": [ { "recipientId": "1", "routingOrder" : 1, "recipientSignatureProv…
39 properties
documentHtmlDisplaySettings
object
12 properties
recipientEvent
object
2 properties
notaryHost
object
This object is used only when inPersonSigningType in the inPersonSigner object is notary. It describes information about the notary host. The following informa…
40 properties
EnvelopeRecipients
object
Envelope recipients
12 properties
recipientSMSAuthentication
object
Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
1 property
smartSectionAnchorPosition
object
3 properties
documentHtmlCollapsibleDisplaySettings
object
10 properties
propertyMetadata
object
2 properties
documentHtmlDefinition
object
11 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Docusign 12
Other APIs Docusign publishes across the network.
Docusign Web Forms API
Docusign Notary API
Docusign Navigator API
Docusign Workspaces API
Docusign CLM API
Docusign Connected Fields API
Docusign AccountBrands API
Docusign AccountConsumerDisclosures API
Docusign AccountCustomFields API
Docusign AccountPasswordRules API
Docusign AccountPermissionProfiles API
Docusign Accounts API
#Envelopes
Where this information came from
This is an independent, third-party profile of Docusign Envelopes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.