Returns a URL that enables you to embed the sender view of the DocuSign UI in your applications.
The returned URL can only be redirected to immediately after it is generated. It can only be used once. Therefore, request the URL immediately before you redirect your user to it.
For the best user experience, don't use an iFrame. For iOS devices DocuSign recommends using a WebView.
Multiple solutions are available for maintaining your client state. See the Maintaining State section of the Embedded Signing introduction.
After the user has completed the sending view, the browser is redirected to the
By default, if the envelope already contains one or more documents, DocuSign will initially show the document tagging view when you redirect to the URL.
To start with the envelope's recipients and documents view instead, examine the URL in the method's response.
Then change the query parameter from
send=0 to start with the recipients/documents view.
Note: You can revoke the URL by making the DELETE call to the same URL with no request body.
Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.
If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:
- Configure each sender to have their own individual user account to use this API method.
- Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.
The external account number (int) or account ID GUID.
The envelope's GUID.