Skip to navigation

When to use embedded or remote web form instance delivery

View as Markdown

The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your account manager to find out whether the Web Forms API is available for your production account plan.

You can request more information from a recipient before they open and sign an envelope agreement using Web Forms. There are two options for presenting your recipients with your web form instances: embedded and remote.

Learn about embedded web form instance delivery

You can have your recipients view and sign web form instances within your app using embedded web form instance delivery. In embedded delivery, you create instances of your activated web form configurations for your recipients by embedding the web form instance URL in your app. Each recipient will get one web form instance which, for eSignature-based flows, will generate one envelope.

Embedded template-based web form delivery follows these steps:

  1. Ensure that you have a web form configuration created from an existing eSignature template. The Web Forms builder extracts document, tab, and recipient information from the eSignature template to serve as the framework for your web form configuration, which you can edit as needed. This template can include multiple recipients.
  2. Call the Instances:createInstance API endpoint, using your web form configuration ID as the call’s form ID. You can find your web form’s configuration ID by calling the Configurations:listForms endpoint and finding the form entry in that call’s response.
  3. The generated web form instance will include an instance URL, which you can open in your app. This displays the web form, and the recipient is prompted to enter information for the web form fields assigned to them.
  4. After they finish entering their information in their web form, the recipient is presented with their envelope, which is prefilled with their web form instance information. They are then prompted to fill in any envelope tabs assigned to them and/or sign the agreement.

If there are multiple recipients, only the primary recipient is presented with the web form instance in an embedded view. Additional recipients access the web form instance via an envelope email.

See Web form instance processing for details and flow diagrams.

When to use embedded web form instance delivery

Embedded web form instance delivery has two main advantages:

  • Because you are embedding the web form instance into your app, your user is already logged in and authenticated. This offers the highest level of security.
  • Embedding the form instance directly in your app provides a seamless experience where your users can view and sign forms immediately.

Use embedded web form instance delivery when your users need to complete and sign forms instantly, directly within your digital environment, or when you need to support high-volume, public, or in-person workflows without relying on email distribution.

Example use cases

  • Self-service workflows

    • Account registration: New users can fill out and sign onboarding forms immediately after creating an account, without waiting for an email.
    • Service requests: Customers can submit signed service requests or support forms directly from your portal.
  • Walk-in or in-person scenarios

    • In-branch or in-office signing: Banks, clinics, or government offices can have clients complete forms on tablets or kiosks during their visit.
    • Event check-in: Attendees can sign waivers or registration forms on-site at events or conferences.
  • Immediate action required

    • Time-sensitive agreements: Users can complete forms instantly (e.g., urgent consent forms, last-minute registrations) without email delays.
    • Real-time transactions: E-commerce or financial platforms can capture signatures as part of the checkout or transaction process.

Embedded web form instance delivery also supports standalone web form configurations, which do not have a template and do not generate an envelope. These forms are used purely for data collection.

Learn about remote web form instance delivery

You can send web form instances directly to one or more recipients via email using remote web form instance delivery. These recipients each fill out their own view of a web form instance, and the information from those form instances is used to prefill and personalize an eSignature envelope that each recipient will then complete.

You can use this feature to send web form instances to your recipients through the UI or by making a call to the Instances:createInstance API endpoint. Remote web form instance delivery follows these steps:

  1. Ensure that you have a web form configuration created from an existing eSignature template. The Web Forms builder extracts document, tab, and recipient information from the eSignature template to serve as the framework for your web form configuration, which you can edit as needed. This configuration can include multiple recipients. Older versions of a web form configuration may not support remote delivery; in these cases, recreate the form.

  2. Call the Instances:createInstance API endpoint, using your web form configuration ID as the call’s form ID. To indicate that you are using remote web form delivery, you must also include the following body fields:

    You can find your web form’s configuration ID by calling the Configurations:listForms endpoint and finding the form entry in that call’s response. Any recipients whose information is not provided in the request body will have their assigned tabs removed from the generated web form instance and envelope.

    See How to create and send a web form instance for a detailed walkthrough.

  3. In routing order, each recipient receives an email containing a link to an envelope. This envelope will include an embedded web form instance if your web form configuration specifies that they must fill out fields for that web form instance. If they select the link, their browser opens the web form instance and they are prompted to enter information for the form fields assigned to them. Users who are not required to fill out the web form instance will be routed directly to the envelope.

  4. After they finish entering their information in the web form instance, the recipient is presented with the envelope, which is prefilled with web form instance information. They are then prompted to fill in any envelope tabs assigned to them and/or sign the agreement.

See Deliver remote web form instances to users for details on how to generate remote web form instances, or Web form instance processing for more information on the flow and diagrams.

Restrictions for using remote web form instance delivery

  • Standalone web form configurations are not supported.
  • Attachment fields are not supported.
  • Older form configurations may not be compatible with the new remote sending functionality. To check for compatibility, you should look at the allowSending flag under formProperties (which requires a Configurations:getForm API call).

When to use remote web form instance delivery

Use remote web form instance delivery for flows that do not require an embedded experience. This enables you to rely on Docusign to handle the user flow from end-to-end.

Example use cases

  • Mass onboarding

    • Employee onboarding: HR departments can send onboarding forms (e.g., tax forms, direct deposit, policy acknowledgments) to new hires.
    • Vendor/supplier onboarding: Procurement teams can distribute registration or compliance forms to vendors.
  • Customer agreements and consents

    • Service agreements: Companies can send updated terms of service or consent forms to customers who need to review and sign.
    • Policy updates: When privacy policies or terms change, organizations can request acknowledgment from affected users.
  • Compliance and regulatory requirements

    • Annual compliance certifications: Financial institutions or healthcare providers can send compliance attestation forms to employees or clients.
    • Audit documentation: Collect required documentation from multiple parties for regulatory audits.

Next steps