View Source API Reference DocuSign v1.2.0

Documentation for DocuSign.

Deprecated interface to manage OAuth2 clients. DocuSign.ClientRegistry should be used instead.

API calls for all endpoints tagged AccountBrands.

API calls for all endpoints tagged AccountConsumerDisclosures.

API calls for all endpoints tagged AccountCustomFields.

API calls for all endpoints tagged AccountPasswordRules.

API calls for all endpoints tagged AccountPermissionProfiles.

API calls for all endpoints tagged AccountSealProviders.

API calls for all endpoints tagged AccountSignatureProviders.

API calls for all endpoints tagged AccountSignatures.

API calls for all endpoints tagged AccountTabSettings.

API calls for all endpoints tagged AccountWatermarks.

API calls for all endpoints tagged Accounts.

API calls for all endpoints tagged BCCEmailArchive.

API calls for all endpoints tagged BillingPlans.

API calls for all endpoints tagged BulkSend.

API calls for all endpoints tagged ChunkedUploads.

API calls for all endpoints tagged CloudStorage.

API calls for all endpoints tagged CloudStorageProviders.

API calls for all endpoints tagged Comments.

API calls for all endpoints tagged ConnectConfigurations.

API calls for all endpoints tagged ConnectEvents.

API calls for all endpoints tagged Contacts.

API calls for all endpoints tagged CustomTabs.

API calls for all endpoints tagged DocumentResponsiveHtmlPreview.

API calls for all endpoints tagged ENoteConfigurations.

API calls for all endpoints tagged EnvelopeAttachments.

API calls for all endpoints tagged EnvelopeConsumerDisclosures.

API calls for all endpoints tagged EnvelopeCustomFields.

API calls for all endpoints tagged EnvelopeDocumentFields.

API calls for all endpoints tagged EnvelopeDocumentHtmlDefinitions.

API calls for all endpoints tagged EnvelopeDocumentTabs.

API calls for all endpoints tagged EnvelopeDocumentVisibility.

API calls for all endpoints tagged EnvelopeDocuments.

API calls for all endpoints tagged EnvelopeEmailSettings.

API calls for all endpoints tagged EnvelopeFormData.

API calls for all endpoints tagged EnvelopeHtmlDefinitions.

API calls for all endpoints tagged EnvelopeLocks.

API calls for all endpoints tagged EnvelopePublish.

API calls for all endpoints tagged EnvelopeRecipientTabs.

API calls for all endpoints tagged EnvelopeRecipients.

API calls for all endpoints tagged EnvelopeTemplates.

API calls for all endpoints tagged EnvelopeTransferRules.

API calls for all endpoints tagged EnvelopeViews.

API calls for all endpoints tagged EnvelopeWorkflowDefinition.

API calls for all endpoints tagged Envelopes.

API calls for all endpoints tagged FavoriteTemplates.

API calls for all endpoints tagged Folders.

API calls for all endpoints tagged GroupBrands.

API calls for all endpoints tagged GroupUsers.

API calls for all endpoints tagged Groups.

API calls for all endpoints tagged IdentityVerifications.

API calls for all endpoints tagged Invoices.

API calls for all endpoints tagged Notary.

API calls for all endpoints tagged NotaryJournals.

API calls for all endpoints tagged NotaryJurisdiction.

API calls for all endpoints tagged PaymentGatewayAccounts.

API calls for all endpoints tagged Payments.

API calls for all endpoints tagged PowerFormData.

API calls for all endpoints tagged PowerForms.

API calls for all endpoints tagged RequestLogs.

API calls for all endpoints tagged Resources.

API calls for all endpoints tagged ResponsiveHtmlPreview.

API calls for all endpoints tagged Services.

API calls for all endpoints tagged SigningGroupUsers.

API calls for all endpoints tagged SigningGroups.

API calls for all endpoints tagged TabsBlob.

API calls for all endpoints tagged TemplateBulkRecipients.

API calls for all endpoints tagged TemplateCustomFields.

API calls for all endpoints tagged TemplateDocumentFields.

API calls for all endpoints tagged TemplateDocumentHtmlDefinitions.

API calls for all endpoints tagged TemplateDocumentResponsiveHtmlPreview.

API calls for all endpoints tagged TemplateDocumentTabs.

API calls for all endpoints tagged TemplateDocumentVisibility.

API calls for all endpoints tagged TemplateDocuments.

API calls for all endpoints tagged TemplateHtmlDefinitions.

API calls for all endpoints tagged TemplateLocks.

API calls for all endpoints tagged TemplateRecipientTabs.

API calls for all endpoints tagged TemplateRecipients.

API calls for all endpoints tagged TemplateResponsiveHtmlPreview.

API calls for all endpoints tagged TemplateViews.

API calls for all endpoints tagged Templates.

API calls for all endpoints tagged UserCustomSettings.

API calls for all endpoints tagged UserProfiles.

API calls for all endpoints tagged UserSignatures.

API calls for all endpoints tagged Users.

API calls for all endpoints tagged WorkspaceItems.

API calls for all endpoints tagged Workspaces.

GenServer to store API clients and automatically refresh JWT access tokens.

The module is intended to be used to establish a connection with DocuSign eSignature API and then perform requests to it.

Handle Tesla connections.

Helper functions for deserializing responses into models

Object specifying the format of the string provided to a recipient in order to access an envelope.

Contains information about the address associated with the account.

Contains information about an account billing plan.

Defines an account billing plan response object.

The AccountBrands resource enables you to use account-level brands to customize the styles and text that recipients see.

Details about account consumer disclosures.

An accountCustomField is an envelope custom field that you set at the account level. Applying custom fields enables account administrators to group and manage envelopes.

Information about a specific step in an Identity Verification workflow.

Specifies an Identity Verification workflow.

Contains account Information.

A complex element that specifies notifications (expirations and reminders) for the envelope.

Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.

Contains details about the password rules for an account.

The AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users.

This object defines account permissions for users who are associated with the account permission profile.

Contains account settings information. Used in requests to set property values. Used in responses to report property values.

Contains shared access information.

Contains information about the signature provider associated with the Identity Verification workflow. If empty, then this specific workflow is not intended for signers.

Reserved for DocuSign.

This resource provides information on the Standards Based Signature providers that have been provisioned for an account.

AccountSignatures represent stamps used to sign documents.

Tab settings determine the tab types and tab functionality that are enabled for an account.

An object that defines the options that are available to non-administrators in the UI.

Account management

Contains information about add ons.

Contains address information.

Contains address input information.

Contains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order.

Contains API request log information.

Contains information about multiple API request logs.

Contains information about an APP store product.

Contains information about an APP store receipt.

A tab that allows the recipient to approve documents without placing a signature or initials on the document.

Contains information about an attachment.

Contains information about the method used for authentication.

A complex element that contains information about a user's authentication status.

Contains information about the BCC email address.

The EmailArchive resource provides methods for managing your email archive configuration, which consists of the BCC email address or addresses that you want to use to archive DocuSign emails. Each account can use up to five BCC email addresses for archiving purposes.

Contains details about the history of the BCC email archive configuration.

Contains a list of BCC email archive configurations.

Contains information about a billing charge.

Defines a billing charge response object.

Contains information about a billing invoice.

Contains information about an item on a billing invoice.

Defines a billing invoice response object.

Contains information on a billing plan.

Defines a billing payment request object.

Defines an billing payment response object.

Defines a billing payments response object.

Contains information about a billing plan.

This object contains details about a billing plan.

Information used to provide a preview of a billing plan.

Defines a billing plan response object.

Defines a billing plan update response object.

Billing plans

Defines a billing plans response object.

Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.

Deprecated.

Information about a link that a brand uses.

The URIs for retrieving the logos that are associated with the brand. These are read-only properties that provide a URI to logos in use. To update a logo use AccountBrands: updateLogo.

This request object contains information about a specific brand.

Brands use resource files to style the following experiences: - Email - Sending - Signing - Captive (embedded) signing You can modify these resource files to customize these experiences.

Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.

Details about one or more brands.

The bulk send list resource provides methods that enable you to create and manage bulk sending lists, which you can use to send multiple copies of an envelope in a single batch. Note: The Bulk Send feature is only available on Business Pro and Enterprise Pro plans.

Result of getBulkSendBatchStatus

A list of bulk send batch summaries.

Summary status of a single batch.

A single bulk send error report.

This object contains information about the envelope or template that you want to send in bulk.

The object contains the response to a bulk send request.

This object contains the results of a bulk send test.

This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.

This object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send.

This object contains details about a bulk send recipient.

A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the tabLabel for this tab and the tabLabel for the corresponding tab on the envelope or template must be the same. For example, if the envelope has a placeholder text tab with the tabLabel childName, you must assign the same tabLabel childName to the tab here that you are populating with that information.

This object contains the details for the bulk send list.

This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.

This object contains basic information about a bulk send list.

This object contains details about a captive (embedded) recipient.

Contains information about captive (embedded) recipients.

Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents.

Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.

A tab that allows the recipient to select a yes/no (on/off) option.

An object that contains information about the chunked upload part.

This is the request object for uploading a chunked upload.

This response object is returned after you upload a chunked upload.

The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads.

Cloud storage

Contains details about a specific cloud storage provider.

The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.

Details about envelope comments.

A Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using DocuSign Notary.

A Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using DocuSign Notary.

A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/

A Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/

A tab that displays the recipient's company name.

This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/

A rule that defines a set of recipients and the conditions under which they will be used for the envelope.

This object contains the results of a ConnectConfigurations::GET method.

Contains information about a DocuSign Connect configuration.

The connectCustomConfiguration object describes a Connect configuration for your account.

This object lets you choose the data format of your Connect response.

Connect event logging information. This object contains sections for regular Connect logs and for Connect failures.

A list of failed envelope IDs to retry.

This object contains details about a Connect failure result.

The request body for the createHistoricalEnvelopePublishTransaction endpoint.

Contains information about a Connect log entry.

A complex object describing a Connect OAuth configuration.

This object is used to match a DocuSign field to a Salesforce field so that DocuSign can send information to your Salesforce account.

A connectSalesforceObject is an object that updates envelope and document status or recipient status in your Salesforce account. When you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments.

The request object for the EnvelopeViews: createConsole method.

Details about consumer disclosures.

This response object contains information about the contacts associated with an account.

The request object containing the new information for the contacts.

Details about the phone numbers associated with a specific contact.

This response objects shows the updated details for the contacts.

The Contacts resource enables you to manage the contact in an account's address book.

The request body for the EnvelopeViews: createCorrect method.

This object contains information about a credit card that is associated with an account.

Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only.

This object provides details about a custom field.

Contains information about custom fields.

Custom tabs

A tab that displays the date that the recipient signed the document.

Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - DateAreaX: The X axis position of the top-left corner. - DateAreaY: The Y axis position of the top-left corner. - DateAreaWidth: The width of the rectangle. - DateAreaHeight: The height of the rectangle.

A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided.

A complex element that specifies the delayed routing settings for the workflow step.

Contains information about a bank that processes a customer's direct debit payments.

Complex type containing: dateOfBirth displayLevelCode * receiveInResponse

A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format.

A tab that allows the recipient to enter numbers and decimal (.) points.

A document object.

Display settings for collapsible section.

Holds the properties that define how to generate the responsive-formatted HTML for the document. See Responsive signing in the eSignature concepts guide.

This object defines how to display the HTML between the startAnchor and endAnchor.

This resource is used to create a responsive preview of a specific document.

This object configures a recipient's read/write access to a document.

A list of documentVisibility objects that specify whether documents are visible to recipients.

A tab that allows the recipient to add a free-form drawing to the document.

This object contains information used to configure eNote functionality. To use eNote, the Allow eNote for eOriginal account plan item must be on, and the Connect configuration for eOriginal must be set correctly.

A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients.

A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

A tab that displays the recipient's email as entered in the recipient information.

A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. IMPORTANT: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. Example*: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.

The EnvelopeAttachments resource provides methods that allow you to manage attachments.

Details about envelope consumer disclosures.

An envelope custom field enables you to collect custom data about envelopes on a per-envelope basis. You can then use the custom data for sorting, organizing, searching, and other downstream processes. For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault their documents from the web app on a per-envelope basis by setting an envelope custom field with a name like "eVault with eOriginal?" to "Yes" or "No". When a user creates an envelope, the envelope custom fields display in the Envelope Settings section of the DocuSign console. Envelope recipients do not see the envelope custom fields. For more information, see Envelope Custom Fields.

Envelope object definition.

A user-specified object that describes the envelope delay. To indicate a relative delay, use delay. To indicate the exact datetime the envelope should be sent, use resumeDate. Only one of the two properties can be used.

This object contains details about the envelope document.

Envelope document fields

Document tabs are tabs that are associated with a document rather than with a recipient.

Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms. Note: Before you use Document Visibility, you should be aware of the following information: - Document Visibility must be enabled for your account by your DocuSign administrator. - A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. - When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images. - Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template. The Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see Use Document Visibility to Control Recipient Access.

Envelope documents

Envelope email settings

For which envelope events should your webhook be called?

This object contains the data that recipients have entered into the form fields associated with an envelope.

A tab that displays the envelope ID. Note: The eSignature API uses the name envelopeId two ways: - As a property of type string used to identify an envelope by its GUID. - As an object used to represent an envelope tab that displays the envelope's GUID.

Lists of envelope and transaction IDs to use in the results. If you use this request body with Envelopes: listStatus, you must set one or both of the following query parameters to the special value request_body: - envelope_ids=request_body - transaction_ids=request_body

Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope.

A complex element that specifies the notification settings for the envelope.

The EnvelopePublish resource allows you to submit existing envelopes to any webhook.

Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (retentionDays).

All of the tabs associated with a recipient. Each property is a list of a type of tab.

Envelope recipients

This object describes an envelope.

Information about templates.

Envelope templates

This object contains details about an envelope transfer rule.

This object contains details about the envelope transfer rule that you want to create.

This resource provides methods that enable account administrators to create and manage envelope transfer rules.

Provides a URL that you can embed in your application to provide access to the DocuSign UI. ### Related topics - Embedded signing and sending - Send an envelope via your app - Introducing customizable embedded sending

Describes the workflow for an envelope or template.

Envelope creation, management

Result set for the Envelopes: listStatusChanges method

This object describes errors that occur. It is only valid for responses and ignored in requests.

Use this object to configure a DocuSign Connect webhook.

Information about the result of an event.

A complex element that specifies the expiration settings for the envelope. When an envelope expires, it is voided and no longer available for signing. Note: there is a short delay between when the envelope expires and when it is voided.

A complex object specifying the external document sources.

This object contains information about a file or folder in cloud storage.

This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only.

Use this object to create a filtered view of the items in a folder.

A tab that displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name.

This object contains details about a folder.

Results from a folder item request.

Information about folder item results.

Folders allow you to organize envelopes and templates.

Information for a folder request.

A complex element that has up to four Question/Answer pairs for forgotten password information.

The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. The formula property of the tab contains the references to the underlying tabs. See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. If a formula tab contains a paymentDetails property, the tab is considered a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures

A tab that displays the recipient's full name.

This object contains information about a group.

If your account includes multiple signing brands, you can use the groups functionality to assign different brands to different groups. This resource enables you to manage group brands.

Groups' users

Group information

A complex object specifying ID check configuration.

A complex element that contains input information related to a recipient ID check.

Identity Verification enables you to verify a signer's identity before they can access a document. The IdentityVerifications resource provides a method that enables you to list the workflows that are available to an account.

Contains information about an in-person recipient. This is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about the fields used for the eNotary feature, see the [EnvelopeRecipients resource][resource]. [resource]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#in-person-signer-recipient

A tab that allows the recipient to initial the document. May be optional.

Contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added.

Invoices

Describes the jurisdiction of a notary. This is read-only object.

A tab that displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name.

This tab offers a list of options to choose from. The listItems property contains a list of listItem objects to specify the selectable options.

This object represents a list custom field from which envelope creators and senders can select custom data.

One of the selectable items in the listItems property of a list tab.

This request object contains information about the lock that you want to create or update.

Information about items shared among groups.

Information about shared items.

Contains information for transferring values between Salesforce data fields and DocuSign tabs.

Describes information about the total of a payment.

A name-value pair that describes an item and provides a value for the item.

Object representing a new user.

Object representing a summary of data for new users.

A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.

Use DocuSign eNotary to notarize documents digitally. Check the DocuSign eNotary support documentation to see which jurisdictions are supported.

This object is used only when inPersonSigningType in the inPersonSigner object is notary. It describes information about the notary host. The following information is required when using the eNotary in-person signing flow: name: Specifies the notary's full legal name. email: Specifies the notary's email address. * recipientId: A unique ID number for the notary signing host.

Creating, updating, and deleting notary jurisdiction objects.

A paged list of jurisdictions.

Describes a single notary jurisdiction.

A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/

A tab that displays additional information, in the form of a note, for the recipient.

A complex element that specifies the notification settings for the envelope.

Contains details about the default notification settings for the envelope notifications that senders and signers receive.

The NotificationDefaults resource provides methods that enable you to manage the default notifications for envelopes.

Reserved for DocuSign.

Description of a page of a document.

When a formula tab has a paymentDetails property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures

This object contains details about a payment gateway account.

Information about a connected payment gateway account.

Holds information about connected payment accounts.

A line item describes details about an individual line item in a payment request.

This object contains information about a payment method that the gateway accepts and the payment options that are compatible with it.

Payments

This object defines the account permissions for a profile that you can apply to a group of users.

Contains details about the permission profiles associated with an account.

A Phone Number tab enables a recipient to enter a phone number. Note: This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/

An object used to identify the features and attributes of the account being created.

This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.

Contains details about a PowerForm.

Data that recipients have entered in PowerForm fields.

Note: For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use Member as the Name), and omit personal details such as email.

This object includes information about the users who have sent PowerForms.

The PowerForms resource enables you to create fillable forms that you can email or make available for self service on the web.

A list of PowerForms.

Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields

Metadata about a property.

One of the selectable radio buttons in the radios property of a radioGroup tab.

This group tab is used to place radio buttons on a document. The radios property contains a list of radio objects associated with the group. Only one radio button can be selected in a group.

Describes an additional notification method.

Sets custom email subject and email body for individual recipients. Note: You must explicitly set supportedLanguage if you use this feature.

Describes a group of recipients.

Specifies ID Verification applied on an envelope by workflow ID. See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other recipient authentication methods.

This response object contains a list of recipients.

Describes a recipient who is a member of a conditional group.

A complex type that contains the elements: recipMayProvideNumber: A Boolean value that specifies whether the recipient can use the phone number of their choice. senderProvidedNumbers: A list of phone numbers that the recipient can use. recordVoicePrint: Reserved for DocuSign. validateRecipProvidedNumber: Reserved for DocuSign.

Describes the recipient phone number.

This request object contains the information necessary to create a recipient preview.

The proof file of the recipient. ID Evidence uses proof files to store the identification data that recipients submit when verifying their ID with ID Verification

Describes the recipient routing rules.

Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.

An Electronic or Standards Based Signature (digital signature) provider for the signer to use. More information.

Option settings for the signature provider. Different providers require or use different options. The current provider list and the options they require.

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

The recipient details that are returned after you update the recipient.

The request body for the EnvelopeViews: createRecipient and EnvelopeViews: createSharedRecipient methods.

Specifies the envelope recipients.

This is the response that the API returns after you update recipients.

A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DocuSign use only.

A complex element that specifies reminder settings for the envelope.

Request logs

API resource information

This resource is used to create a responsive preview of all of the documents in an envelope.

The request body for the TemplateViews: createEdit method.

A complex element that specifies the scheduled sending settings for the envelope.

Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow. Example: json "recipients": { "seals": [ { "recipientId": "1", "routingOrder" : 1, "recipientSignatureProviders": [ { "sealName": "52e9d968-xxxx-xxxx-xxxx-4682bc45c106" } ] } ] }, . . . For more information about Electronic Seals, see Apply Electronic Seals to Your Documents.

This object contains information about a seat discount.

Contains the settings for the email notifications that senders receive about the envelopes that they send.

API service information

Metadata that indicates whether a property is editable and describes setting-specific options.

Information about the shared item.

A tab that allows the recipient to sign a document. May be optional.

Contains additional information that a specific signature provider requires.

This object contains information about the type of signature.

A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document.

A tab that allows the recipient to attach supporting documents to an envelope.

An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account email notification settings when the user is created.

Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature.

Signing groups' users

Signing groups

These properties define how a Smart Section displays. A Smart Section is a type of display section.

A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information.

A list of supported languages.

Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients.

Reserved for DocuSign.

A template custom field enables you to prepopulate custom metadata for all new envelopes that are created by using a specific template. You can then use the custom data for sorting, organizing, searching, and other downstream processes.

Template document fields

This resource is used to create a responsive preview of a specific template document.

Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms. Note: Before you use Document Visibility, you should be aware of the following information: - Document Visibility must be enabled for your account by your DocuSign administrator. - A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. - When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images. - Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template. The Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see Use Document Visibility to Control Recipient Access.

A list of documentVisibility objects that specify whether the documents associated with a template are visible to recipients.

Template documents

This section provides information about template locks. You use template locks to prevent others from making changes to a template while you are modifying it.

Template tabs

Template recipients

This resource is used to create a responsive preview of all of the documents associated with a template.

Information about a specific role.

Information about shared templates.

Summary of a template request.

A TemplateView contains a URL that you can embed in your application to generate a template view that uses the DocuSign user interface (UI).

Template management

A tab that allows the recipient to enter any type of text.

This object represents a free text custom field where envelope creators and senders can enter custom data.

A tab that displays the recipient's title.

A complex element consisting of: lastSentDateTime - the date and time the user last sent an envelope. lastSignedDateTime - the date and time the user last signed an envelope. sentCount - the number of envelopes the user has sent. signedCount - the number of envelopes the user has signed.

Describes which account management capabilities a user has.

Users' custom settings

User information.

Contains a list of account users.

Contains details about the password rules for a user.

Users' profiles

Properties that configure the settings for a user. Some elements of this object have a metadata property, which includes the following: - rights: The calling users permissions to edit this setting (can be editable or read_only) - uiHint: Internally used to build UIs (can be available or hidden) - options: The values supported for this setting (not all settings have this element)

Information about a shared item.

Users' signatures

The Users resource enables you to create and manage account users.

This tab is used with the Approve tab to handle supplemental documents.

A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.

Describes the workflow for an envelope.

Describes a single step in a workflow.

A DocuSign workspace is a collaboration area for sharing files and data.

This object's properties describe the contents of a workspace folder.

This object represents an item in a workspace, which can be either a file or folder.

An array of objects that describe the items in a workspace.

This object contains information about a file or folder in a workspace.

This object contains a list of available workspaces.

This object provides information about the settings for the workspace.

This object represents the workspace user. This property is only returned in response to user specific GET call.

Provides properties that describe user authorization to a workspace.

A DocuSign workspace is a collaboration area for sharing files and data.

A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.

This module defines the behaviour of the OAuth adapter.

Fake OAuth implementation mainly for test environment.

This module implements the OAuth behaviour and an oauth2 strategy for DocuSign.

Helper functions for building Tesla requests

This module contains the User struct and functions for working with it.

Crypto functions for DocuSign HMAC signature validation.

Webhook handler behaviour.

Helper Plug to process webhook events and send them to a custom handler.