{% extends "base.html" %} {% block content %} {% if not session['ds_user_name'] %}

PHP Launcher

Welcome to the DocuSign PHP examples using multiple OAuth flows (JWT and Authorization Code Grant).
{% endif %}

Welcome

This launcher both demonstrates use of the OAuth Authorization Code Grant and JWT flows and includes multiple usage examples for the DocuSign eSignature REST API.

{% if show_doc %}

Documentation on using OAuth Authorization Code Grant from a PHP application.

{% endif %}

Basic Examples

1. Use embedded signing

This example sends an envelope, and then uses embedded signing for the first signer. With embedded signing, DocuSign signing is initiated from your website.

API methods used: Envelopes::create and EnvelopeViews::createRecipient.

2. Send an envelope with a remote (email) signer and cc recipient

The envelope includes a pdf, Word, and HTML document. Anchor text (AutoPlace) is used to position the signing fields in the documents.

API method used: Envelopes::create.

3. List envelopes whose status has changed

List the envelopes whose status has changed in the last 10 days.

API method used: Envelopes::listStatusChanges.

4. Get an envelope's basic information and status

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.

API method used: Envelopes::get.

5. List an envelope's recipients and their status

List the envelope's recipients, including their current status.

API method used: EnvelopeRecipients::list.

6. List an envelope's documents

List the envelope's documents. A Certificate of Completion document is also associated with every envelope.

API method used: EnvelopeDocuments::list.

7. Download a document from an envelope

An envelope's documents can be downloaded one by one or as a complete set.

API method used: EnvelopeDocuments::get.

8. Create a template

Create a template with two roles, signer and cc.

API methods used: Templates::list, Templates::create.

9. Send an envelope using a template

The envelope is defined by the template. The signer and cc recipient name and email are used to fill in the template's roles.

API method used: Envelopes::create.

10. Send an envelope using binary document transfer

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. Binary transfer is not yet supported by the SDK.

API method used: Envelopes::create.

11. Use embedded sending

An envelope will be created in draft mode. The DocuSign UI will then be shown, enabling further updates to the envelope before it is sent.

API methods used: Envelopes::create, EnvelopeViews::createSender.

12. Embedded DocuSign web tool

Redirect the user to the DocuSign web tool.

API method used: EnvelopeViews::createConsole.

13. Use embedded signing from a template with an added document

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.

API methods used: Envelopes::create and EnvelopeViews::createRecipient.

14. Payments Example: Send an envelope with an order form and payment field

Anchor text (AutoPlace) is used to position the fields in the documents.

API method used: Envelopes::create.

15. Get the tab data from an envelope

This example retrieves the tab (field) values from an envelope.

API method used: EnvelopeFormData::get.

16. Set tab values for an envelope

This example sets the tab (field) values for an envelope including tabs that can and cannot be changed by the signer.

API method used: Envelopes::create.

17. Set template tab values

This example sets the tab (field) values for a template being used by an envelope.

API method used: Envelopes::create.

18. List envelope custom metadata field values

This example lists the envelope's custom metadata field values.

API method used: EnvelopeCustomFields::list.

19. Access Code Authentication

This is an example of an envelope utilizing Access Code authentication for multi-factor verification of a recipient.

API method used: Envelopes::create.

20. SMS Authentication

This is an example of an envelope utilizing SMS authentication for multi-factor verification of a recipient.

API method used: Envelopes::create.

21. Phone Authentication

This is an example of an envelope utilizing phone authentication for multi-factor verification of a recipient.

API method used: Envelopes::create.

22. KBA Authentication

This is an example of an envelope utilizing Knowledge based authentication for multi-factor verification of a recipient.

API method used: Envelopes::create.

23. IDV Authentication

This is an example of an envelope utilizing Id verification authentication for a recipient.

API methods used: Accounts::getAccountIdentityVerificationsList. Envelopes::create.

Permissions

24. Creating a permission profile

Creating a permission profile

API method used: AccountPermissionProfiles::create.

25. Setting a permission profile

Setting a permission profile

API method used: Groups::update.

26. Updating individual permission profile settings

Updating individual permission

API method used: AccountPermissionProfiles::update.

27. Deleting a permission profile

Deleting a permission profile

API method used: AccountPermissionProfiles::delete.

Brands

28. Create a new Brand

Creating a Brand

API method used: AccountBrands::create.

29. Applying a Brand to an envelope

Applies a Brand to an envelope

API method used: Envelopes::create.

30. Applying a Brand to a template

Applies a Brand to an template

API method used: Envelopes::create.

Bulk operations

31. Bulk sending envelopes to multiple recipients

Bulk sending envelopes to multiple recipients

API method used: EnvelopeRecipients::create. Envelopes::create. BulkEnvelopes::get. EnvelopeCustomFields::create. BulkSend::createBulkSendList. EnvelopeRecipients::create.

Advanced recipient routing

32. Pause a signature workflow (Coming soon)

This example creates and envelope and then pauses the signature workflow.

API method used: Envelopes::create.

33. Unpause a signature workflow (Coming soon)

This example unpauses a signature workflow for the previously created envelope that was paused.

API method used: Envelopes::update.

34. Conditional recipients (Coming soon)

This example creates an envelope that is routed to different recipients based on a predefined condition.

API method used: Envelopes::create.

Premium Features

35. Request Signature by SMS

This example demonstrates how to send a signature request for a signer (and CC) to read and sign via an SMS message.

API method used: Envelopes::create.

{% endblock %}