Skip to navigation
Docusign eSignature REST APIEnvelopes

EnvelopeViews Resource

View as Markdown

The EnvelopeViews provides methods that return URLs that you can embed into your application to provide access to the DocuSign UI.

The following views are available:

  • Console View - The authentication view of the DocuSign UI.
  • Correct View - The correction view of the DocuSign UI.
  • Edit View - The editing view of the DocuSign UI.
Note: This provides the same functionality as the sender view.
  • Recipient View - The view the recipient sees in the DocuSign UI.
  • Sender View - The sending view of the DocuSign UI.

Methods supported

MethodDescription
createConsolePOST /restapi/v2/accounts/{accountId}/views/console
Returns a URL to the authentication view UI.
createCorrectPOST /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/views/correct
Returns a URL to the envelope correction UI.
createEditPOST /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/views/edit
Returns a URL to the edit view UI.
createRecipientPOST /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/views/recipient
Returns a URL to the recipient view UI.
createSenderPOST /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/views/sender
Returns a URL to the sender view UI.
createSharedRecipientPOST /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/views/shared
Provides a URL to start a shared recipient view of the Envelope UI
deleteEnvelopeCorrectViewDEL /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/views/correct
Revokes the correction view URL to the Envelope UI

EnvelopeViews properties

PropertyTypeDescription
urlstringThe view URL to be navigated to.