Data:
+ +event: ${event}. This event parameter is supplied by DocuSign via the redirect URL. + Since it could have been spoofed, don't make business decisions based on + its value. Instead, query DocuSign as appropriate.
+envelopeId: ${qpEnvelopeId}. The envelopeId parameter is supplied by DocuSign.
+state: ${state}. This example state was sent to DocuSign and has now been received back. + It is usually better to store state in your web framework's session.
+This example sends an envelope, and then uses Embedded signing for the first signer.
+Embedded signing provides a smoother user experience for the signer: DocuSign signing is initiated from + your website.
+Documentation about this example.
+API methods used: + Envelopes::create + and + EnvelopeViews::createRecipient. +
++ View source file ${sourceFile} on GitHub. +
+ + + +The envelope includes a pdf, Word, and HTML document. Anchor text + (AutoPlace) + is used to position the signing fields in the documents. +
+This is a general example of creating and sending an envelope (a signing request) to multiple recipients, + with multiple documents, and with signature fields for the documents.
+Documentation about this example.
+API method used: + Envelopes::create. +
+ ++ View source file ${sourceFile} on GitHub. +
+ + + +List the envelopes created in the last 30 days.
+This example demonstrates how to query DocuSign about envelopes sent by the current user.
+Documentation about this example.
+API method used: + Envelopes::listStatusChanges. +
++ View source file ${sourceFile} on GitHub. +
+ + + +List the basic information about an envelope, including its overall status. + Additional API/SDK methods may be used to get additional information about the + envelope, its documents, recipients, etc.
+ +This example demonstrates how to obtain the latest information about + an envelope from DocuSign. Often an alternative is to use Connect + to enable DocuSign to proactively send your application updates when the + status of an envelope changes. +
+ +Documentation about this example.
+API method used: + Envelopes::get. +
+ ++ View source file ${sourceFile} on GitHub. +
+ +The envelope you created via example 2 will be queried.
+ + +Problem: please first create an envelope using example 2.
+ Thank you.
List the envelope's recipients, including their current status.
+ +Documentation about this example.
+API method used: + EnvelopeRecipients::list. +
++ View source file ${sourceFile} on GitHub. +
+ +The envelope you created via example 2 will be queried.
+ + +Problem: please first create an envelope using example 2.
+ Thank you.
List the envelope's documents. A Certificate of Completion document + is also associated with every envelope. +
+ +This method is often used to dynamically create a list of an envelope's documents + in preparation for enabling your user to download one or more of the documents.
+Documentation about this example.
+API method used: + EnvelopeDocuments::list. +
+ ++ View source file ${sourceFile} on GitHub. +
+ +The envelope you created via example 2 will be queried.
+ + +Problem: please first create an envelope using example 2.
+ Thank you.
An envelope's documents can be downloaded one by one or as a complete set.
+Document download options:
+Documentation about this example.
+API method used: + EnvelopeDocuments::get. +
+ ++ View source file ${sourceFile} on GitHub. +
+ +Problem: please first create an envelope using example 2.
+ You will then need to use example 6 to create the list of documents.
+ Thank you.
Problem: please first create a list of the envelope's documents using
+ example 6.
+ Thank you.
Please choose a document.
+ The document list is from your results for example 6.
Create a template with two roles, signer and cc. + The template includes three documents. +
+ +Templates are usually created using the DocuSign web tool. This example creates + a template that will later be used by other examples in this launcher.
+ +This example first lists the user's templates and only creates a new template if one does not already exist in your + account. +
+Documentation about this example.
+API methods used: + Templates::list, + Templates::create. +
+ ++ View source file ${sourceFile} on GitHub. +
+ + + +The envelope is defined by the template. + The signer and cc recipient name and email are used to fill in the template's roles.
+ +This example demonstrates a common pattern for DocuSign integrations: envelopes will + be sent programmatically, based on a template. If the template definition needs to be + updated, the DocuSign web tool can be used to easily update the template, thus + avoiding the need to make software changes. +
+ +Documentation about this example.
+API method used: + Envelopes::create. +
++ View source file ${sourceFile} on GitHub. +
+ +The template you created via example 8 will be used.
+ + +Problem: please first create the template using example 8.
+ Thank you.
The envelope includes a pdf, Word, and HTML document.
+Multipart data transfer is used to send the documents in binary format to DocuSign. + Binary transfer is 33% more efficient than base64 encoding and is recommended for documents over 15M Bytes. +
+ +Since binary transfer is not yet supported by the SDK, this example uses the API directly and + demonstrates how to do so.
+Documentation about this example.
+API method used: + Envelopes::create. +
+ ++ View source file ${sourceFile} on GitHub. +
+ + + +An envelope will be created in draft mode. Your browser will then be redirected to + the DocuSign web tool where the envelope can be (optionally) updated and then sent.
+The envelope includes a pdf, Word, and HTML document. Anchor text + (AutoPlace) + is used to position the signing fields in the documents.
+DocuSign recommends that you enhance your application as needed to avoid the need + for the embedded sender view. +
+For example, if the sender view is used to optionally + add additional documents to the envelope, enhance your app to provide the + needed feature (see example 13 for adding additional documents programmatically). +
+Documentation about this example.
+API methods used: + Envelopes::create and + EnvelopeViews::createSender. +
+ ++ View source file ${sourceFile} on GitHub. +
+ + + +Redirect the user to the DocuSign web tool.
+Use this API call to open the DocuSign web tool, the NDSE (New DocuSign Signing Experience), + with the user already logged in.
+The starting view can be either an envelope's documents or the web tool's front page.
+The user does not necessarily return from the NDSE, so using this API call is often a final + step for your application. + Or you can open the NDSE in a new tab for the user. +
+ +Documentation about this example.
+API method used: + EnvelopeViews::createConsole. +
+ ++ View source file ${sourceFile} on GitHub. +
+Optional: to use the Envelope's document view please first create an envelope using + example 2.
+This example sends an envelope based on a template.
+In addition to the template's document(s), the example adds an + additional document to the envelope by using the + Composite + Templates + feature.
+In this example, the additional document is an HTML document that + includes order details with information from the form below.
+This example then enables you to sign the envelope using embedded signing.
+Embedded signing provides a smoother user experience for a signer who is + already logged into your web application since the DocuSign + signing is initiated from your website.
+Documentation about this example.
+API methods used: + Envelopes::create + and + EnvelopeViews::createRecipient. +
++ View source file ${sourceFile} on GitHub. +
+The template you created via example 8 will be used.
+ + +Problem: please first create the template using example 8.
+ Thank you.
+ The envelope includes a pdf document. Anchor text + (AutoPlace) + is used to position the signing fields in the documents. +
++ This is a general example of creating and sending an envelope (a signing request) using An Access Code for Recipient Authentication. +
+ +Documentation about this example.
+API method used: + Envelopes::create. +
+ ++ View source file ${sourceFile} on GitHub. +
+ + + + +Documentation about this example.
+API method used: + Envelopes::create. +
+ ++ View source file ${sourceFile} on GitHub. +
+ + + + +Documentation about this example.
+API method used: + Envelopes::create. +
+ ++ View source file ${sourceFile} on GitHub. +
+ + + + +