DocuSign

Creates custom document fields in an existing template document within DocuSign. This endpoint allows users to add metadata to specific documents in a template, enhancing document management and workflow customization. It is particularly useful for prepopulating custom data fields that will be applied to all new envel…

Untrusted display-only summary

Creates a custom tab with pre-defined properties for use in DocuSign envelopes. This endpoint allows users to define reusable tab types with specific configurations such as font styles, validation patterns, and positioning rules. Custom tabs can be created for various field types including text, checkboxes, radio butt…

Untrusted display-only summary

Creates a responsive HTML preview for a specific document in an envelope. Generates a mobile-friendly preview showing how the document renders on different devices. Useful for testing smart sections, collapsible content, and responsive tables before sending. **Requirements:** Envelope and document must already exist.…

Untrusted display-only summary

Creates a signing envelope from a pre-existing DocuSign template. This action maps specific recipients to template roles and creates an envelope, either as a draft (status='created') or sent immediately (status='sent'). Prerequisites: - Use DOCUSIGN_LIST_ALL_TEMPLATES to get template IDs and role names - Role names in…

Untrusted display-only summary

Creates one or more groups for a specified DocuSign account. This endpoint is used for managing user access and permissions by organizing users into groups. Groups can be associated with permission profiles to streamline user management for large numbers of users. The endpoint accepts an array of group objects, each c…

Untrusted display-only summary

Generates a 2-minute resource token to access recipient identity verification data via DocuSign's ID Evidence API. **Requirements:** Recipient must have completed identity verification (phone auth, ID scan, etc.) during envelope signing. Fails if envelope is draft or verification incomplete. **Usage:** Get token and p…

Untrusted display-only summary

This endpoint creates a new permission profile for a DocuSign account, defining specific sets of permissions for user groups. It allows administrators to establish role-based access control within their DocuSign environment. The profile controls a wide range of user capabilities, from basic envelope sending to advance…

Untrusted display-only summary

Registers a notary jurisdiction for the current DocuSign user, enabling electronic notarizations for a specific U.S. state. A user can only have ONE jurisdiction at a time. Required fields: commissionExpiration (MM/DD/YYYY format), commissionId, registeredName, sealType, and jurisdiction details (jurisdictionId, name,…

Untrusted display-only summary

Creates or updates user authorizations in DocuSign, allowing an agent user to perform actions on behalf of a principal user. Grants permissions like Send, Manage, Sign, or Edit. Requirements: principal must be authenticated user or caller must be admin; agent users must be active; principal and agent must differ; agen…

Untrusted display-only summary

Creates a preview of the responsive HTML version of a specific template document in DocuSign. This endpoint allows users to visualize how a PDF document will be converted to responsive HTML across various device types before sending it for signing. It's particularly useful for ensuring that template documents are prop…

Untrusted display-only summary

Creates a preview of the responsive HTML versions of all documents in an envelope, allowing users to review how PDF documents will appear as responsive HTML across different device types before sending. This endpoint is particularly useful for ensuring document compatibility and readability on various screen sizes and…

Untrusted display-only summary

Creates a URL for manually reviewing a recipient's identity in DocuSign. This endpoint is used when automatic identity verification has failed and manual review is required. It returns a URL that allows the sender to access a page for manually verifying the recipient's ID. This method should only be used for recipient…

Untrusted display-only summary

Creates a URL for previewing the recipient's view of a draft envelope or template. This endpoint allows senders to simulate the recipient's experience by generating an embeddable preview URL. It's useful for verifying the appearance and functionality of an envelope before sending it to recipients. The preview can help…

Untrusted display-only summary

Creates a URL for embedding the DocuSign recipient view UI within an application, allowing users to sign documents directly in the app. This endpoint is specifically used for envelopes in the 'sent' status and generates a temporary URL that expires after 5 minutes. It provides a seamless way to integrate electronic si…

Untrusted display-only summary

Creates a URL for the sender view of a DocuSign envelope, enabling the embedding of DocuSign UI within an external application. This endpoint is crucial for integrating envelope sending functionality, allowing users to prepare and send envelopes directly from your application. The returned URL provides a customizable…

Untrusted display-only summary

Creates one or more signing groups in a DocuSign account. This endpoint allows account administrators to set up predefined groups of recipients for document signing. Multiple signing groups can be created in a single API call, enhancing efficiency in setting up complex signing workflows. Use this when you need to esta…

Untrusted display-only summary

Creates custom fields on a DocuSign template to capture additional metadata. Custom fields allow you to: - Add dropdown lists (listCustomFields) where senders select from predefined options - Add text fields (textCustomFields) where senders enter free-form text - Set default values and mark fields as required or optio…

Untrusted display-only summary

Generate a preview URL showing how a template will appear to recipients. This action creates an embeddable URL that displays a template from the recipient's perspective, allowing senders to verify the signing experience before sending the actual document. This is particularly useful for: - Previewing tab placement and…

Untrusted display-only summary

Creates a preview of the responsive HTML versions of all documents associated with a DocuSign template. This endpoint enables users to generate and customize the HTML preview of PDF documents across various device types before sending them for signing. It is particularly useful for ensuring that documents are easily r…

Untrusted display-only summary

Adds a new workflow step to an existing DocuSign template. This action enables sophisticated document routing automation within templates, including: - Pausing workflows before specific routing steps - Implementing delayed sending with scheduled resume dates - Setting up conditional recipient routing based on form fie…

Untrusted display-only summary

Creates a URL for embedding the DocuSign Template Edit view within an application. This endpoint enables developers to integrate DocuSign's template creation and editing functionality directly into their applications, allowing users to manage templates without leaving the app environment. The generated URL provides ac…

Untrusted display-only summary

Creates a user authorization in DocuSign, enabling an agent user to perform specific actions on behalf of a principal user within the same account. This endpoint is essential for setting up delegated access, allowing users to share envelope management, signing, or sending capabilities. It's particularly useful for str…

Untrusted display-only summary

This endpoint deletes a specific brand from a DocuSign account. It should be used when you need to permanently remove a brand configuration from an account, such as when a brand is no longer needed or has been replaced. The operation requires that branding for either signing or sending (or both) is enabled for the acc…

Untrusted display-only summary

Deletes an existing account custom field from a DocuSign account. This endpoint should be used when you need to remove a custom field that is no longer required or relevant for your account. It permanently removes the custom field, so use with caution. The deletion can optionally be applied to templates as well. This…

Untrusted display-only summary

This endpoint deletes a specific permission profile from a DocuSign account. It is used to remove outdated or unnecessary permission profiles, helping to streamline account management. The endpoint requires that the profile being deleted has no associated users, unless they are being reassigned to a new profile. It's…

Untrusted display-only summary

Deletes a specific account stamp (signature) from a DocuSign account. This endpoint should be used when you need to permanently remove a stamp from an account, such as when it's no longer needed or has been replaced. The operation is irreversible, so use it with caution. It's particularly useful for maintaining accoun…

Untrusted display-only summary

This endpoint deletes a BCC (Blind Carbon Copy) email archive configuration from a specified DocuSign account. When invoked, it changes the status of the targeted configuration to 'closed' and immediately stops the archiving of DocuSign-generated email messages to the associated BCC email address. This operation is us…

Untrusted display-only summary

This endpoint allows users to delete one or more brands from a specified group within a DocuSign account. It is used to manage brand associations with groups, enabling customization of branding for different envelopes and signing experiences. The operation removes the specified brands from the group, updating the grou…

Untrusted display-only summary

This endpoint deletes a specific logo from an account brand in DocuSign. It allows users to remove primary, secondary, or email logos associated with their brand, helping maintain brand consistency across DocuSign documents. The endpoint should be used when updating or removing branding elements from a DocuSign accoun…

Untrusted display-only summary

This endpoint allows you to delete one or more brand profiles from a DocuSign account. It is used to remove custom branding configurations that are no longer needed. The method requires either the 'canSelfBrandSign' or 'canSelfBrandSend' setting to be enabled for the account. It's important to note that this operation…

Untrusted display-only summary