openapi.city
Sign in

DocuSign

Electronic signature and agreement platform

developers.docusign.com ↗
Version
v2.1
OpenAPI
3.0.0
Endpoints
402
Schemas
598
91
Quality
Updated
3 days ago
Documents documents signatures legal
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://www.docusign.net/restapi

Endpoints

Clear filters
GET POST PUT PATCH DELETE

Accountbrands 6 endpoints

GET /v2.1/accounts/{accountId}/brands

This method returns details about all of the brands associated with an account,
including the default brand profiles.

Either or both of the following settings must be enabled for the account to use this method:

  • canSelfBrandSign
  • canSelfBrandSend

Related topics

operationId: Brands_GetBrands

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
exclude_distributor_brand query optional string

When true, excludes distributor brand information from the response set.
include_logos query optional string

When true, returns the logos associated with the brand.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/brands
GET /v2.1/accounts/{accountId}/brands/{brandId}

This method returns details about an account brand.

Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

operationId: Brand_GetBrand

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
brandId path required string

The ID of the brand.
include_external_references query optional string

When true, the landing pages and links associated with the brand are included in the response.
include_logos query optional string

When true, the URIs for the logos associated with the brand are included in the response.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/brands/{brandId}
GET /v2.1/accounts/{accountId}/brands/{brandId}/file

This method exports information about a brand to an XML file.

Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

operationId: BrandExport_GetBrandExportFile

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
brandId path required string

The ID of the brand.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/brands/{brandId}/file
GET /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}

This method returns a specific logo that is used in a brand.

Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

operationId: BrandLogo_GetBrandLogo

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
brandId path required string

The ID of the brand.
logoType path required string

The type of logo. Valid values are:

  • primary
  • secondary
  • email

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}
GET /v2.1/accounts/{accountId}/brands/{brandId}/resources

This method returns metadata about the branding resources that are associated with an account.

Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

operationId: BrandResources_GetBrandResourcesList

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
brandId path required string

The ID of the brand.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/brands/{brandId}/resources
GET /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}

This method returns a specific branding resource file.

A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.

Important: When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.

Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

operationId: BrandResources_GetBrandResources

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
brandId path required string

The ID of the brand.
resourceContentType path required string

The type of brand resource file to return. Valid values are:

  • sending
  • signing
  • email
  • signing_captive
langcode query optional string

The ISO 3166-1 alpha-2 codes for the languages that the brand supports.
return_master query optional string

Specifies which resource file data to return. When true, only the master resource file is returned. When false, only the elements that you modified are returned.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}

Accountconsumerdisclosures 2 endpoints

GET /v2.1/accounts/{accountId}/consumer_disclosure

Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account.

This is the default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.

To set the language of the disclosure that you want to retrieve, use the optional langCode query parameter.

operationId: ConsumerDisclosure_GetConsumerDisclosure

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
langCode query optional string

The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:

  • Arabic (ar)
  • Bulgarian (bg)
  • Czech (cs)
  • Chinese Simplified (zh_CN)
  • Chinese Traditional (zh_TW)
  • Croatian (hr)
  • Danish (da)
  • Dutch (nl)
  • English US (en)
  • English UK (en_GB)
  • Estonian (et)
  • Farsi (fa)
  • Finnish (fi)
  • French (fr)
  • French Canadian (fr_CA)
  • German (de)
  • Greek (el)
  • Hebrew (he)
  • Hindi (hi)
  • Hungarian (hu)
  • Bahasa Indonesian (id)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Latvian (lv)
  • Lithuanian (lt)
  • Bahasa Melayu (ms)
  • Norwegian (no)
  • Polish (pl)
  • Portuguese (pt)
  • Portuguese Brazil (pt_BR)
  • Romanian (ro)
  • Russian (ru)
  • Serbian (sr)
  • Slovak (sk)
  • Slovenian (sl)
  • Spanish (es)
  • Spanish Latin America (es_MX)
  • Swedish (sv)
  • Thai (th)
  • Turkish (tr)
  • Ukrainian (uk)
  • Vietnamese (vi)

Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to browser.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/consumer_disclosure
GET /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}

Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account.

To set the language of the disclosure that you want to retrieve, use the optional langCode query parameter.

Note: The text of the default disclosure is always in English, but if you are using a custom disclosure and have created versions of it in different signer languages, you can use the langCode parameter to specify the signer language version that you want to retrieve.

operationId: ConsumerDisclosure_GetConsumerDisclosureLangCode

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
langCode path required string

The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:

  • Arabic (ar)
  • Bulgarian (bg)
  • Czech (cs)
  • Chinese Simplified (zh_CN)
  • Chinese Traditional (zh_TW)
  • Croatian (hr)
  • Danish (da)
  • Dutch (nl)
  • English US (en)
  • English UK (en_GB)
  • Estonian (et)
  • Farsi (fa)
  • Finnish (fi)
  • French (fr)
  • French Canadian (fr_CA)
  • German (de)
  • Greek (el)
  • Hebrew (he)
  • Hindi (hi)
  • Hungarian (hu)
  • Bahasa Indonesian (id)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Latvian (lv)
  • Lithuanian (lt)
  • Bahasa Melayu (ms)
  • Norwegian (no)
  • Polish (pl)
  • Portuguese (pt)
  • Portuguese Brazil (pt_BR)
  • Romanian (ro)
  • Russian (ru)
  • Serbian (sr)
  • Slovak (sk)
  • Slovenian (sl)
  • Spanish (es)
  • Spanish Latin America (es_MX)
  • Swedish (sv)
  • Thai (th)
  • Turkish (tr)
  • Ukrainian (uk)
  • Vietnamese (vi)

Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to browser.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}

Accountcustomfields 1 endpoints

GET /v2.1/accounts/{accountId}/custom_fields

This method returns a list of the envelope and document custom fields associated with an account.

operationId: AccountCustomFields_GetAccountCustomFields

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/custom_fields

Accountpasswordrules 2 endpoints

GET /v2.1/accounts/{accountId}/settings/password_rules

This method retrieves the password rules for an account.

operationId: AccountPasswordRules_GetAccountPasswordRules

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/settings/password_rules
GET /v2.1/current_user/password_rules
operationId: PasswordRules_GetPasswordRules

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/current_user/password_rules

Accountpermissionprofiles 2 endpoints

GET /v2.1/accounts/{accountId}/permission_profiles

This method returns a list of permission profiles that are associated with an account.

Example:

{
  "permissionProfiles": [
    {
      "permissionProfileId": "1665536",
      "permissionProfileName": "Account Administrator",
      "modifiedDateTime": "2018-03-26T03:54:40.4470000Z",
      "modifiedByUsername": ""
    },
    {
      "permissionProfileId": "1665537",
      "permissionProfileName": "DocuSign Sender",
      "modifiedDateTime": "2018-03-26T03:54:40.4470000Z",
      "modifiedByUsername": ""
    },
    {
      "permissionProfileId": "1665538",
      "permissionProfileName": "DocuSign Viewer",
      "modifiedDateTime": "2016-06-02T01:53:15.6830000Z",
      "modifiedByUsername": ""
    },
    {
      "permissionProfileId": "10325926",
      "permissionProfileName": "DS Manage Company Member Accounts",
      "modifiedDateTime": "2020-05-15T00:28:36.8230000Z",
      "modifiedByUsername": "Nat Irving"
    }
  ]
}
operationId: PermissionProfiles_GetPermissionProfiles

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
include query optional string

A comma-separated list of additional properties to return in the response. Valid values are:

  • user_count: The total number of users associated with the permission profile.
  • closed_users: Includes closed users in the user_count.
  • account_management: The account management settings.
  • metadata: Metadata indicating whether the properties associated with the account permission profile are editable.

Example: user_count,closed_users

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/permission_profiles
GET /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}

This method returns information about a specific permission profile that is associated with an account.

Related topics

operationId: PermissionProfiles_GetPermissionProfile

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
permissionProfileId path required string

The ID of the permission profile.

Use AccountPermissionProfiles: list
to get a list of permission profiles and their IDs.

You can also download a CSV file of all permission profiles
and their IDs from the Settings > Permission Profiles page
of your eSignature account page.
include query optional string

A comma-separated list of additional properties to return in the response. The only valid value for this request is metadata, which returns metadata indicating whether the properties associated with the account permission profile are editable.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}

Accountsealproviders 1 endpoints

GET /v2.1/accounts/{accountId}/seals
operationId: AccountSignatureProviders_GetSealProviders

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/seals

Accountsignatureproviders 1 endpoints

GET /v2.1/accounts/{accountId}/signatureProviders

Returns a list of signature providers that the specified account can use.

operationId: AccountSignatureProviders_GetSignatureProviders

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/signatureProviders

Accountsignatures 3 endpoints

GET /v2.1/accounts/{accountId}/signatures

Returns a list of stamps available in the account.

operationId: AccountSignatures_GetAccountSignatures

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
stamp_format query optional string

The format of the stamp to return. Valid values:

  • NameDateHanko
  • NameHanko
  • PlaceholderHanko
stamp_name query optional string

The name associated with the stamps to return. This value can be a Japanese surname (up to 5 characters) or a purchase order ID.
stamp_type query optional string

The type of the stamps to return. Valid values:

  • name_stamp
  • stamp
  • signature

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/signatures
GET /v2.1/accounts/{accountId}/signatures/{signatureId}

Returns information about the specified stamp.

operationId: AccountSignatures_GetAccountSignature

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
signatureId path required string

The ID of the account stamp.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/signatures/{signatureId}
GET /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}

Returns the image for an account stamp.

operationId: AccountSignatures_GetAccountSignatureImage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
imageType path required string

Specificies the type of image. Valid values:

  • stamp_image
  • signature_image
  • initials_image
signatureId path required string

The ID of the account stamp.
include_chrome query optional string

When true, the chrome (or frame containing the added line and identifier) is included with the signature image.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}

Accounttabsettings 1 endpoints

GET /v2.1/accounts/{accountId}/settings/tabs

This method returns information about the tab types and tab functionality that is currently enabled for an account.

operationId: TabSettings_GetTabSettings

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/settings/tabs

Accountwatermarks 1 endpoints

GET /v2.1/accounts/{accountId}/watermark

Enables you to preview a watermark specified by the request.

operationId: Watermark_GetWatermark

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/watermark

Accounts 10 endpoints

GET /v2.1/accounts/provisioning

Retrieves the account provisioning information for the account.

operationId: Accounts_GetProvisioning

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/provisioning
GET /v2.1/accounts/{accountId}

Retrieves the account information for the specified account.

operationId: Accounts_GetAccount

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
include_account_settings query optional string

When true, includes account settings in the response. The default value is false.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}
GET /v2.1/accounts/{accountId}/billing_charges

Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items.

Privileges required: account administrator

operationId: BillingCharges_GetAccountBillingCharges

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
include_charges query optional string

Specifies which billing charges to return.
Valid values are:

  • envelopes
  • seats

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/billing_charges
GET /v2.1/accounts/{accountId}/recipient_names

Retrieves a list of all of the names associated with the email address that you pass in. This list can include variants of a single recipient’s name that are used for signing, as well as the names of multiple different recipients.

operationId: RecipientNames_GetRecipientNames

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
email query optional string

(Required) The email address for which you want to retrieve recipient names.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/recipient_names
GET /v2.1/accounts/{accountId}/settings

Retrieves the account settings information for the specified account.

operationId: Settings_GetSettings

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/settings
GET /v2.1/accounts/{accountId}/settings/envelope_purge_configuration

An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (retentionDays). This method retrieves the current envelope purge configuration for your account.

Note: To use this method, you must be an account administrator.

operationId: EnvelopePurgeConfiguration_GetEnvelopePurgeConfiguration

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/settings/envelope_purge_configuration
GET /v2.1/accounts/{accountId}/settings/notification_defaults

This method returns the default settings for the email notifications that signers and senders receive about envelopes.

operationId: NotificationDefaults_GetNotificationDefaults

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/settings/notification_defaults
GET /v2.1/accounts/{accountId}/shared_access

Retrieves shared item status for one or more users and types of items.

Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves, and the returned information is limited to retrieving the status of the members of the account that are sharing their folders to the user. This is equivalent to setting the shared parameter to shared_from.

Note: This endpoint returns the shared status for the legacy Shared Envelopes feature. To use the new Shared Access feature, use the Authorizations resource.

operationId: SharedAccess_GetSharedAccess

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Default: 1000
envelopes_not_shared_user_status query optional string

This query parameter works in conjunction with user_ids. When you specify one of the following user statuses, the query limits the results to only users that match the specified status:

  • ActivationRequired: Membership Activation required
  • ActivationSent: Membership activation sent to user
  • Active: User Membership is active
  • Closed: User Membership is closed
  • Disabled: User Membership is disabled
folder_ids query optional string

A comma-separated list of folder IDs for which to return shared item information. If item_type is set to folders, at least one folder ID is required.
item_type query optional string

Specifies the type of shared item being requested. Valid values:

  • envelopes: Get information about envelope sharing between users.
  • templates: Get information about template sharing among users and groups.
  • folders: Get information about folder sharing among users and groups.
search_text query optional string

Filter user names based on the specified string. The wild-card ‘*’ (asterisk) can be used in the string.
shared query optional string

A comma-separated list of sharing filters that specifies which users appear in the response.

  • not_shared: The response lists users who do not share items of item_type with the current user.

  • shared_to: The response lists users in user_list who are sharing items to current user.

  • shared_from: The response lists users in user_list who are sharing items from the current user.

  • shared_to_and_from: The response lists users in user_list who are sharing items to and from the current user.

If the current user does not have administrative privileges, only the shared_to option is valid.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.
user_ids query optional string

A comma-separated list of user IDs for whom the shared item information is being requested.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/shared_access
GET /v2.1/accounts/{accountId}/supported_languages

Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient.

For example, in the recipient’s email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.

Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the emailBody and emailSubject of the notification is not translated, and appears exactly as you enter it.

For more information, see Set Recipient Language and Specify Custom Email Messages.

operationId: SupportedLanguages_GetSupportedLanguages

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/supported_languages
GET /v2.1/accounts/{accountId}/unsupported_file_types

Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.

operationId: UnsupportedFileTypes_GetUnsupportedFileTypes

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/unsupported_file_types

Authorizations 3 endpoints

GET /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}

Returns the details for the user authorization specified by the authorizationId.

To call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.

operationId: UserAuthorization_GetUserAuthorization

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
authorizationId path required string

The ID of the user authorization.
userId path required string

The ID of the principal user.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}
GET /v2.1/accounts/{accountId}/users/{userId}/authorizations

Returns the user authorizations for which the user specified by userId is the principal user.

To call this endpoint, you must be an account administrator or you must be the specified principal user.

operationId: UserAuthorizations_GetPrincipalUserAuthorizations

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
userId path required string

The ID of the principal user.
active_only query optional string

When true, return only active authorizations. The default value is true.
count query optional string

The maximum number of results to return.
email_substring query optional string

Filters returned user records by full email address or a substring of email address.
include_closed_users query optional string

When true, returns active and scheduled authorizations of closed users. The default value is true. This value is only applied when active_only is false.
permissions query optional string

Filters results by authorization permission. Valid values:

  • Send
  • Manage
  • Sign
start_position query optional string

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
user_name_substring query optional string

Filters results based on a full or partial user name.

Note: When you enter a partial user name, you do not use a wildcard character.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/authorizations
GET /v2.1/accounts/{accountId}/users/{userId}/authorizations/agent

Returns the user authorizations for which the user specified by userId is the agent user.

If the calling user is an account administrator, the full results will be returned. Otherwise, only authorizations for which the calling user is the principal user will be returned.

operationId: UserAgentAuthorizations_GetAgentUserAuthorizations

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
userId path required string

The user who is acting as the agent.
active_only query optional string

When true, only active users are returned. The default value is false.
count query optional string

The maximum number of results to return.
email_substring query optional string

Filters returned user records by full email address or a substring of email address.
include_closed_users query optional string

When true, returns active and scheduled authorizations of closed users. The default value is true. This value is only applied when active_only is false.
permissions query optional string —
start_position query optional string

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
user_name_substring query optional string

Filters results based on a full or partial user name.

Note: When you enter a partial user name, you do not use a wildcard character.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/authorizations/agent

Bccemailarchive 2 endpoints

GET /v2.1/accounts/{accountId}/settings/bcc_email_archives

This method retrieves all of the BCC email archive configurations associated with an account.

operationId: BCCEmailArchive_GetBCCEmailArchiveList

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/settings/bcc_email_archives
GET /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}

This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.

operationId: BCCEmailArchive_GetBCCEmailArchiveHistoryList

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
bccEmailArchiveId path required string

The ID of the BCC email archive configuration.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of items to skip.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}

Billingplans 5 endpoints

GET /v2.1/accounts/{accountId}/billing_plan

Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.

By default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to false.

Response

The response returns the billing plan information, including the currency code, for the plan. The billingPlan and succesorPlans property values are the same as those shown in the Billing: getBillingPlan reference. the billingAddress and creditCardInformation property values are the same as those shown in the Billing: updatePlan reference.

Note: When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.

operationId: BillingPlan_GetBillingPlan

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
include_credit_card_information query optional string

When true, payment information including credit card information will show in the return.
include_downgrade_information query optional string —
include_metadata query optional string

When true, the canUpgrade and renewalStatus properties are included the response and an array of supportedCountries is added to the billingAddress information.
include_successor_plans query optional string

When true, excludes successor information from the response.
include_tax_exempt_id query optional string —

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/billing_plan
GET /v2.1/accounts/{accountId}/billing_plan/credit_card

This method returns information about a credit card associated with an account.

operationId: BillingPlan_GetCreditCardInfo

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/billing_plan/credit_card
GET /v2.1/accounts/{accountId}/billing_plan/downgrade
operationId: BillingPlan_GetDowngradeRequestBillingInfo

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/billing_plan/downgrade
GET /v2.1/billing_plans

Retrieves a list of the billing plans associated with a distributor.

operationId: BillingPlans_GetBillingPlans

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/billing_plans
GET /v2.1/billing_plans/{billingPlanId}

Retrieves the billing plan details for the specified billing plan ID.

operationId: BillingPlans_GetBillingPlan

Parameters

Name In Required Type Description
billingPlanId path required string

The ID of the billing plan being accessed.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/billing_plans/{billingPlanId}

Bulksend 5 endpoints

GET /v2.1/accounts/{accountId}/bulk_send_batch

Returns a summary of bulk send batches.

Use the batch_ids query parameter to narrow the list of batches.

operationId: BulkSendV2Batch_GetBulkSendBatches

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
batch_ids query optional string

A comma-separated list of batch IDs to query.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Valid values: 1 to 100

Default: 100
from_date query optional string

The start date for a date range in UTC DateTime format.

Note: If this property is null, no date filtering is applied.
search_text query optional string

Use this parameter to search for specific text.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.
status query optional string

The kind of results to collect. Must be one of:

  • all
  • failed
  • sent
  • queued
to_date query optional string

The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.

Note: If this property is null, the value defaults to the current date.
user_id query optional string —

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/bulk_send_batch
GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}

Gets the general status of a specific bulk send batch such as:

  • number of successes
  • number pending
  • number of errors

The bulkErrors property of the response object contains more information about the errors.

Related topics

operationId: BulkSendV2Batch_GetBulkSendBatchStatus

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
bulkSendBatchId path required string

The batch ID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}
GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes

This method returns a list of envelopes in a specified bulk batch. Use the query parameters to filter and sort the envelopes by different attributes.

operationId: BulkSendV2Envelopes_GetBulkSendBatchEnvelopes

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
bulkSendBatchId path required string

The batch ID.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Valid values: 1 to 1000
include query optional string

When recipients, only envelopes with recipient nodes will be included in the response.
order query optional string

The order in which to sort the results. Valid values are:

  • Descending order: desc (default)
  • Ascending order: asc
order_by query optional string

The envelope attribute used to sort the results. Valid values are:

  • created (default)
  • completed
  • last_modified
  • sent
  • status
  • subject
  • status_changed
search_text query optional string

Use this parameter to search for specific text.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.
status query optional string

Comma-separated list of envelope statuses.

Note that any should not be included with other statuses. In other words, any is a valid parameter value, but any,sent is not.

Use the value deliveryfailure to get all envelopes with AuthFailed and AutoResponded status. This value is specific to bulk sending.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes
GET /v2.1/accounts/{accountId}/bulk_send_lists

This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list.

operationId: BulkSendV2CRUD_GetBulkSendLists

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/bulk_send_lists
GET /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}

This method returns all of the details associated with a specific bulk send list that belongs to the current user.

operationId: BulkSendV2CRUD_GetBulkSendList

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
bulkSendListId path required string

The GUID of the bulk send list. This property is created after you post a new bulk send list.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}

Chunkeduploads 1 endpoints

GET /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}

Returns the details (but not the content) about a chunked upload.

Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.

operationId: ChunkedUploads_GetChunkedUpload

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
chunkedUploadId path required string

The ID of the chunked upload.
include query optional string

(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is checksum, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}

Cloudstorage 2 endpoints

GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders

Retrieves a list of all the items in a specified folder from the specified cloud storage provider.

operationId: CloudStorageFolder_GetCloudStorageFolderAll

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
serviceId path required string

The ID of the service to access.

Valid values are the service name (“Box”) or the numerical serviceId (“4136”).
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.
cloud_storage_folder_path query optional string

A comma separated list of folder IDs included in the request.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Default: 25
order query optional string

The order in which to sort the results.

Valid values are:

  • asc: Ascending order.
  • desc: Descending order.
order_by query optional string

The file attribute to use to sort the results.

Valid values are:

  • modified
  • name
search_text query optional string

Use this parameter to search for specific text.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders
GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}

Retrieves a list of the user’s items from the specified cloud storage provider.

To limit the scope of the items returned, provide a comma-separated list of folder IDs in the request.

operationId: CloudStorageFolder_GetCloudStorageFolder

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
folderId path required string

The ID of the folder.
serviceId path required string

The ID of the service to access.

Valid values are the service name (“Box”) or the numerical serviceId (“4136”).
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.
cloud_storage_folder_path query optional string

The file path to a cloud storage folder.
cloud_storage_folderid_plain query optional string

A plain-text folder ID that you can use as an alternative to the existing folder id. This property is mainly used for rooms. Enter multiple folder IDs as a comma-separated list.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Default: 25
order query optional string

The order in which to sort the results.

Valid values are:

  • asc: Ascending order.
  • desc: Descending order.
order_by query optional string

The file attribute to use to sort the results.

Valid values are:

  • modified
  • name
search_text query optional string

Use this parameter to search for specific text.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}

Cloudstorageproviders 2 endpoints

GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage

Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

operationId: CloudStorage_GetCloudStorageProviders

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.
redirectUrl query optional string

The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.

The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage
GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}

Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

operationId: CloudStorage_GetCloudStorage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
serviceId path required string

The ID of the service to access.

Valid values are the service name (“Box”) or the numerical serviceId (“4136”).
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.
redirectUrl query optional string

The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.

The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}

Comments 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript

Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.

The response body of this method is the PDF file as a byte
stream.

Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the accountSettingsInformation object, set the enableSigningExtensionComments property to true).

operationId: Comments_GetCommentsTranscript

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
encoding query optional string

(Optional) The encoding to use for the file.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript

Connectconfigurations 5 endpoints

GET /v2.1/accounts/{accountId}/connect

Retrieves all the DocuSign Custom Connect definitions for the specified account.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

operationId: Connect_GetConnectConfigs

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/connect
GET /v2.1/accounts/{accountId}/connect/oauth

Gets the Connect OAuth configuration for the specified account.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Related topics:

operationId: ConnectOAuthConfig_GetConnectOAuthConfig

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/connect/oauth
GET /v2.1/accounts/{accountId}/connect/{connectId}

Retrieves the information for the specified DocuSign Connect configuration.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

operationId: Connect_GetConnectConfig

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
connectId path required string

The ID of the custom Connect configuration being accessed.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/connect/{connectId}
GET /v2.1/accounts/{accountId}/connect/{connectId}/all/users

Returns all users from the configured Connect service.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

operationId: Connect_GetConnectAllUsers

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
connectId path required string

The ID of the custom Connect configuration being accessed.
count query optional string

The maximum number of results to return.
domain_users_only query optional string —
email_substring query optional string

Filters returned user records by full email address or a substring of email address.
start_position query optional string

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
status query optional string

The status of the item.
user_name_substring query optional string

Filters results based on a full or partial user name.

Note: When you enter a partial user name, you do not use a wildcard character.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/connect/{connectId}/all/users
GET /v2.1/accounts/{accountId}/connect/{connectId}/users

Returns users from the configured Connect service.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

operationId: Connect_GetConnectUsers

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
connectId path required string

The ID of the custom Connect configuration being accessed.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.
email_substring query optional string

Filters returned user records by full email address or a substring of email address.
list_included_users query optional string —
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.
status query optional string

Filters the results by user status.
You can specify a comma-separated
list of the following statuses:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
user_name_substring query optional string

Filters results based on a full or partial user name.

Note: When you enter a partial user name, you do not use a wildcard character.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/connect/{connectId}/users

Connectevents 3 endpoints

GET /v2.1/accounts/{accountId}/connect/failures

Retrieves the Connect failure log information. You can use this log to determine which envelopes failed to post, in order to create a republish request.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

operationId: ConnectFailures_GetConnectLogs

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
from_date query optional string

The start date for a date range in UTC DateTime format.

Note: If this property is null, no date filtering is applied.
to_date query optional string

The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.

Note: If this property is null, the value defaults to the current date.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/connect/failures
GET /v2.1/accounts/{accountId}/connect/logs

Retrieves a list of the 100 most recent Connect log entries for your account.

The enableLog setting in the Connect configuration must be set to true to enable logging. Log entries are deleted after 15 days.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

operationId: ConnectLog_GetConnectLogs

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
from_date query optional string

The start date for a date range in UTC DateTime format.

Note: If this property is null, no date filtering is applied.
to_date query optional string

The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.

Note: If this property is null, the value defaults to the current date.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/connect/logs
GET /v2.1/accounts/{accountId}/connect/logs/{logId}

Retrieves the specified Connect log entry for your account.

The enableLog setting in the Connect configuration must be set to true to enable logging.
If logging is not enabled, then no log entries are recorded.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

operationId: ConnectLog_GetConnectLog

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
logId path required string

The ID of the Connect log entry.
additional_info query optional string

When true, the response includes the connectDebugLog information.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/connect/logs/{logId}

Contacts 1 endpoints

GET /v2.1/accounts/{accountId}/contacts/{contactId}

This method returns one or more contacts
associated with a DocuSign account. You can also
retrieve contacts from connected cloud storage providers by using the
cloud_provider query parameter. By default,
contacts are retrieved from the DocuSign account’s
default address book.

To return a specific contact, use the contactId
query parameter. To return all contacts associated
with an account, omit this parameter.

operationId: Contacts_GetContactById

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
contactId path required string

The ID of a contact person in the account’s address book.

Note: To return all contacts, omit this parameter. It is not required.
cloud_provider query optional string

(Optional) The cloud provider from which to retrieve the contacts. Valid values are:

  • rooms
  • docusignCore (default)

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/contacts/{contactId}

Customtabs 2 endpoints

GET /v2.1/accounts/{accountId}/tab_definitions

Retrieves a list of all tabs associated with the account.

operationId: Tabs_GetTabDefinitions

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
custom_tab_only query optional string

When true, only custom tabs are returned in the response.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/tab_definitions
GET /v2.1/accounts/{accountId}/tab_definitions/{customTabId}

Retrieves information about the requested custom tab on the specified account.

operationId: Tab_GetCustomTab

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
customTabId path required string

The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/tab_definitions/{customTabId}

Documentgeneration 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields

Given an envelopeId this method
returns the form fields found in
that envelope’s documents.

The response for envelope that has one document
with form fields would look like this:

{
  "docGenFormFields": [
    {
      "documentId": "2dc54cf5-xxxx-xxxx-xxxx-05132a2dd889",
      "docGenFormFieldList": [
        {
          "label": "Candidate_Name",
          "type": "TextBox",
          "required": "True",
          "name": "Candidate_Name"
        },
        {
          "label": "Job_Title",
          "type": "TextBox",
          "required": "True",
          "name": "Job_Title"
        },
        {
          "label": "Manager_Name",
          "type": "TextBox",
          "required": "True",
          "name": "Manager_Name"
        },
        {
          "label": "Start_Date",
          "type": "TextBox",
          "required": "True",
          "name": "Start_Date"
        },
        {
          "label": "Salary",
          "type": "TextBox",
          "required": "True",
          "name": "Salary"
        }
      ],
      "docGenDocumentStatus": "created"
    }
  ]
}

Related topics

operationId: DocGenFormFields_GetEnvelopeDocGenFormFields

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields

Enoteconfigurations 1 endpoints

GET /v2.1/accounts/{accountId}/settings/enote_configuration
operationId: ENoteConfiguration_GetENoteConfiguration

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/settings/enote_configuration

Envelopeattachments 2 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments

Returns a list of envelope attachments associated with a specified envelope.

It's easy to confuse envelope attachments, which are developer-only files associated with an envelope, with signer attachments. To get a list of user-visible attachments, use [EnvelopeDocuments: get](https://raw.githubusercontent.com). To learn about the different types of attachments, see [Attachments](https://raw.githubusercontent.com) in the concept guide.
operationId: Attachments_GetAttachments

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}

Retrieves an envelope attachment from an envelope.

It's easy to confuse envelope attachments, which are developer-only files associated with an envelope, with signer attachments. To learn about the different types of attachments, see [Attachments](https://raw.githubusercontent.com) in the concept guide.
operationId: Attachments_GetAttachment

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
attachmentId path required string

The unique identifier for the attachment.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}

Envelopeconsumerdisclosures 2 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure

Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify.

This is the default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.

To set the language of the disclosure that you want to retrieve, use the optional langCode query parameter.

operationId: ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientId

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
recipientId path required string

A local reference used to map
recipients to other objects, such as specific
document tabs.

A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.

For example, many envelopes assign the first recipient
a recipientId of 1.
langCode query optional string

(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:

  • Arabic (ar)
  • Bulgarian (bg)
  • Czech (cs)
  • Chinese Simplified (zh_CN)
  • Chinese Traditional (zh_TW)
  • Croatian (hr)
  • Danish (da)
  • Dutch (nl)
  • English US (en)
  • English UK (en_GB)
  • Estonian (et)
  • Farsi (fa)
  • Finnish (fi)
  • French (fr)
  • French Canadian (fr_CA)
  • German (de)
  • Greek (el)
  • Hebrew (he)
  • Hindi (hi)
  • Hungarian (hu)
  • Bahasa Indonesian (id)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Latvian (lv)
  • Lithuanian (lt)
  • Bahasa Melayu (ms)
  • Norwegian (no)
  • Polish (pl)
  • Portuguese (pt)
  • Portuguese Brazil (pt_BR)
  • Romanian (ro)
  • Russian (ru)
  • Serbian (sr)
  • Slovak (sk)
  • Slovenian (sl)
  • Spanish (es)
  • Spanish Latin America (es_MX)
  • Swedish (sv)
  • Thai (th)
  • Turkish (tr)
  • Ukrainian (uk)
  • Vietnamese (vi)

Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to browser.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}

Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient’s language settings.

To set the language of the disclosure that you want to retrieve, specify the langCode as either a path or query parameter.

operationId: ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientIdLangCode

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
langCode path required string

(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. The following languages are supported:

  • Arabic (ar)
  • Bulgarian (bg)
  • Czech (cs)
  • Chinese Simplified (zh_CN)
  • Chinese Traditional (zh_TW)
  • Croatian (hr)
  • Danish (da)
  • Dutch (nl)
  • English US (en)
  • English UK (en_GB)
  • Estonian (et)
  • Farsi (fa)
  • Finnish (fi)
  • French (fr)
  • French Canadian (fr_CA)
  • German (de)
  • Greek (el)
  • Hebrew (he)
  • Hindi (hi)
  • Hungarian (hu)
  • Bahasa Indonesian (id)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Latvian (lv)
  • Lithuanian (lt)
  • Bahasa Melayu (ms)
  • Norwegian (no)
  • Polish (pl)
  • Portuguese (pt)
  • Portuguese Brazil (pt_BR)
  • Romanian (ro)
  • Russian (ru)
  • Serbian (sr)
  • Slovak (sk)
  • Slovenian (sl)
  • Spanish (es)
  • Spanish Latin America (es_MX)
  • Swedish (sv)
  • Thai (th)
  • Turkish (tr)
  • Ukrainian (uk)
  • Vietnamese (vi)

Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to browser.
recipientId path required string

A local reference used to map
recipients to other objects, such as specific
document tabs.

A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.

For example, many envelopes assign the first recipient
a recipientId of 1.
langCode query optional string

(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following languages are supported:

  • Arabic (ar)
  • Bulgarian (bg)
  • Czech (cs)
  • Chinese Simplified (zh_CN)
  • Chinese Traditional (zh_TW)
  • Croatian (hr)
  • Danish (da)
  • Dutch (nl)
  • English US (en)
  • English UK (en_GB)
  • Estonian (et)
  • Farsi (fa)
  • Finnish (fi)
  • French (fr)
  • French Canadian (fr_CA)
  • German (de)
  • Greek (el)
  • Hebrew (he)
  • Hindi (hi)
  • Hungarian (hu)
  • Bahasa Indonesian (id)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Latvian (lv)
  • Lithuanian (lt)
  • Bahasa Melayu (ms)
  • Norwegian (no)
  • Polish (pl)
  • Portuguese (pt)
  • Portuguese Brazil (pt_BR)
  • Romanian (ro)
  • Russian (ru)
  • Serbian (sr)
  • Slovak (sk)
  • Slovenian (sl)
  • Spanish (es)
  • Spanish Latin America (es_MX)
  • Swedish (sv)
  • Thai (th)
  • Turkish (tr)
  • Ukrainian (uk)
  • Vietnamese (vi)

Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to browser.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}

Envelopecustomfields 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.

There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.

Related topics

operationId: CustomFields_GetCustomFields

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Envelopedocumentfields 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Retrieves the custom document field information from an existing envelope document.

operationId: DocumentFields_GetDocumentFields

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Envelopedocumenthtmldefinitions 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions

Retrieves the HTML definition used to generate a dynamically sized responsive document.

If the document was not created as a signable HTML document, this endpoint will return a 200-OK response and an empty JSON body.

Note: The documentId query parameter is a GUID value, not an integer document ID. If an invalid document ID is provided, this endpoint will return a 200-OK response and an empty JSON body.

Related topics

operationId: ResponsiveHtml_GetEnvelopeDocumentHtmlDefinitions

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The GUID of the document.

Example: c671747c-xxxx-xxxx-xxxx-4a4a48e23744
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions

Envelopedocumenttabs 2 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs

Returns the tabs from the page specified by pageNumber of the document specified by documentId in the
envelope specified by envelopeId.

operationId: Tabs_GetPageTabs

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
pageNumber path required string

The page number being accessed.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs

Returns the tabs on the document specified by documentId in the
envelope specified by envelopeId.

operationId: Tabs_GetDocumentTabs

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
include_metadata query optional string

When true, the response includes metadata indicating which properties are editable.
page_numbers query optional string

Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs.

Example: page_numbers=2,6

Note: You can only enter individual page numbers, and not a page range.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs

Envelopedocumentvisibility 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility

This method returns information about document visibility for a recipient.

operationId: Recipients_GetRecipientDocumentVisibility

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
recipientId path required string

A local reference used to map
recipients to other objects, such as specific
document tabs.

A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.

For example, many envelopes assign the first recipient
a recipientId of 1.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility

Envelopedocuments 2 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents

Retrieves a list of documents associated with the specified envelope.

Related topics

operationId: Documents_GetDocuments

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
documents_by_userid query optional string

When true, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.
include_docgen_formfields query optional string

Reserved for DocuSign.
include_metadata query optional string

When true, the response includes metadata that indicates which properties the sender can edit.
include_tabs query optional string

When true, information about the tabs, including prefill tabs, associated with the documents are included in the response.
recipient_id query optional string

Allows the sender to retrieve the documents as one of the recipients that they control. The documents_by_userid parameter must be set to false for this to work.
shared_user_id query optional string

The ID of a shared user that you want to impersonate in order to
retrieve their view of the list of documents. This parameter is
used in the context of a shared inbox (i.e., when you share
envelopes from one user to another through the DocuSign Admin console).

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}

Retrieves a single document or all documents from an envelope.

To retrieve a single document, provide the ID of the document in the documentId path parameter.
Alternatively, by setting the documentId parameter to special keyword values,
you can retrieve all the documents (as a combined PDF, portfolio PDF, or ZIP archive)
or just the certificate of completion. See the documentId description for how to retrieve each format.

The response body of this method
is a file. If you request multiple documents,
the result is a ZIP archive
that contains all of the documents.

In all other cases, the response is a PDF
file or PDF portfolio.

You can get the file name and document ID from the response’s Content-Disposition header:

Content-Disposition: file; filename="NDA.pdf"; documentid="1

By default, the response is the PDF file
as a byte stream.
For example a request/response in curl looks like this:

$ curl --request GET 'https://demo.docusign.net/restapi/v2/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1/' \
       --header 'Authorization: Bearer eyJ...bqg'


HTTP/1.1 200 OK
Content-Length: 167539
Content-Type: application/pdf
. . .
Content-Disposition: file; filename="Lorem_Ipsum.pdf"; documentid="1"
Date: Tue, 23 Aug 2022 01:13:15 GMT

%PDF-1.4
%˚¸˝˛
6 0 obj
<</Length 14>>stream
. . .

By using the Content-Transfer-Encoding
header in the request, you can obtain the PDF file
encoded in base64. The same curl request with
the base64 header would look like this:

$ curl --request GET 'https://demo.docusign.net/restapi/v2/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1/' \
       --header 'Authorization: Bearer eyJ...bqg' \
       --header 'Content-Transfer-Encoding: base64'


HTTP/1.1 200 OK
Content-Length: 223384
Content-Type: application/pdf
. . .
Content-Disposition: file; filename="Lorem_Ipsum.pdf"; documentid="1"
Content-Transfer-Encoding: base64
Date: Tue, 23 Aug 2022 01:12:30 GMT

JVBERi0xLjQKJfv8/f4KNiAwIG9iago8PC9MZW. . .==

(In an actual curl request you would use the --output switch to
save the byte stream into a file.)

Related topics

operationId: Documents_GetDocument

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The ID of the document to retrieve. Alternatively, you can use one of the following special keywords:

  • combined: Retrieves all of the documents as a single PDF file.
    When the query parameter certificate is true, the certificate of completion is included in the PDF file.
    When the query parameter certificate is false, the certificate of completion is not included in the PDF file.
  • archive: Retrieves a ZIP archive that contains all of the PDF documents and the certificate of completion.
  • certificate: Retrieves only the certificate of completion as a PDF file.
  • portfolio: Retrieves the envelope documents as a PDF portfolio.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
certificate query optional string

Used only when the documentId parameter is the special keyword combined.

When true, the certificate of completion is included in the combined PDF file.
When false, (the default) the certificate of completion is not included in the combined PDF file.
documents_by_userid query optional string

When true, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.
encoding query optional string

Reserved for DocuSign.
encrypt query optional string

When true, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign.
language query optional string

Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).
recipient_id query optional string

Allows the sender to retrieve the documents as one of the recipients that they control. The documents_by_userid parameter must be set to false for this functionality to work.
shared_user_id query optional string

The ID of a shared user that you want to impersonate in order to
retrieve their view of the list of documents. This parameter is
used in the context of a shared inbox (i.e., when you share
envelopes from one user to another through the DocuSign Admin console).
show_changes query optional string

When true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. The account must have the Highlight Data Changes feature enabled.
watermark query optional string

When true, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}

Envelopeemailsettings 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings

Retrieves the email override settings for the specified envelope.

operationId: EmailSettings_GetEmailSettings

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings

Envelopeformdata 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data

This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.

Note: To use this feature, the Sending Setting “Allow sender to download form data” must be enabled for the account.

Related topics

operationId: FormData_GetFormData

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data

Envelopehtmldefinitions 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions
operationId: ResponsiveHtml_GetEnvelopeHtmlDefinitions

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions

Envelopelocks 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock

Retrieves general information about an envelope lock.

The user requesting the information must be the same user
who locked the envelope.

You can use this method to recover the lock information,
including the lockToken,
for a locked envelope.
The X-DocuSign-Edit header is included in the response.

See EnvelopeLocks: create
for a description of the X-DocuSign-Edit header.

Related topics

operationId: Lock_GetEnvelopeLock

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock

Enveloperecipienttabs 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Retrieves information about the tabs associated
with a recipient. You can make a single API call
to get all the tab values and information from a
given, completed envelope in addition to draft
ones. Tab values can be retrieved by using the
EnvelopeRecipients:list method
with query parameter include_tabs set to true.

operationId: Recipients_GetRecipientTabs

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
recipientId path required string

A local reference used to map
recipients to other objects, such as specific
document tabs.

A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.

For example, many envelopes assign the first recipient
a recipientId of 1.
include_anchor_tab_locations query optional string

When true, all tabs with anchor tab properties are included in the response. The default value is false.
include_metadata query optional string

When true, the response includes metadata indicating which properties are editable.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Enveloperecipients 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients

Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values.

The currentRoutingOrder property of the response contains the routingOrder value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.

Related topics

operationId: Recipients_GetRecipients

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
include_anchor_tab_locations query optional string

When true and include_tabs value is set to true, all tabs with anchor tab properties are included in the response.
include_extended query optional string

When true, the extended properties are included in the response.
include_metadata query optional string

Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates).
include_tabs query optional string

When true, the tab information associated with the recipient is included in the response.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients

Envelopetemplates 2 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates

Retrieves the templates associated with a document in the specified envelope.

operationId: Templates_GetDocumentTemplates

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
include query optional string

A comma-separated list that limits the results.
Valid values are:

  • applied
  • matched

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates

This returns a list of the server-side templates, their name and ID, used in an envelope.

operationId: Templates_GetEnvelopeTemplates

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
include query optional string

The possible value is matching_applied, which returns template matching information for the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates

Envelopetransferrules 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/transfer_rules

This method retrieves a list of envelope transfer rules associated with an account.

Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.

operationId: EnvelopeTransferRules_GetEnvelopeTransferRules

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/transfer_rules

Envelopeworkflowdefinition 8 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow

Returns the workflow definition for the envelope specified by envelopeId. If the envelope does not have a workflow object, this method returns a 404.

operationId: EnvelopeWorkflowDefinitionV2_GetEnvelopeWorkflowDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending

Given a template and a workflow step, returns the scheduled sending rules for that workflow step.

Note: If the workflow step does not have a scheduled sending object, this method returns a 404.

operationId: EnvelopeWorkflowScheduledSending_GetEnvelopeScheduledSendingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}

Returns a workflow step specified by workflowStepId for an envelope specified by envelopeId.

operationId: EnvelopeWorkflowStep_GetEnvelopeWorkflowStepDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting

Given an envelope and a workflow step, returns the delayed routing rules for that workflow step.

Note: If the workflow step does not have a delayed routing object, this method returns a 404.

operationId: EnvelopeWorkflowDelayedRouting_GetEnvelopeDelayedRoutingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow

Returns the workflow definition for the template specified by templateId. If the template does not have a workflow object, this method returns a 404.

operationId: TemplateWorkflowDefinition_GetTemplateWorkflowDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending

Given a template specified by templateId, returns the scheduled sending rules for that template’s workflow object.

Note: If the template’s workflow does not have a scheduled sending object, this method returns a 404.

operationId: TemplateWorkflowScheduledSending_GetTemplateScheduledSendingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}

Returns a workflow step specified by workflowStepId for a template specified by templateId.

operationId: TemplateWorkflowStep_GetTemplateWorkflowStepDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting

Given a template and a workflow step, returns the delayed routing rules for that workflow step.

Note: If the workflow step does not have a delayed routing object, this method returns a 404.

operationId: TemplateWorkflowDelayedRouting_GetTemplateDelayedRoutingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting

Envelopes 9 endpoints

GET /v2.1/accounts/{accountId}/envelopes

This method lets you
search for envelopes
in your accounts.
A large set of filters let you narrow the scope of your search
by date,
by envelope ID,
or by status codes.
Your request must include one or more of the following parameters:

  • from_date
  • envelope_ids
  • transaction_ids
This method excludes envelopes older than six months.

To avoid unnecessary database queries, the DocuSign
signature platform first checks requests to ensure that the
filter set supplied does not result in a zero-size response
before querying the database.

For example, for a request with a from_to_status of
delivered and a current status of created,sent,
DocuSign will always return an empty list.
This is because the request translates to: find the
envelopes that were delivered between the from_date and
to_date dates that have a current status of created or
sent. Since an envelope that has been delivered can
never have a status of created or sent, a zero-size
response would be generated.
In this case, DocuSign does not query the database
and returns an empty list immediately.

Getting envelope status using transaction_ids is useful
for offline signing situations where it can be used
determine if an envelope was created or not. It can be used
for the cases where a network connection was lost, before
the envelope status could be returned.

The following table shows the valid current envelope
statuses (status parameter) for the different status
qualifiers (from_to_status parameter) in the request. If
the status and status qualifiers in the API request do not
contain any of the values shown in the Valid Current
Statuses column, then an empty list is returned.

Client applications should check that the statuses (status
parameter) they are requesting make sense for a given
from_to_status parameter value.

Status Qualifier
(from_to_status)		 Effective Status Qualifier Valid Current Statuses
any (changed) StatusChanged any, created, sent, delivered, signed, completed, declined, voided, deleted
created Created any, created, sent, delivered, signed, completed, declined, voided, deleted
sent Sent any, sent, delivered, signed, completed, declined, voided, deleted
delivered StatusChanged any, delivered, signed, completed, declined, voided, deleted
signed StatusChanged any, signed, completed, declined, voided, deleted
completed Completed any, completed, declined, voided, deleted
declined StatusChanged any, declined, voided, deleted
timedout
always return zero results		 StatusChanged any, voided, deleted
voided Voided any, voided, deleted
deleted StatusChanged any, deleted

Extraneous results

In some cases, a request for a specific envelope status will
include envelopes with additional statuses. For example, in
a request with a from_date of 2017-01-01, a to_date of
2017-01-07 and the status qualifier (from_to_status) set
to delivered, the response set might contain envelopes
that were created during that time period, but not delivered
during the time period. As a workaround, check the envelope
status values in the result set as needed.

Related topics

operationId: Envelopes_GetEnvelopes

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
ac_status query optional string

Specifies the Authoritative Copy Status for the envelopes. Valid values: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.
block query optional string

Reserved for DocuSign.
cdse_mode query optional string

Reserved for DocuSign.
continuation_token query optional string

Reserved for DocuSign.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.
custom_field query optional string

Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format: custom_envelope_field_name=desired_value

Example: If you have an envelope custom field named “Region” and you want to search for all envelopes where the value is “West” you would use set this parameter to Region=West.
email query optional string

Limit results to envelopes
sent by the account user
with this email address.

user_name must be given as well,
and both email and user_name
must refer to an existing account user.
envelope_ids query optional string

Comma separated list of envelopeId values.
exclude query optional string

Excludes information from the response. Enter as a comma-separated list (e.g., folders,powerforms). Valid values are:

  • recipients
  • powerforms
  • folders
folder_ids query optional string

Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder Guids or the following values:

  • awaiting_my_signature
  • completed
  • draft
  • drafts
  • expiring_soon
  • inbox
  • out_for_signature
  • recyclebin
  • sentitems
  • waiting_for_others
folder_types query optional string

A comma-separated list of folder types you want to retrieve envelopes from. Valid values are:

  • normal
  • inbox
  • sentitems
  • draft
  • templates
from_date query optional string

Specifies the date and time
to start looking for status changes.
This parameter is required
unless envelopeIds or transactionIds
are set.

Although you can use any date format
supported by the .NET system library’s
DateTime.Parse() function,
DocuSign recommends
using ISO 8601 format dates
with an explicit time zone offset
If you do not provide
a time zone offset,
the method uses the server’s time zone.

For example, the following dates and times refer to the same instant:

  • 2017-05-02T01:44Z
  • 2017-05-01T21:44-04:00
  • 2017-05-01T18:44-07:00
from_to_status query optional string

This is the status type checked for in the from_date/to_date period. If changed is specified, then envelopes that changed status during the period are found. If for example, created is specified, then envelopes created during the period are found. Default is changed.

Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.
include query optional string

Specifies additional information to return about the envelopes.
Use a comma-separated list, such as folders, recipients to specify information.
Valid values are:

  • custom_fields: The custom fields associated with the envelope.
  • documents: The documents associated with the envelope.
  • attachments: The attachments associated with the envelope.
  • extensions: Information about the email settings associated with the envelope.
  • folders: The folders where the envelope exists.
  • recipients: The recipients associated with the envelope.
  • payment_tabs: The payment tabs associated with the envelope.
include_purge_information query optional string

When true, information about envelopes that have been deleted is included in the response.
intersecting_folder_ids query optional string

A comma-separated list of folders that you want want to get envelopes from. Valid values are:

  • normal
  • inbox
  • sentitems
  • draft
  • templates
last_queried_date query optional string

Returns envelopes that were modified prior to the specified date and time.

Example: 2020-05-09T21:56:12.2500000Z
order query optional string

Returns envelopes in either ascending (asc) or descending (desc) order.
order_by query optional string

Sorts results according to a specific property. Valid values are:

  • last_modified
  • action_required
  • created
  • completed
  • envelope_name
  • expire
  • sent
  • signer_list
  • status
  • subject
  • user_name
  • status_changed
  • last_modified
powerformids query optional string

A comma-separated list of PowerFormId values.
query_budget query optional string

The time in seconds that the query should run before returning data.
requester_date_format query optional string —
search_mode query optional string —
search_text query optional string

Free text search criteria that you can use to filter the list of envelopes that is returned.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.
status query optional string

A comma-separated list of current envelope statuses to included in the response. Possible values are:

  • completed
  • created
  • declined
  • deleted
  • delivered
  • processing
  • sent
  • signed
  • timedout
  • voided

The any value is equivalent to any status.
to_date query optional string

Specifies the date and time
to stop looking for status changes.
The default is the current date and time.

Although you can use any date format
supported by the .NET system library’s
DateTime.Parse() function,
DocuSign recommends
using ISO 8601 format dates
with an explicit time zone offset
If you do not provide
a time zone offset,
the method uses the server’s time zone.

For example, the following dates and times refer to the same instant:

  • 2017-05-02T01:44Z
  • 2017-05-01T21:44-04:00
  • 2017-05-01T18:44-07:00
transaction_ids query optional string

If included in the query string, this is a comma separated list of envelope transactionIds.

If included in the request_body, this is a list of envelope transactionIds.

Note: transactionIds are only valid in the DocuSign system for seven days.
user_filter query optional string

Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, user_filter=sender.) Valid values are:

  • sender
  • recipient
  • recipient_only
user_id query optional string

The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account access can retrieve envelopes by user_id from the account.
user_name query optional string

Limit results to envelopes
sent by the account user
with this user name.

email must be given as well,
and both email and user_name
must refer to an existing account user.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}

Retrieves the overall status for the specified envelope.
To get the status of a list of envelopes, use
Envelope: listStatusChanges.

Related topics

operationId: Envelopes_GetEnvelope

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
advanced_update query optional string

When true, envelope information can be added or modified.
include query optional string

Specifies additional information about the envelope to return. Enter a comma-separated list, such as tabs,recipients. Valid values are:

  • custom_fields: The custom fields associated with the envelope.
  • documents: The documents associated with the envelope.
  • attachments: The attachments associated with the envelope.
  • extensions: The email settings associated with the envelope.
  • folders: The folder where the envelope exists.
  • recipients: The recipients associated with the envelope.
  • powerform: The PowerForms associated with the envelope.
  • tabs: The tabs associated with the envelope.
  • payment_tabs: The payment tabs associated with the envelope.
  • workflow: The workflow definition associated with the envelope.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events

Gets the envelope audit events for the specified envelope.

operationId: AuditEvents_GetAuditEvents

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages

Returns images of the pages in a document for display based on the parameters that you specify.

operationId: Pages_GetPageImages

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
count query optional string

The maximum number of results to return.
dpi query optional string

The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
max_height query optional string

Sets the maximum height of the returned images in pixels.
max_width query optional string

Sets the maximum width of the returned images in pixels.
nocache query optional string

When true, using cache is disabled and image information is retrieved from a database. True is the default value.
show_changes query optional string

When true, changes display in the user interface.
start_position query optional string

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image

Returns an image of a page in a document for display.

operationId: Pages_GetPageImage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
pageNumber path required string

The page number being accessed.
dpi query optional string

Sets the dots per inch (DPI) for the returned image.
max_height query optional string

Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.
max_width query optional string

Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.
show_changes query optional string

When true, changes display in the user interface.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification

Retrieves the envelope notification, reminders and expirations, information for an existing envelope.

operationId: Notification_GetEnvelopesEnvelopeIdNotification

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image

Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.

The userId specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.

The signatureIdOrName parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint.

For example: “Bob Smith” to “Bob%20Smith”

Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.

operationId: Recipients_GetRecipientInitialsImage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
recipientId path required string

A local reference used to map
recipients to other objects, such as specific
document tabs.

A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.

For example, many envelopes assign the first recipient
a recipientId of 1.
include_chrome query optional string

The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature

Retrieves signature information for a signer or sign-in-person recipient.

operationId: Recipients_GetRecipientSignature

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
recipientId path required string

A local reference used to map
recipients to other objects, such as specific
document tabs.

A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.

For example, many envelopes assign the first recipient
a recipientId of 1.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image

Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.

The userId specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.

The signatureIdOrName parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that don’t properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint.

For example: “Bob Smith” to “Bob%20Smith”

Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

operationId: Recipients_GetRecipientSignatureImage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
recipientId path required string

A local reference used to map
recipients to other objects, such as specific
document tabs.

A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.

For example, many envelopes assign the first recipient
a recipientId of 1.
include_chrome query optional string

When true, the response includes the chromed version of the signature image.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image

Favoritetemplates 1 endpoints

GET /v2.1/accounts/{accountId}/favorite_templates

Retrieves the list of favorite templates for the account.

operationId: FavoriteTemplates_GetFavoriteTemplates

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/favorite_templates

Folders 3 endpoints

GET /v2.1/accounts/{accountId}/folders

Returns a list of the account’s folders.

Use the include query parameter to specify the kinds of folders to return.

By default, only the first level of subfolders is shown.
Set the sub_folder_depth query parameter to -1 to return the entire folder hierarchy.

Default returns only top-level folders. Click to show.
`GET 'https://demo.docusign.net/restapi/v2.1/accounts/624e3e00-xxxx-xxxx-xxxx-43918c520dab/folders'` ```json { "resultSetSize": "5", "startPosition": "0", "endPosition": "4", "totalSetSize": "5", "folders": [ { "name": "Draft", "type": "draft", "itemCount": "1", "subFolderCount": "0", "hasSubFolders": "false" }, { "name": "Inbox", "type": "inbox", "itemCount": "0", "subFolderCount": "1", "hasSubFolders": "true", "folders": [ { "name": "Project Fair", "type": "normal", "hasSubFolders": "false", "parentFolderId": "3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840", "parentFolderUri": "/folders/3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840" } ] }, { "name": "Deleted Items", "type": "recyclebin", "itemCount": "0", "subFolderCount": "0", "hasSubFolders": "false" }, { "name": "Sent Items", "type": "sentitems", "itemCount": "3", "subFolderCount": "0", "hasSubFolders": "false" } ] } ```
Setting `sub_folder_depth` to `-1` returns the entire folder hierarchy. Click to show.
`GET 'https://demo.docusign.net/restapi/v2.1/accounts/624e3e00-xxxx-xxxx-xxxx-43918c520dab/folders?sub_folder_depth=-1'` One envelope has been moved from the `Inbox` folder to the `Project Fair/Phase 1` folder, and the endpoint is invoked with `sub_folder_depth=-1`. ```json { "resultSetSize": "5", "startPosition": "0", "endPosition": "4", "totalSetSize": "4", "folders": [ { "name": "Draft", "type": "draft", "itemCount": "1", "hasSubFolders": "false" }, { "name": "Inbox", "type": "inbox", "itemCount": "0", "hasSubFolders": "true", "folders": [ { "name": "Project Fair", "type": "normal", "itemCount": "0", "hasSubFolders": "true", "parentFolderId": "3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840", "parentFolderUri": "/folders/3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840", "folders": [ { "name": "NDAs", "type": "normal", "itemCount": "0", "hasSubFolders": "false", "parentFolderId": "12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d", "parentFolderUri": "/folders/12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d" }, { "name": "Phase 1", "type": "normal", "itemCount": "1", "hasSubFolders": "false", "parentFolderId": "12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d", "parentFolderUri": "/folders/12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d" } ] } ] }, { "name": "Deleted Items", "type": "recyclebin", "itemCount": "0", "hasSubFolders": "false" }, { "name": "Sent Items", "type": "sentitems", "itemCount": "1", "hasSubFolders": "false" } ] } ```

Related topics

operationId: Folders_GetFolders

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
count query optional string

The maximum number of results to return.
include query optional string

A comma-separated list of folder types to include in the response.
Valid values are:

  • envelope_folders: Returns a list of envelope folders. (Default)
  • template_folders: Returns a list of template folders.
  • shared_template_folders: Returns a list of shared template folders.
include_items query optional string

Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.
start_position query optional string

The zero-based index of the
result from which to start returning results.

The default value is 0.
sub_folder_depth query optional string

If missing or any value other than -1, the returned list contains only the top-level folders.
A value of -1 returns the complete folder hierarchy.
template query optional string

This parameter is deprecated as of version 2.1. Use include instead.
user_filter query optional string

Narrows down the resulting folder list by the following values:

  • all: Returns all templates owned or shared with the user. (default)
  • owned_by_me: Returns only templates the user owns.
  • shared_with_me: Returns only templates that are shared with the user.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/folders
GET /v2.1/accounts/{accountId}/folders/{folderId}

Gets information about items in the specified folder.

To include a list of the items in the folder, set the include_items query parameter to true.

Related topics

operationId: Folders_GetFolderItems

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
folderId path required string

The ID of the folder.
from_date query optional string

Reserved for DocuSign.
include_items query optional string

Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.
owner_email query optional string

Reserved for DocuSign.
owner_name query optional string

Reserved for DocuSign.
search_text query optional string

Reserved for DocuSign.
start_position query optional string

Reserved for DocuSign.
status query optional string

Reserved for DocuSign.
to_date query optional string

Reserved for DocuSign.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/folders/{folderId}
GET /v2.1/accounts/{accountId}/search_folders/{searchFolderId}
This method is deprecated in API v2.1 Use [Envelopes: listStatusChanges](https://raw.githubusercontent.com) instead.

Retrieves a list of items that match the criteria specified in the query.

If the user ID of the user making the call is the
same as the user ID for any returned recipient,
then the userId property is added to the returned
information for those recipients.

operationId: SearchFolders_GetSearchFolderContents

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
searchFolderId path required string

Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
all query optional string

Specifies that all envelopes that match the criteria are returned.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Valid values: 1 to 100
from_date query optional string

Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
include_recipients query optional string

When true, the recipient information is returned in the response.
order query optional string

Specifies the order in which the list is returned. Valid values are: asc for ascending order, and desc for descending order.
order_by query optional string

Specifies the property used to sort the list. Valid values are: action_required, created, completed, sent, signer_list, status, or subject.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.
to_date query optional string

Specifies the end of the date range to return.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/search_folders/{searchFolderId}

Groupbrands 1 endpoints

GET /v2.1/accounts/{accountId}/groups/{groupId}/brands

This method returns information about the brands associated with a group.

operationId: Brands_GetGroupBrands

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
groupId path required string

The ID of the group.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/groups/{groupId}/brands

Groupusers 1 endpoints

GET /v2.1/accounts/{accountId}/groups/{groupId}/users

Retrieves a list of users in a group.

operationId: Groups_GetGroupUsers

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
groupId path required string

The ID of the group being accessed.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Valid values: 1 to 100
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/groups/{groupId}/users

Groups 1 endpoints

GET /v2.1/accounts/{accountId}/groups

Gets information about groups associated with the account.

To get the users in a group: 1. Use this endpoint to get the group ID. 2. Use [listGroupUsers](https://raw.githubusercontent.com) to get the list of users.

Related topics

operationId: Groups_GetGroups

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Valid values: 1 to 100
group_type query optional string

The type of group to return. Valid values:

  • AdminGroup
  • CustomGroup
  • EveryoneGroup
include_usercount query optional string

When true, every group returned in the response includes a userCount property that contains the total number of users in the group. The default is true.
search_text query optional string

Filters the results of a GET request based on the text that you specify.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/groups

Identityverifications 1 endpoints

GET /v2.1/accounts/{accountId}/identity_verification

This method returns a list of Identity Verification workflows that are available to an account.

Note: To use this method, you must either be an account administrator or a sender.

Related topics

operationId: AccountIdentityVerification_GetAccountIdentityVerification

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
identity_verification_workflow_status query optional string

Filters the workflows returned according to status. Valid values:

  • active: Only active workflows are returned. This is the default.
  • deactivated: Only deactivated workflows are returned.
  • all: All workflows are returned.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/identity_verification

Invoices 3 endpoints

GET /v2.1/accounts/{accountId}/billing_invoices

Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days.

Privileges required: account administrator

operationId: BillingInvoices_GetBillingInvoices

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
from_date query optional string

Specifies the date/time of the earliest invoice in the account to retrieve.
to_date query optional string

Specifies the date/time of the latest invoice in the account to retrieve.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/billing_invoices
GET /v2.1/accounts/{accountId}/billing_invoices/{invoiceId}

Retrieves the specified invoice.

Note: If the pdfAvailable property in the response is set to true, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the Accept property in the header to Accept: application/pdf.

Privileges required: account administrator

The response returns a list of charges and information about the charges. Quantities are usually shown as ‘unlimited’ or an integer. Amounts are shown in the currency set for the account.

Response
The following table provides a description of the different chargeName property values. The information will grow as more chargeable items are added to the system.

chargeName Description
id_check ID Check Charge
in_person_signing In Person Signing charge
envelopes Included Sent Envelopes for the account
age_verify Age verification check
ofac OFAC Check
id_confirm ID confirmation check
student_authentication STAN PIN authentication check
wet_sign_fax Pages for returning signed documents by fax
attachment_fax Pages for returning attachments by fax
phone_authentication Phone authentication charge
powerforms PowerForm envelopes sent
signer_payments Payment processing charge
outbound_fax Send by fax charge
bulk_recipient_envelopes Bulk Recipient Envelopes sent
sms_authentications SMS authentication charge
saml_authentications SAML authentication charge
express_signer_certificate DocuSign Express Certificate charge
personal_signer_certificate Personal Signer Certificate charge
safe_certificate SAFE BioPharma Signer Certificate charge
seats Included active seats charge
open_trust_certificate OpenTrust Signer Certificate charge
operationId: BillingInvoices_GetBillingInvoice

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
invoiceId path required string

The ID of the invoice.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/billing_invoices/{invoiceId}
GET /v2.1/accounts/{accountId}/billing_invoices_past_due

Returns a list past due invoices for the account and notes if payment can be made through the REST API.

Privileges Required: account administrator

operationId: BillingInvoices_GetBillingInvoicesPastDue

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/billing_invoices_past_due

Notary 1 endpoints

GET /v2.1/current_user/notary

Gets settings for a notary user.
The current user must be a notary.

operationId: Notary_GetNotary

Parameters

Name In Required Type Description
include_jurisdictions query optional string

When true, the response will include a jurisdiction property that contains an array of all supported jurisdictions for the current user.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/current_user/notary

Notaryjournals 1 endpoints

GET /v2.1/current_user/notary/journals
operationId: NotaryJournals_GetNotaryJournals

Parameters

Name In Required Type Description
count query optional string

The maximum number of results to return.
search_text query optional string

Use this parameter to search for specific text.
start_position query optional string

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/current_user/notary/journals

Notaryjurisdiction 2 endpoints

GET /v2.1/current_user/notary/jurisdictions

Returns a list of jurisdictions that the notary is registered in.
The current user must be a notary.

operationId: NotaryJurisdictions_GetNotaryJurisdictions

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/current_user/notary/jurisdictions
GET /v2.1/current_user/notary/jurisdictions/{jurisdictionId}

Gets a jurisdiction object for the current user. The following restrictions apply:

  • The current user must be a notary.
  • The jurisdictionId must be a jurisdiction that the notary is registered for.
operationId: NotaryJurisdictions_GetNotaryJurisdiction

Parameters

Name In Required Type Description
jurisdictionId path required string

The ID of the jurisdiction.
The following jurisdictions
are supported:

  • 5 - California
  • 6 - Colorado
  • 9 - Florida
  • 10 - Georgia
  • 12 - Idaho
  • 13 - Illinois
  • 14 - Indiana
  • 15 - Iowa
  • 17 - Kentucky
  • 23 - Minnesota
  • 25 - Missouri
  • 30 - New Jersey
  • 32 - New York
  • 33 - North Carolina
  • 35 - Ohio
  • 37 - Oregon
  • 38 - Pennsylvania
  • 40 - South Carolina
  • 43 - Texas
  • 44 - Utah
  • 47 - Washington
  • 48 - West Virginia
  • 49 - Wisconsin
  • 62 - Florida Commissioner of Deeds

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/current_user/notary/jurisdictions/{jurisdictionId}

Paymentgatewayaccounts 1 endpoints

GET /v2.1/accounts/{accountId}/payment_gateway_accounts

This method returns a list of payment gateway accounts and basic information about them.

operationId: PaymentGatewayAccounts_GetAllPaymentGatewayAccounts

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/payment_gateway_accounts

Payments 2 endpoints

GET /v2.1/accounts/{accountId}/billing_payments

Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days.

Privileges required: account administrator

operationId: BillingPayments_GetPaymentList

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
from_date query optional string

Specifies the date/time of the earliest payment in the account to retrieve.
to_date query optional string

Specifies the date/time of the latest payment in the account to retrieve.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/billing_payments
GET /v2.1/accounts/{accountId}/billing_payments/{paymentId}

Retrieves the information for a specified payment.

Privileges required: account administrator

operationId: BillingPayments_GetPayment

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
paymentId path required string

The ID of the payment.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/billing_payments/{paymentId}

Powerformdata 1 endpoints

GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data

This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.

You specify the format in which you want to retrieve the data in the Accept header. This header accepts the following values:

  • application/json: JSON format
  • application/xml: XML format
  • text/csv: Comma-separated value (CSV) format

Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.

operationId: PowerForms_GetPowerFormFormData

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
powerFormId path required string

The ID of the PowerForm.
data_layout query optional string

The layout in which to return the PowerForm data. Valid values are:

  • Native
  • Csv_Classic
  • Csv_One_Envelope_Per_Line
  • Xml_Classic
from_date query optional string

The start date for a date range in UTC DateTime format.

Note: If this property is null, no date filtering is applied.
to_date query optional string

The end date of a date range in UTC DateTime format. The default value is UtcNow.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data

Powerforms 3 endpoints

GET /v2.1/accounts/{accountId}/powerforms

This method returns a list of PowerForms that are available to the user.

operationId: PowerForms_GetPowerFormsList

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
from_date query optional string

The start date for a date range.

Note: If no value is provided, no date filtering is applied.
order query optional string

The order in which to sort the results.

Valid values are:

  • asc: Ascending order.
  • desc: Descending order.
order_by query optional string

The file attribute to use to sort the results.

Valid values are:

  • sender
  • auth
  • used
  • remaining
  • lastused
  • status
  • type
  • templatename
  • created
search_fields query optional string

A comma-separated list of additional properties to include in a search.

  • sender: Include sender name and email in the search.
  • recipients: Include recipient names and emails in the search.
  • envelope: Include envelope information in the search.
search_text query optional string

Use this parameter to search for specific text.
to_date query optional string

The end date for a date range.

Note: If no value is provided, this property defaults to the current date.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/powerforms
GET /v2.1/accounts/{accountId}/powerforms/senders

This method returns a list of users who have sent PowerForms.

operationId: PowerForms_GetPowerFormsSenders

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
start_position query optional string

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/powerforms/senders
GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}

This method returns detailed information about a specific PowerForm.

operationId: PowerForms_GetPowerForm

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
powerFormId path required string

The ID of the PowerForm.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}

Requestlogs 3 endpoints

GET /v2.1/diagnostics/request_logs

Retrieves a list of log entries as a JSON or XML object or as a zip file containing the entries.

If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request.

If the Accept header is set to application/json or application/xml, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below.

operationId: APIRequestLog_GetRequestLogs

Parameters

Name In Required Type Description
encoding query optional string

Reserved for DocuSign.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/diagnostics/request_logs
GET /v2.1/diagnostics/request_logs/{requestLogId}

Retrieves information for a single log entry.

Request
The requestLogId property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned.

Response
If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.

operationId: APIRequestLog_GetRequestLog

Parameters

Name In Required Type Description
requestLogId path required string

The ID of the log entry.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/diagnostics/request_logs/{requestLogId}
GET /v2.1/diagnostics/settings

Retrieves the current API request logging setting for the user and remaining log entries.

Response
The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.

operationId: APIRequestLog_GetRequestLogSettings

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/diagnostics/settings

Resources 1 endpoints

GET /v2.1

Retrieves the base resources available for the eSignature REST API.

You do not need an integrator key to view the REST API versions and resources.

operationId: ServiceInformation_GetResourceInformation

Responses

200

Successful response.
400

Error encountered.
GET /v2.1

Services 1 endpoints

GET /service_information

Retrieves the available REST API versions.

DocuSign Production system: https://www.docusign.net/restapi/service_information
DocuSign Demo system: https://demo.docusign.net/restapi/service_information

You do not need an integration key to view the REST API versions and resources.

operationId: ServiceInformation_GetServiceInformation

Responses

200

Successful response.
400

Error encountered.
GET /service_information

Signinggroupusers 1 endpoints

GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users

Retrieves the list of members in the specified Signing Group.

operationId: SigningGroups_GetSigningGroupUsers

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
signingGroupId path required string

The ID of the signing group.

Note: When you send an envelope to a signing group,
anyone in the group can open it and sign it with their own signature.
For this reason, DocuSign recommends that
you do not include non-signer recipients
(such as carbon copy recipients)
in the same signing group as signer recipients.
However, you could create a second signing group
for the non-signer recipients and change t
he default action of Needs to Sign to a different value,
such as Receives a Copy.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users

Signinggroups 2 endpoints

GET /v2.1/accounts/{accountId}/signing_groups

Retrieves a list of all signing groups in the specified account.

operationId: SigningGroups_GetSigningGroups

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
group_type query optional string

Filters by the type of signing group. Valid values:

  • sharedSigningGroup
  • privateSigningGroup
  • systemSigningGroup
include_users query optional string

When true, the response includes the signing group members.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/signing_groups
GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}

Retrieves information, including group member information, for the specified signing group.

operationId: SigningGroups_GetSigningGroup

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
signingGroupId path required string

The ID of the signing group.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}

Tabsblob 1 endpoints

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob

This endpoint has been deprecated.

operationId: TabsBlob_GetTabsBlob

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob

Templatecustomfields 1 endpoints

GET /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields

Retrieves the custom document field information from an existing template.

operationId: CustomFields_GetTemplateCustomFields

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields

Templatedocumentfields 1 endpoints

GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields

This method retrieves the custom document fields for an existing template document.

operationId: DocumentFields_GetTemplateDocumentFields

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields

Templatedocumenthtmldefinitions 1 endpoints

GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions
operationId: ResponsiveHtml_GetTemplateDocumentHtmlDefinitions

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions

Templatedocumenttabs 2 endpoints

GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs

Returns the tabs from the page specified by pageNumber of the document specified by documentId in the
template specified by templateId.

operationId: Tabs_GetTemplatePageTabs

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
pageNumber path required string

The page number being accessed.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs

Returns the tabs on the document specified by documentId in the
template specified by templateId.

operationId: Tabs_GetTemplateDocumentTabs

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
templateId path required string

The ID of the template.
page_numbers query optional string

Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page Guids.

Example: page_numbers=2,6

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs

Templatedocumentvisibility 1 endpoints

GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility

This method returns information about document visibility for a template recipient.

operationId: Recipients_GetTemplateRecipientDocumentVisibility

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
recipientId path required string

A local reference used to map
recipients to other objects, such as specific
document tabs.

A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.

For example, many envelopes assign the first recipient
a recipientId of 1.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility

Templatedocuments 2 endpoints

GET /v2.1/accounts/{accountId}/templates/{templateId}/documents

Retrieves a list of documents associated with the specified template.

operationId: Documents_GetTemplateDocuments

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.
include_tabs query optional string

Reserved for DocuSign.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}

This method retrieves one or more PDF documents from the template that you specify.

You can specify the ID of the document to retrieve, or pass in the value combined to retrieve all documents in the template as a single PDF file.

operationId: Documents_GetTemplateDocument

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
templateId path required string

The ID of the template.
encrypt query optional string

When true, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign.
file_type query optional string —
show_changes query optional string

When true, any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional signatures or initials are outlined in red.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}

Templatehtmldefinitions 1 endpoints

GET /v2.1/accounts/{accountId}/templates/{templateId}/html_definitions
operationId: ResponsiveHtml_GetTemplateHtmlDefinitions

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/html_definitions

Templatelocks 1 endpoints

GET /v2.1/accounts/{accountId}/templates/{templateId}/lock

Retrieves general information about a template lock.

The user requesting the information must be the same user
who locked the template.

You can use this method to recover the lock information,
including the lockToken,
for a locked template.
The X-DocuSign-Edit header is included in the response.

See
TemplateLocks: create
for a description of the X-DocuSign-Edit header.

Related topics

operationId: Lock_GetTemplateLock

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/lock

Templaterecipienttabs 1 endpoints

GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs

Gets the tabs information for a signer or sign-in-person recipient in a template.

operationId: Recipients_GetTemplateRecipientTabs

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
recipientId path required string

A local reference used to map
recipients to other objects, such as specific
document tabs.

A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.

For example, many envelopes assign the first recipient
a recipientId of 1.
templateId path required string

The ID of the template.
include_anchor_tab_locations query optional string

When true, all tabs with anchor tab properties are included in the response. The default value is false.
include_metadata query optional string

When true, the response includes metadata indicating which properties are editable.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs

Templaterecipients 1 endpoints

GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients

Retrieves the information for all recipients in the specified template.

operationId: Recipients_GetTemplateRecipients

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.
include_anchor_tab_locations query optional string

When true and include_tabs is set to true, all tabs with anchor tab properties are included in the response.
include_extended query optional string

When true, the extended properties are included in the response.
include_tabs query optional string

When true, the tab information associated with the recipient is included in the response.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients

Templates 5 endpoints

GET /v2.1/accounts/{accountId}/templates

Retrieves the list of templates for the specified account. The request can be limited to a specific folder.

Related topics

operationId: Templates_GetTemplates

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.
created_from_date query optional string

Lists templates created on or after this date.
created_to_date query optional string

Lists templates modified before this date.
folder_ids query optional string

A comma-separated list of folder ID GUIDs.
folder_types query optional string

The type of folder to return templates for. Possible values are:

  • templates: Templates in the My Templates folder.
    Templates in the Shared Templates and All Template folders (if the request ID from and Admin) are excluded.
  • templates_root: Templates in the root level of the My Templates folder, but not in an actual folder. Note that the My Templates folder is not a real folder.
  • recylebin: Templates that have been deleted.
from_date query optional string

Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
include query optional string

A comma-separated list
of additional template attributes
to include in the response.
Valid values are:

  • powerforms: Includes details about the PowerForms associated with the templates.
  • documents: Includes information about template documents.
  • folders: Includes information about the folder that holds the template.
  • favorite_template_status: Includes the template favoritedByMe property. Note: You can mark a template as a favorite only in eSignature v2.1.
  • advanced_templates: Includes information about advanced templates.
  • recipients: Includes information about template recipients.
  • custom_fields: Includes information about template custom fields.
  • notifications: Includes information about the notification settings for templates.
is_deleted_template_only query optional string

When true, retrieves templates that have been permanently deleted. The default is false.

Note: After you delete a template, you can see it in the Deleted bin in the UI for 24 hours. After 24 hours, the template is permanently deleted.
is_download query optional string

When true, downloads the templates listed in template_ids as a collection of JSON definitions in a single zip file.

The Content-Disposition header is set in the response. The value of the header provides the filename of the file.

The default is false.

Note: This parameter only works when you specify a list of templates in the template_ids parameter.
modified_from_date query optional string

Lists templates modified on or after this date.
modified_to_date query optional string

Lists templates modified before this date.
order query optional string

Specifies the sort order of the search results.
Valid values are:

  • asc: Ascending (A to Z)
  • desc: Descending (Z to A)
order_by query optional string

Specifies how the search results are listed.
Valid values are:

  • name: template name
  • modified: date/time template was last modified
  • used: date/time the template was last used.
search_fields query optional string

A comma-separated list of additional template properties to search.

  • sender: Include sender name and email in the search.
  • recipients: Include recipient names and emails in the search.
  • envelope: Not used in template searches.
search_text query optional string

The text to use to search the names of templates.

Limit: 48 characters.
shared_by_me query optional string

When true, the response only includes templates shared by the user. When false, the response only returns template not shared by the user. If not specified, templates are returned whether or not they have been shared by the user.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.
template_ids query optional string

A comma-separated list of template IDs to download. This value is valid only when is_download is true.
to_date query optional string

The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.

Note: If this property is null, the value defaults to the current date.
used_from_date query optional string

Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.
used_to_date query optional string

End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.
user_filter query optional string

Filters the templates in the response. Valid values are:

  • owned_by_me: Results include only templates owned by the user.
  • shared_with_me: Results include only templates shared with the user.
  • all: Results include all templates owned or shared with the user.
user_id query optional string

The ID of the user.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates
GET /v2.1/accounts/{accountId}/templates/{templateId}

Retrieves the definition of the specified template.

operationId: Templates_GetTemplate

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.
include query optional string

A comma-separated list
of additional template attributes
to include in the response.
Valid values are:

  • powerforms: Includes information about PowerForms.
  • tabs: Includes information about tabs.
  • documents: Includes information about documents.
  • favorite_template_status: : Includes the template favoritedByMe property in the response. Note: You can mark a template as a favorite only in eSignature v2.1.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages

Returns images of the pages in a template document for display based on the parameters that you specify.

operationId: Pages_GetTemplatePageImages

Parameters

Name In Required Type Description
accountId path required string

(Required) The external account number (int) or account ID GUID.
documentId path required string

(Required) The ID of the document.
templateId path required string

(Required) The ID of the template.
count query optional string

The maximum number of results to return.
dpi query optional string

The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
max_height query optional string

Sets the maximum height of the returned images in pixels.
max_width query optional string

Sets the maximum width of the returned images in pixels.
nocache query optional string

When true, using cache is disabled and image information is retrieved from a database. True is the default value.
show_changes query optional string

When true, changes display in the user interface.
start_position query optional string

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image

Retrieves a page image for display from the specified template.

operationId: Pages_GetTemplatePageImage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
pageNumber path required string

The page number being accessed.
templateId path required string

The ID of the template.
dpi query optional string

The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
max_height query optional string

Sets the maximum height of the returned images in pixels.
max_width query optional string

Sets the maximum width of the returned images in pixels.
show_changes query optional string —

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image
GET /v2.1/accounts/{accountId}/templates/{templateId}/notification

Retrieves the envelope notification, reminders and expirations, information for an existing template.

operationId: Notification_GetTemplatesTemplateIdNotification

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/notification

Usercustomsettings 1 endpoints

GET /v2.1/accounts/{accountId}/users/{userId}/custom_settings

Retrieves a list of custom user settings for a single user.

Custom settings provide a flexible way to store and retrieve
custom user information that can be used in your own system.

Note: Custom user settings are not the same as user account
settings.

If the custom user settings you want to retrieve are grouped, you
must include the X-DocuSign-User-Settings-Key header
in the request:

X-DocuSign-User-Settings-Key:group_name

Where the group_name is your designated name for the group of
customer user settings.

If the X-DocuSign-User-Settings-Key header is not included, only the custom
user settings that were added without a group are retrieved.

operationId: UserCustomSettings_GetCustomSettings

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/custom_settings

Userprofiles 1 endpoints

GET /v2.1/accounts/{accountId}/users/{userId}/profile

Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user.

The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the specified account.

operationId: UserProfile_GetProfile

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/profile

Usersignatures 3 endpoints

GET /v2.1/accounts/{accountId}/users/{userId}/signatures

This method retrieves the signature definitions for the user that you specify.

The userId parameter specified in the endpoint must match the authenticated user’s user ID, and the user must be a member of the account.

The signatureId parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example, encode “Bob Smith” as “Bob%20Smith”.

operationId: UserSignatures_GetUserSignatures

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.
stamp_type query optional string

The type of stamps to return. Valid values are:

  • signature: Returns information about signature images only. This is the default value.
  • stamp: Returns information about eHanko and custom stamps only.
  • null

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/signatures
GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}

Retrieves the structure of a single signature with a known signature name.

The userId specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.

The signatureId parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode “Bob Smith” as “Bob%20Smith”.

operationId: UserSignatures_GetUserSignature

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
signatureId path required string

The ID of the account stamp.
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}
GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}

Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format in which it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.

The userId property specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.

The signatureId parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode “Bob Smith” as “Bob%20Smith”.

Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

operationId: UserSignatures_GetUserSignatureImage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
imageType path required string

Specificies the type of image. Valid values:

  • stamp_image
  • signature_image
  • initials_image
signatureId path required string

The ID of the account stamp.
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.
include_chrome query optional string

When true, the chrome (or frame containing the added line and identifier) is included with the signature image.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}

Users 4 endpoints

GET /v2.1/accounts/{accountId}/users

Retrieves the list of users for the specified account.

The response returns the list of users for the account, with information about the result set. If the additional_info query is added to the endpoint and set to true, full user information is returned for each user.

operationId: Users_GetUsers

Parameters

Name In Required Type Description
accountId path required string

(Required) The external account number (int) or account ID GUID.
additional_info query optional string

When true, the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is false.
alternate_admins_only query optional string —
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Valid values: 1 to 100
domain_users_only query optional string —
email query optional string

Filters results based on the email address associated with the user that you want to return.

Note: You can use either this parameter or the email_substring parameter, but not both. For older accounts, this parameter might return multiple users who are associated with a single email address.
email_substring query optional string

Filters results based on a fragment of an email address. For example, you could enter gmail to return all users who have Gmail addresses.

Note: You do not use a wildcard character with this parameter. You can use either this parameter or the email parameter, but not both.
group_id query optional string

Filters results based on one or more group IDs.
include_usersettings_for_csv query optional string

When true, the response includes the userSettings object data in CSV format.
login_status query optional string

When true, the response includes the login status of each user.
not_group_id query optional string

Return user records excluding the specified group IDs.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.
status query optional string

Filters results by user account status.
A comma-separated list of any of the following:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
user_name_substring query optional string

Filters the user records returned by the user name or a sub-string of user name.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users
GET /v2.1/accounts/{accountId}/users/{userId}

Retrieves the user information for the specified user. For example:

{
  "userName": "Tania Morales",
  "userId": "6b67a1ee-xxxx-xxxx-xxxx-385763624163",
  "userType": "CompanyUser",
  "isAdmin": "False",
  "isNAREnabled": "false",
  "userStatus": "Active",
  "uri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163",
  "email": "examplename42@orobia.net",
  "createdDateTime": "2019-04-01T22:11:56.4570000Z",
  "userAddedToAccountDateTime": "0001-01-01T08:00:00.0000000Z",
  "firstName": "Tania",
  "lastName": "Morales",
  "jobTitle": "",
  "company": "Company",
  "permissionProfileId": "12345678",
  "permissionProfileName": "DocuSign Viewer",
  "userSettings": {. . .},
  "sendActivationOnInvalidLogin": "false",
  "enableConnectForUser": "false",
  "groupList": [. . .],
  "workAddress": {. . .},
  "homeAddress": {. . .},
  "signatureImageUri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/signature_image",
  "initialsImageUri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/initials_image",
  "defaultAccountId": "f636f297-xxxx-xxxx-xxxx-8e7a14715950"
}
operationId: User_GetUser

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.
additional_info query optional string

Setting this parameter has no effect in this operation.
email query optional string

Setting this parameter has no effect in this operation.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}
GET /v2.1/accounts/{accountId}/users/{userId}/profile/image

Retrieves the user profile picture for the specified user.

The userId path parameter must match the authenticated user’s user ID,
and the user must be a member of the specified account.

Return value Meaning
200 OK The response contains the profile image in the same format as it was uploaded.
404 Not found The user does not have a profile image.
400 Bad request There was an error in the request. The response has more information.
operationId: UserProfileImage_GetUserProfileImage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.
encoding query optional string

Reserved for DocuSign.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/profile/image
GET /v2.1/accounts/{accountId}/users/{userId}/settings

Retrieves a list of the account settings and email
notification information for the specified user.

The response returns the account setting
name/value information and the email notification
settings for the specified user. For more
information, see
Users:create.

operationId: UserSettings_GetUserSettings

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
userId path required string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/users/{userId}/settings

Workspaceitems 3 endpoints

GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}

This method returns the contents of a workspace folder, which can include sub-folders and files.

operationId: WorkspaceFolder_GetWorkspaceFolder

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
folderId path required string

The ID of the folder.
workspaceId path required string

The ID of the workspace.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.
include_files query optional string

When true, the response includes file information (in addition to folder information). The default is false.
include_sub_folders query optional string

When true, the response includes information about the sub-folders of the current folder. The default is false.
include_thumbnails query optional string

When true, the response returns thumbnails. The default is false.
include_user_detail query optional string

When true, the response includes extended details about the user. The default is false.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.
workspace_user_id query optional string

If set, the response only includes results associated with the userId that you specify.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}
GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}

This method returns a binary version of a file in a workspace.

operationId: WorkspaceFile_GetWorkspaceFile

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
fileId path required string

The ID of the file.
folderId path required string

The ID of the folder.
workspaceId path required string

The ID of the workspace.
is_download query optional string

When true, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. The default is false.
pdf_version query optional string

When true the file is returned in PDF format.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}
GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages

This method returns a workspace file as rasterized pages.

operationId: WorkspaceFilePages_GetWorkspaceFilePages

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
fileId path required string

The ID of the file.
folderId path required string

The ID of the folder.
workspaceId path required string

The ID of the workspace.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.
dpi query optional string

The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
max_height query optional string

Sets the maximum height of the returned images in pixels.
max_width query optional string

Sets the maximum width of the returned images in pixels.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages

Workspaces 2 endpoints

GET /v2.1/accounts/{accountId}/workspaces

Gets information about the Workspaces that have been created.

operationId: Workspace_GetWorkspaces

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/workspaces
GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}

Retrieves properties about a workspace given a unique workspaceId.

operationId: Workspace_GetWorkspace

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
workspaceId path required string

The ID of the workspace.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}
Load more endpoints

Schemas

object AccountBrands 
{
  "type": "object",
  "properties": {
    "brands": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brand"
      },
      "description": "A list of brands."
    },
    "senderBrandIdDefault": {
      "type": "string",
      "description": "The brand that envelope senders see when a brand is not explicitly set."
    },
    "recipientBrandIdDefault": {
      "type": "string",
      "description": "The brand that envelope recipients see when a brand is not explicitly set."
    }
  },
  "x-ds-order": "10",
  "description": "The AccountBrands resource enables you to use account-level brands to customize the styles and text that recipients see.",
  "x-ms-summary": "The AccountBrands resource enables you to use account-level brands to customize the styles and text that recipients see.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "brandsResponse"
}
object AccountConsumerDisclosures 
{
  "type": "object",
  "properties": {
    "pdfId": {
      "type": "string",
      "description": "**Deprecated.** \n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. "
    },
    "custom": {
      "type": "string",
      "description": "When **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**"
    },
    "useBrand": {
      "type": "string",
      "description": "When **true,** specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience.  \n\nWhen **false** (default), or if the signing brand does not specify a company name, the account name is used instead.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. "
    },
    "esignText": {
      "type": "string",
      "description": "The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.\n\n**Note:** If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting."
    },
    "changeEmail": {
      "type": "string",
      "description": "If the customer needs to change their email address, this is the email address to which they should the change request.\n\nMaximum length: 100 characters."
    },
    "companyName": {
      "type": "string",
      "description": "Specifies the company name used in the disclosure. The default value is the account name.\n\nHowever, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true.** Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true.**"
    },
    "enableEsign": {
      "type": "string",
      "description": "When **true** (default), indicates that eSign is enabled."
    },
    "companyPhone": {
      "type": "string",
      "description": "The phone number of the company associated with the consumer disclosure, as a free-formatted string."
    },
    "languageCode": {
      "type": "string",
      "description": "The code for the language version of the disclosure. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`."
    },
    "withdrawCity": {
      "type": "string",
      "description": "Contains the city of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 50 characters. "
    },
    "withdrawEmail": {
      "type": "string",
      "description": "Contains the email address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawOther": {
      "type": "string",
      "description": "Contains any other information needed to withdraw consent.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We do not need any other information from you to withdraw consent.`"
    },
    "withdrawPhone": {
      "type": "string",
      "description": "Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.\n\nMaximum length: 20 characters. "
    },
    "withdrawState": {
      "type": "string",
      "description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.\n\nExample: `PA`"
    },
    "accountEsignId": {
      "type": "string",
      "description": "The GUID of the account associated with the consumer disclosure."
    },
    "esignAgreement": {
      "type": "string",
      "description": "The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting."
    },
    "withdrawByMail": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.**"
    },
    "allowCDWithdraw": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.**\n**Note:** Only Admin users can change this setting."
    },
    "copyCostPerPage": {
      "type": "string",
      "description": "The cost per page if the customer requests paper copies.\n\nExample: \n\n`0.0000`"
    },
    "withdrawByEmail": {
      "type": "string",
      "description": "When **true** (default), indicates that the customer can withdraw consent by email."
    },
    "withdrawByPhone": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw consent by phone. The default is **false.**"
    },
    "changeEmailOther": {
      "type": "string",
      "description": "Other information about the requirements for the user to change their email address.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We do not require any other information from you to change your email address.`"
    },
    "copyRequestEmail": {
      "type": "string",
      "description": "The email address to which the customer should send a request for copies of a document.\n\nMaximum length: 100 characters."
    },
    "mustAgreeToEsign": {
      "type": "string",
      "description": "When **true,** the  recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions."
    },
    "withdrawPostalCode": {
      "type": "string",
      "description": "Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 20 characters. "
    },
    "withdrawAddressLine1": {
      "type": "string",
      "description": "Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawAddressLine2": {
      "type": "string",
      "description": "Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawConsequences": {
      "type": "string",
      "description": "Text indicating the consequences of withdrawing consent.\n\nMaximum length: 255 characters."
    },
    "allowCDWithdrawMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "copyFeeCollectionMethod": {
      "type": "string",
      "description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We will bill you for any fees at that time, if any.`"
    },
    "useConsumerDisclosureWithinAccount": {
      "type": "string",
      "description": "When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement."
    },
    "useConsumerDisclosureWithinAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "x-ds-order": "20",
  "description": "Details about account consumer disclosures.",
  "x-ms-summary": "Details about account consumer disclosures.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "consumerDisclosure"
}
object AccountCustomFields 
{
  "type": "object",
  "properties": {
    "listCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/listCustomField"
      },
      "description": "An array of list custom fields."
    },
    "textCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/textCustomField"
      },
      "description": "An array of text custom fields."
    }
  },
  "x-ds-order": "30",
  "description": "An `accountCustomField` is an envelope custom field that you set at the account level.\nApplying custom fields enables account administrators to group and manage envelopes.\n",
  "x-ms-summary": "An `accountCustomField` is an envelope custom field that you set at the account level.\nApplying custom fields enables account administrators to group and manage envelopes.\n",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "customFields"
}
object AccountPasswordRules 
{
  "type": "object",
  "properties": {
    "expirePassword": {
      "type": "string",
      "description": "When **true,** passwords expire. The default value is `false`."
    },
    "questionsRequired": {
      "type": "string",
      "description": "The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`."
    },
    "expirePasswordDays": {
      "type": "string",
      "description": "The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true.**"
    },
    "lockoutDurationType": {
      "type": "string",
      "description": "The interval associated with the user lockout after a failed login attempt.\n\nPossible values are:\n\n- `minutes` (default)\n- `hours`\n- `days`"
    },
    "passwordIncludeDigit": {
      "type": "string",
      "description": "When **true,** passwords must include a digit. The default value is `false`."
    },
    "passwordStrengthType": {
      "type": "string",
      "description": "The type of password strength. Possible values are:\n\n- `basic`: The minimum password length is 6 characters with no other password requirements.\n- `medium`: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character.\n- `strong`: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character.\n- `custom`: This option enables you to customize password requirements, including the following properties:\n\n   - `minimumPasswordLength`\n   - `minimumPasswordAgeDays`\n   - `passwordIncludeDigit`\n   - `passwordIncludeDigitOrSpecialCharacter`\n   - `passwordIncludeLowerCase`\n   - `passwordIncludeSpecialCharacter`\n   - `passwordIncludeUpperCase`\n   - `questionsRequired`"
    },
    "minimumPasswordLength": {
      "type": "string",
      "description": "The minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`."
    },
    "lockoutDurationMinutes": {
      "type": "string",
      "description": "The number of minutes a user is locked out of the system after three failed login attempts. The default value is `2`."
    },
    "minimumPasswordAgeDays": {
      "type": "string",
      "description": "The minimum number of days after a password is set before it can be changed. This value can be `0` or more days. The default value is `0`."
    },
    "passwordIncludeLowerCase": {
      "type": "string",
      "description": "When **true,** passwords must include a lowercase letter. The default value is `false`."
    },
    "passwordIncludeUpperCase": {
      "type": "string",
      "description": "When **true,** passwords must include an uppercase letter. The default value is `false`."
    },
    "questionsRequiredMetadata": {
      "$ref": "#/components/schemas/accountPasswordQuestionsRequired"
    },
    "expirePasswordDaysMetadata": {
      "$ref": "#/components/schemas/accountPasswordExpirePasswordDays"
    },
    "lockoutDurationTypeMetadata": {
      "$ref": "#/components/schemas/accountPasswordLockoutDurationType"
    },
    "passwordStrengthTypeMetadata": {
      "$ref": "#/components/schemas/accountPasswordStrengthType"
    },
    "minimumPasswordLengthMetadata": {
      "$ref": "#/components/schemas/accountMinimumPasswordLength"
    },
    "lockoutDurationMinutesMetadata": {
      "$ref": "#/components/schemas/accountPasswordLockoutDurationMinutes"
    },
    "minimumPasswordAgeDaysMetadata": {
      "$ref": "#/components/schemas/accountPasswordMinimumPasswordAgeDays"
    },
    "passwordIncludeSpecialCharacter": {
      "type": "string",
      "description": "When **true,** passwords must include a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
    },
    "passwordIncludeDigitOrSpecialCharacter": {
      "type": "string",
      "description": "When **true,** passwords must include either a digit or a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
    }
  },
  "x-ds-order": "190",
  "description": "Contains details about the password rules for an account.",
  "x-ms-summary": "Contains details about the password rules for an account.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "accountPasswordRules"
}
object AccountPermissionProfiles 
{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInformation"
      },
      "description": "A list of user objects containing information about the users who are associated with the account permission profile."
    },
    "settings": {
      "$ref": "#/components/schemas/accountRoleSettings"
    },
    "userCount": {
      "type": "string",
      "description": "The total number of users in the group associated with the account permission profile."
    },
    "modifiedDateTime": {
      "type": "string",
      "description": "The date and time when the permission profile was last modified."
    },
    "modifiedByUsername": {
      "type": "string",
      "description": "The username of the user who last modified the permission profile."
    },
    "permissionProfileId": {
      "type": "string",
      "description": "The ID of the permission profile.\n\nUse [AccountPermissionProfiles: list](https://raw.githubusercontent.com)\nto get a list of permission profiles and their IDs.\n\nYou can also download a CSV file of all permission profiles\nand their IDs from the **Settings > Permission Profiles** page\nof your eSignature account page.\n"
    },
    "permissionProfileName": {
      "type": "string",
      "description": "The name of the account permission profile. \n\nExample: `Account Administrator`"
    }
  },
  "x-ds-order": "70",
  "description": "The AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users.",
  "x-ms-summary": "The AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "permissionProfile"
}
object AccountSealProviders 
{
  "type": "object",
  "properties": {
    "seals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/sealIdentifier"
      },
      "description": "A list of electronic seals to apply to documents."
    }
  },
  "x-ds-order": "10",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "accountSeals"
}
object AccountSignatureProviders 
{
  "type": "object",
  "properties": {
    "signatureProviders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/accountSignatureProvider"
      },
      "description": "Names of electronic or digital signature providers that can be used."
    }
  },
  "x-ds-order": "30",
  "description": "This resource provides information on the Standards Based Signature providers that have been provisioned for an account.\n",
  "x-ms-summary": "This resource provides information on the Standards Based Signature providers that have been provisioned for an account.\n",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "accountSignatureProviders"
}
object AccountSignatures 
{
  "type": "object",
  "properties": {
    "nrdsId": {
      "type": "string",
      "description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor."
    },
    "status": {
      "type": "string",
      "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
    },
    "imageType": {
      "type": "string",
      "description": "Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`"
    },
    "isDefault": {
      "type": "string",
      "description": "Boolean that specifies whether the signature is the default signature for the user."
    },
    "stampType": {
      "type": "string",
      "description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null"
    },
    "externalID": {
      "type": "string",
      "description": "Optionally specify an external identifier for the user's signature."
    },
    "nrdsStatus": {
      "type": "string",
      "description": "The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:\n\n- `Active`\n- `Inactive`\n- `Terminate`\n- `Provisional`\n- `Deceased`\n- `Suspend`\n- `Unknown`"
    },
    "customField": {
      "type": "string",
      "description": ""
    },
    "imageBase64": {
      "type": "string",
      "description": ""
    },
    "signatureId": {
      "type": "string",
      "description": "Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID."
    },
    "stampFormat": {
      "type": "string",
      "description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. "
    },
    "stampSizeMM": {
      "type": "string",
      "description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "nrdsLastName": {
      "type": "string",
      "description": "The realtor's last name."
    },
    "phoneticName": {
      "type": "string",
      "description": "The phonetic spelling of the `signatureName`."
    },
    "signatureFont": {
      "type": "string",
      "description": "The font type to use for the signature if the signature is not drawn. The following font styles  are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n"
    },
    "signatureName": {
      "type": "string",
      "description": "Specifies the user's signature name."
    },
    "signatureType": {
      "type": "string",
      "description": "Specifies the type of signature."
    },
    "stampImageUri": {
      "type": "string",
      "description": "The URI for retrieving the image of the user's stamp."
    },
    "signatureUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signatureUser"
      },
      "description": ""
    },
    "adoptedDateTime": {
      "type": "string",
      "description": "The UTC date and time when the user adopted the signature."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "signatureGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signatureGroup"
      },
      "description": ""
    },
    "signatureRights": {
      "type": "string",
      "description": "The rights that the user has to the signature. Valid values are:\n\n- `none`\n- `read`\n- `admin`"
    },
    "initialsImageUri": {
      "type": "string",
      "description": "The URI for retrieving the image of the user's initials."
    },
    "signatureImageUri": {
      "type": "string",
      "description": "An endpoint URI that you can use to retrieve the user's signature image."
    },
    "signatureInitials": {
      "type": "string",
      "description": "Specifies the user's signature in initials format."
    },
    "initials150ImageId": {
      "type": "string",
      "description": "The ID of the user's initials image."
    },
    "dateStampProperties": {
      "$ref": "#/components/schemas/dateStampProperties"
    },
    "signature150ImageId": {
      "type": "string",
      "description": "The ID of the user's signature image."
    },
    "lastModifiedDateTime": {
      "type": "string",
      "description": "The date and time that the item was last modified."
    },
    "disallowUserResizeStamp": {
      "type": "string",
      "description": "When **true,** users may not resize the stamp."
    }
  },
  "x-ds-order": "40",
  "description": "AccountSignatures represent stamps used to sign documents.",
  "x-ms-summary": "AccountSignatures represent stamps used to sign documents.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "accountSignature"
}
string AccountSignaturesGetAccountSignatureImageResponse 
{
  "type": "string",
  "format": "binary"
}
object AccountTabSettings 
{
  "type": "object",
  "properties": {
    "allowTabOrder": {
      "type": "string",
      "description": "When **true,** account users can set a tab order for the signing process.\n\n**Note:** Only Admin users can change this setting."
    },
    "drawTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "listTabsEnabled": {
      "type": "string",
      "description": "When **true,** list tabs are enabled."
    },
    "noteTabsEnabled": {
      "type": "string",
      "description": "When **true,** note tabs are enabled."
    },
    "tabScaleEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "textTabsEnabled": {
      "type": "string",
      "description": "When **true,** text tabs are enabled."
    },
    "drawTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "listTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "noteTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "radioTabsEnabled": {
      "type": "string",
      "description": "When **true,** radio button tabs are enabled."
    },
    "tabScaleMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "textTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "radioTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabLockingEnabled": {
      "type": "string",
      "description": "When **true,** tab locking is enabled.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "prefillTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "tabLocationEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "tabLockingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "checkboxTabsEnabled": {
      "type": "string",
      "description": "When **true,** checkbox tabs are enabled."
    },
    "prefillTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabDataLabelEnabled": {
      "type": "string",
      "description": "When **true,** [data\nlabels](https://support.docusign.com/en/videos/Data-Labels) are enabled.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "tabLocationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "checkBoxTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldSizeEnabled": {
      "type": "string",
      "description": "When **true,** setting character limits for input fields is enabled."
    },
    "numericalTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "tabDataLabelMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowTabOrderMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldRegexEnabled": {
      "type": "string",
      "description": "When **true,** regular expressions are enabled for tabs that contain data fields."
    },
    "dataFieldSizeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "numericalTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldRegexMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "calculatedFieldsEnabled": {
      "type": "string",
      "description": "When **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs."
    },
    "savingCustomTabsEnabled": {
      "type": "string",
      "description": "When **true,** saving custom tabs is enabled."
    },
    "sharedCustomTabsEnabled": {
      "type": "string",
      "description": "When **true,** shared custom tabs are enabled."
    },
    "calculatedFieldsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "savingCustomTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "sharedCustomTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabTextFormattingEnabled": {
      "type": "string",
      "description": "When **true,** text formatting (such as font type, font size,\nfont color, bold, italic, and underline) is enabled for tabs that\nsupport formatting.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "approveDeclineTabsEnabled": {
      "type": "string",
      "description": "When **true,** approve and decline tabs are enabled."
    },
    "firstLastEmailTabsEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "tabTextFormattingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "approveDeclineTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "firstLastEmailTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "senderToChangeTabAssignmentsEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "senderToChangeTabAssignmentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "x-ds-order": "100",
  "description": "Tab settings determine the tab types and tab functionality that are enabled for an account.",
  "x-ms-summary": "Tab settings determine the tab types and tab functionality that are enabled for an account.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "tabAccountSettings"
}
object AccountWatermarks 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique ID for the Salesforce object."
    },
    "font": {
      "type": "string",
      "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
    },
    "enabled": {
      "type": "string",
      "description": ""
    },
    "fontSize": {
      "type": "string",
      "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
    },
    "fontColor": {
      "type": "string",
      "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
    },
    "imageBase64": {
      "type": "string",
      "description": ""
    },
    "displayAngle": {
      "type": "string",
      "description": ""
    },
    "transparency": {
      "type": "string",
      "description": ""
    },
    "watermarkText": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "200",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "watermark"
}
object Accounts 
{
  "type": "object",
  "properties": {
    "brands": {
      "$ref": "#/components/schemas/AccountBrands"
    },
    "planName": {
      "type": "string",
      "description": "The name of the billing plan used for the account.\n\nExamples: \n\n- `Personal - Annual`\n- `Unlimited Envelope Subscription - Annual Billing`"
    },
    "dssValues": {
      "type": "object",
      "description": "",
      "additionalProperties": {
        "type": "string"
      }
    },
    "canUpgrade": {
      "type": "string",
      "description": "When **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response."
    },
    "seatsInUse": {
      "type": "string",
      "description": "The number of users currently active on the account."
    },
    "accountName": {
      "type": "string",
      "description": "The name on the account."
    },
    "createdDate": {
      "type": "string",
      "description": "The creation date of the account in UTC timedate format."
    },
    "isDowngrade": {
      "type": "string",
      "description": "When **true,** the account has been downgraded from a premium account type. Otherwise **false.**"
    },
    "planEndDate": {
      "type": "string",
      "description": "The date that the current plan will end."
    },
    "currencyCode": {
      "type": "string",
      "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n"
    },
    "seatsAllowed": {
      "type": "string",
      "description": "The number of active users the account can have at one time."
    },
    "accountIdGuid": {
      "type": "string",
      "description": "The GUID associated with the account ID."
    },
    "currentPlanId": {
      "type": "string",
      "description": "ID of the plan used to create this account."
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "planStartDate": {
      "type": "string",
      "description": "The date that the Account started using the current plan."
    },
    "billingProfile": {
      "type": "string",
      "description": "The type of billing method on the account. Valid values are: \n\n- `direct`\n- `web`"
    },
    "suspensionDate": {
      "type": "string",
      "description": "The date on which the account was suspended."
    },
    "accountSettings": {
      "$ref": "#/components/schemas/accountSettingsInformation"
    },
    "distributorCode": {
      "type": "string",
      "description": "The code that identifies the billing plan groups and plans for the new account."
    },
    "recipientDomains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientDomain"
      },
      "description": ""
    },
    "suspensionStatus": {
      "type": "string",
      "description": "Indicates whether the account is currently suspended."
    },
    "connectPermission": {
      "type": "string",
      "description": ""
    },
    "envelopeUnitPrice": {
      "type": "string",
      "description": "The price of sending an envelope, represented in the account's local currency."
    },
    "externalAccountId": {
      "type": "string",
      "description": "The Account ID displayed on the user's Account page."
    },
    "status21CFRPart11": {
      "type": "string",
      "description": "The status of the account content per (Title 21 CFR Part 11)[https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application]. This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy."
    },
    "docuSignLandingUrl": {
      "type": "string",
      "description": "URL of the landing page used to create the account."
    },
    "planClassification": {
      "type": "string",
      "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`"
    },
    "displayApplianceUrl": {
      "type": "string",
      "description": ""
    },
    "useDisplayAppliance": {
      "type": "boolean",
      "description": ""
    },
    "billingPeriodEndDate": {
      "type": "string",
      "description": "The billing period end date in UTC timedate format."
    },
    "allowTransactionRooms": {
      "type": "string",
      "description": "When **true,** the transaction rooms feature exposed through the Workspaces API is enabled."
    },
    "billingPeriodStartDate": {
      "type": "string",
      "description": "The billing period start date in UTC timedate format."
    },
    "envelopeSendingBlocked": {
      "type": "string",
      "description": "When **true,** the ability to send envelopes is blocked. When **false,** envelopes can be sent."
    },
    "displayApplianceStartUrl": {
      "type": "string",
      "description": ""
    },
    "billingPeriodDaysRemaining": {
      "type": "string",
      "description": "Number of days remaining in the current billing period."
    },
    "billingPeriodEnvelopesSent": {
      "type": "string",
      "description": "The number of envelopes that have been sent in the current billing period."
    },
    "billingPeriodEnvelopesAllowed": {
      "type": "string",
      "description": "The number of envelopes that can be sent in the current billing period (can be unlimited)."
    },
    "forgottenPasswordQuestionsCount": {
      "type": "string",
      "description": " A complex element that contains up to four Question/Answer pairs for forgotten password information for a user."
    }
  },
  "x-ds-order": "1",
  "description": "Account management",
  "x-ms-summary": "Account management",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "accountInformation"
}
string ApiRequestLogGetRequestLogResponse 
{
  "type": "string",
  "format": "binary"
}
string AttachmentsGetAttachmentResponse 
{
  "type": "string",
  "format": "binary"
}
object Authorizations 
{
  "type": "object",
  "properties": {
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user authorization was created."
    },
    "endDate": {
      "type": "string",
      "description": ""
    },
    "modified": {
      "type": "string",
      "description": ""
    },
    "agentUser": {
      "$ref": "#/components/schemas/authorizationUser"
    },
    "createdBy": {
      "type": "string",
      "description": ""
    },
    "startDate": {
      "type": "string",
      "description": ""
    },
    "modifiedBy": {
      "type": "string",
      "description": "The user ID (GUID) of the user who last modified this user record. This property is read-only."
    },
    "permission": {
      "type": "string",
      "description": ""
    },
    "principalUser": {
      "$ref": "#/components/schemas/authorizationUser"
    },
    "authorizationId": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "100",
  "description": "Authorizations allow you to share access between users on an account.",
  "x-ms-summary": "Authorizations allow you to share access between users on an account.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "userAuthorization"
}
object BCCEmailArchive 
{
  "type": "object",
  "properties": {
    "nextUri": {
      "type": "string",
      "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
    },
    "endPosition": {
      "type": "string",
      "description": "The last index position in the result set. "
    },
    "previousUri": {
      "type": "string",
      "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
    },
    "totalSetSize": {
      "type": "string",
      "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
    },
    "resultSetSize": {
      "type": "string",
      "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
    },
    "startPosition": {
      "type": "string",
      "description": "The starting index position of the current result set."
    },
    "bccEmailArchiveHistory": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bccEmailArchiveHistory"
      },
      "description": "A list of changes to the BCC email archive configuration."
    }
  },
  "x-ds-order": "120",
  "description": "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.\n",
  "x-ms-summary": "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.\n",
  "x-ds-category": "EmailArchive",
  "x-ds-definition-name": "bccEmailArchiveHistoryList"
}
object BillingPlans 
{
  "type": "object",
  "properties": {
    "billingPlan": {
      "$ref": "#/components/schemas/accountBillingPlan"
    },
    "taxExemptId": {
      "type": "string",
      "description": ""
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "billingAddress": {
      "$ref": "#/components/schemas/accountAddress"
    },
    "successorPlans": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPlan"
      },
      "description": "A list of billing plans that the current billing plan can be rolled into."
    },
    "entityInformation": {
      "$ref": "#/components/schemas/billingEntityInformationResponse"
    },
    "referralInformation": {
      "$ref": "#/components/schemas/referralInformation"
    },
    "creditCardInformation": {
      "$ref": "#/components/schemas/creditCardInformation"
    },
    "downgradePlanInformation": {
      "$ref": "#/components/schemas/downgradePlanUpdateResponse"
    },
    "downgradeRequestInformation": {
      "$ref": "#/components/schemas/downgradeRequestInformation"
    },
    "paymentProcessorInformation": {
      "$ref": "#/components/schemas/paymentProcessorInformation"
    },
    "directDebitProcessorInformation": {
      "$ref": "#/components/schemas/directDebitProcessorInformation"
    },
    "billingAddressIsCreditCardAddress": {
      "type": "string",
      "description": "When **true,** the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different."
    }
  },
  "x-ds-order": "10",
  "description": "Billing plans",
  "x-ms-summary": "Billing plans",
  "x-ds-category": "Billing",
  "x-ds-definition-name": "accountBillingPlanResponse"
}
string BrandLogoGetBrandLogoResponse 
{
  "type": "string",
  "format": "binary"
}
string BrandLogoPutBrandLogoRequest 
{
  "type": "string",
  "format": "binary"
}
object BrandResourcesPutBrandResourcesRequest 
{
  "type": "object",
  "required": [
    "file.xml"
  ],
  "properties": {
    "file.xml": {
      "type": "string",
      "format": "binary",
      "description": "Brand resource XML file."
    }
  }
}
object BulkSend 
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the bulk send list."
    },
    "listId": {
      "type": "string",
      "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list."
    },
    "bulkCopies": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkSendingCopy"
      },
      "description": "An array of `bulkCopy` objects. Each object represents an instance or copy of an envelope and contains details such as the recipient, custom fields, tabs, and other information."
    }
  },
  "x-ds-order": "120",
  "description": "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. \n\n**Note:** The Bulk Send feature is only available on Business Pro and Enterprise Pro plans.",
  "x-ms-summary": "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. \n\n**Note:** The Bulk Send feature is only available on Business Pro and Enterprise Pro plans.",
  "x-ds-category": "BulkEnvelopes",
  "x-ds-definition-name": "bulkSendingList"
}
object ChunkedUploads 
{
  "type": "object",
  "properties": {
    "checksum": {
      "type": "string",
      "description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused."
    },
    "committed": {
      "type": "string",
      "description": "When **true,** the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests. "
    },
    "totalSize": {
      "type": "string",
      "description": "The total size of the parts of the chunked upload.\n\n**Note:** When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents."
    },
    "maxTotalSize": {
      "type": "string",
      "description": "The maximum total size allowed for a chunked upload. This value is configured per DocuSign environment, account, or integrator. The default value is 50 MB."
    },
    "chunkedUploadId": {
      "type": "string",
      "description": "The ID of the chunked upload. "
    },
    "chunkedUploadUri": {
      "type": "string",
      "description": "The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests. "
    },
    "chunkedUploadParts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/chunkedUploadPart"
      },
      "description": "A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload."
    },
    "expirationDateTime": {
      "type": "string",
      "description": "The UTC time at which the chunked upload expires and is no longer addressable. \n\n**Note:** The length of time before expiration is configurable, and begins when you initiate the chunked upload. You must fully upload and use a chunked upload within this time. The default value for this duration is 20 minutes."
    },
    "maxChunkedUploadParts": {
      "type": "string",
      "description": "The maximum number of parts allowed for a chunked upload. This value is configurable per DocuSign environment, account, or integrator. The default value is 128. The maximum possible value is 256.  \n"
    }
  },
  "x-ds-order": "150",
  "description": "The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads.",
  "x-ms-summary": "The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "chunkedUploadResponse"
}
object CloudStorage 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique ID for the Salesforce object."
    },
    "name": {
      "type": "string",
      "description": "The name of the cloud storage item."
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/externalFile"
      },
      "description": "A list of objects that contain information about a file or folder in cloud storage."
    },
    "nextUri": {
      "type": "string",
      "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
    },
    "endPosition": {
      "type": "string",
      "description": "The last index position in the result set. "
    },
    "previousUri": {
      "type": "string",
      "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
    },
    "errorDetails": {
      "$ref": "#/components/schemas/externalDocServiceErrorDetails"
    },
    "totalSetSize": {
      "type": "string",
      "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
    },
    "resultSetSize": {
      "type": "string",
      "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
    },
    "startPosition": {
      "type": "string",
      "description": "The starting index position of the current result set."
    }
  },
  "x-ds-order": "10",
  "description": "Cloud storage",
  "x-ms-summary": "Cloud storage",
  "x-ds-category": "CloudStorage",
  "x-ds-definition-name": "externalFolder"
}
object CloudStorageProviders 
{
  "type": "object",
  "properties": {
    "storageProviders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/cloudStorageProvider"
      },
      "description": "An Array containing the storage providers associated with the user."
    }
  },
  "x-ds-order": "20",
  "description": "The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.",
  "x-ms-summary": "The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.",
  "x-ds-category": "CloudStorage",
  "x-ds-definition-name": "cloudStorageProviders"
}
object Comments 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique ID for the Salesforce object."
    },
    "hmac": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "read": {
      "type": "boolean",
      "description": "Indicates if the comment has been read by the target recipient of the comment."
    },
    "text": {
      "type": "string",
      "description": "Specifies the text that is shown in the dropdown list. "
    },
    "tabId": {
      "type": "string",
      "description": "The unique identifier for the tab."
    },
    "subject": {
      "type": "string",
      "description": ""
    },
    "mentions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of userIds that are mentioned directly in the body of a comment."
    },
    "threadId": {
      "type": "string",
      "description": "The unique identifier for the comment thread."
    },
    "timestamp": {
      "type": "string",
      "description": ""
    },
    "visibleTo": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "sentByEmail": {
      "type": "string",
      "description": ""
    },
    "sentByUserId": {
      "type": "string",
      "description": ""
    },
    "sentByImageId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "sentByFullName": {
      "type": "string",
      "description": ""
    },
    "sentByInitials": {
      "type": "string",
      "description": ""
    },
    "signingGroupId": {
      "type": "string",
      "description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
    },
    "signingGroupName": {
      "type": "string",
      "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
    },
    "sentByRecipientId": {
      "type": "string",
      "description": ""
    },
    "threadOriginatorId": {
      "type": "string",
      "description": "The userId of the user who created the thread."
    },
    "timeStampFormatted": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "160",
  "description": "Details about envelope comments.",
  "x-ms-summary": "Details about envelope comments.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "comment"
}
string CommentsGetCommentsTranscriptResponse 
{
  "type": "string",
  "format": "binary"
}
object ConnectConfigurations 
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the Connect configuration. The name helps identify the configuration in the list."
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `urlToPublishTo` property.\n\nSet this property when you are using the [JSON SIM event model](https://raw.githubusercontent.com). If you are instead using any of [the legacy event message formats](https://raw.githubusercontent.com), set either the `envelopeEvents` property or the `recipientEvents` property.\n\nThe [possible event statuses](/platform/webhooks/connect/improved-json-sim-event-model/#eventreference) are:\n\n* `envelope-created`\n* `envelope-sent`\n* `envelope-resent`\n* `envelope-delivered`\n* `envelope-completed`\n* `envelope-declined`\n* `envelope-voided`\n* `recipient-authenticationfailed`\n* `recipient-autoresponded`\n* `recipient-declined`\n* `recipient-delivered`\n* `recipient-completed`\n* `recipient-sent`\n* `recipient-resent`\n* `template-created`\n* `template-modified`\n* `template-deleted`\n* `envelope-corrected`\n* `envelope-purge`\n* `envelope-deleted`\n* `envelope-discard`\n* `recipient-reassign`\n* `recipient-delegate`\n* `recipient-finish-later`\n* `click-agreed`\n* `click-declined`\n"
    },
    "userIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of user IDs. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener.\n\nBy default, the users will be included in the configuration. If you want to exclude the users, set the `allUsersExcept` property to **true.**\n\n**Note:** If `allUsers` is set to `false`, then you must provide a list of user IDs."
    },
    "allUsers": {
      "type": "string",
      "description": "When **true,** the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. The default value is **false.**\n\n**Note:** If this property is **false,** make sure you set the `userIds` property to a non-empty array of user IDs."
    },
    "groupIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "userName": {
      "type": "string",
      "description": "The name of the user."
    },
    "connectId": {
      "type": "string",
      "description": "The DocuSign-generated ID for the Connect configuration. This property is read-only."
    },
    "enableLog": {
      "type": "string",
      "description": "When **true,** Connect logging is turned on. DocuSign recommends that you enable this functionality to help troubleshoot any issues. \n\nYou can have a maximum of 100 active logs in your account. You can view the entries in active logs in the **Logs** tab in the Connect console."
    },
    "eventData": {
      "$ref": "#/components/schemas/connectEventData"
    },
    "sfObjects": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectSalesforceObject"
      },
      "description": "An array of Salesforce objects."
    },
    "disabledBy": {
      "type": "string",
      "description": ""
    },
    "includeHMAC": {
      "type": "string",
      "description": "When **true,** a Hash-based Message Authentication Code (HMAC) signature is included in messages sent through Connect.\nFor more information, see [Using HMAC Security with DocuSign Connect](https://raw.githubusercontent.com)."
    },
    "deliveryMode": {
      "type": "string",
      "description": ""
    },
    "includeOAuth": {
      "type": "string",
      "description": ""
    },
    "soapNamespace": {
      "type": "string",
      "description": "The namespace of the SOAP interface.\n\n**Note:** If `useSoapInterface` is set to **true,** you must set this value."
    },
    "allUsersExcept": {
      "type": "string",
      "description": "This flag allows you to toggle between including and excluding specified users from the configuration. When **false,** the users corresponding to the IDs in `userIds` will be included in the configuration. Conversely, when **true,** the users will be excluded from the configuration. The default value is **false.**"
    },
    "envelopeEvents": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of strings that lists envelope-related events to track through Connect. The possible event values are: \n\n- `sent`: An envelope has the status `sent` in the following scenarios:\n   - When the envelope has been sent to recipients.\n   - When using remote signing, this event is triggered when the email notification with a link to the documents is sent to at least one recipient.\n   - When using embedded signing, this event is triggered when the link is ready for the recipient to sign the envelope.\n\n   An envelope remains in this state until all recipients have viewed or taken action on the envelope.\n\n- `delivered`: This status is triggered when all recipients have opened the envelope, selected the **Continue** button in the interface, and viewed the documents.\n- `completed`: This status is triggered when all recipients have completed their assigned actions on an envelope.\n- `declined`: This status is triggered when a recipient has declined to sign the envelope.\n- `voided`: The voided status indicates that the sender has voided the envelope.\n\n**Note:** In previous versions of the API, this value was a single comma-separated string.\n"
    },
    "senderOverride": {
      "type": "string",
      "description": ""
    },
    "urlToPublishTo": {
      "type": "string",
      "description": "The endpoint to which Connect should send webhook notification messages via an HTTPS POST request. The URL must start with `https`. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not acceptable, but you can use free certificates from Let's Encrypt.\n\nThe maximum length of this property is 4096 bytes."
    },
    "recipientEvents": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of strings that lists of recipient-related events that trigger a notification\nto your webhook Connect listener. The possible event values are:\n\n- `sent`: If a recipient type is set to receive an email notification to take action on an envelope, the recipient status is set to `sent` upon delivery of the email.\n- `delivered`: The recipient has viewed the documents in the envelope. This recipient status does not indicate email delivery of the documents in the envelope.\n- `completed`: The recipient has completed their assigned actions on an envelope.\n- `declined`: The recipient has declined to sign a document in the envelope.\n- `authenticationfailed`: At least one signer has failed the authentication check on the document. If this occurs, you have two options:\n   - Send a reminder to the recipients, which provides the signer with another chance to access and pass the authentication.\n   - Correct the document and modify the authentication setting.\n- `autoresponded`: The recipient's email system sent back an automatic response. This status is only used when **Send-on-behalf-of** is turned off for the account.\n\n**Note:** In previous versions of the API, this value was a single comma-separated string.\n"
    },
    "externalFolderId": {
      "type": "string",
      "description": "The ID of an external folder."
    },
    "includeDocuments": {
      "type": "string",
      "description": "When **true,**\nConnect attaches the envelope documents\nto the payloads of your event notification messages.\n\n**Note:** Consider resources and scaling when adding documents\nto your event payloads. Documents attached to these messages\nare sent as base64 strings,\nwhich are larger than binary document data.\nThis can significantly increase your payload size,\nopening up windows for failure.\nIf you include documents,\nyou must build your application to scale in these situations."
    },
    "requireMutualTls": {
      "type": "string",
      "description": "When **true,** [Mutual TLS](https://raw.githubusercontent.com) authentication is enabled."
    },
    "useSoapInterface": {
      "type": "string",
      "description": "When **true,** indicates that the `urlToPublishTo` property contains a SOAP endpoint."
    },
    "configurationType": {
      "type": "string",
      "description": "If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`."
    },
    "integratorManaged": {
      "type": "string",
      "description": ""
    },
    "salesforceAuthcode": {
      "type": "string",
      "description": ""
    },
    "externalFolderLabel": {
      "type": "string",
      "description": "The label for an external folder."
    },
    "allowEnvelopePublish": {
      "type": "string",
      "description": "When **true,** data is sent to the `urlToPublishTo` web address. The default value for this property is **false,** which will stop sending data while maintaining the Connect configuration information."
    },
    "salesforceApiVersion": {
      "type": "string",
      "description": "The version of the Salesforce API that you are using."
    },
    "includeCertSoapHeader": {
      "type": "string",
      "description": "When **true,** a certificate for a SOAP header is included in messages sent through Connect."
    },
    "includeDocumentFields": {
      "type": "string",
      "description": "When **true,** the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. "
    },
    "salesforceCallBackUrl": {
      "type": "string",
      "description": ""
    },
    "senderSelectableItems": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "This property sets the items that are available for selection when adding or editing Connect objects. "
    },
    "allowSalesforcePublish": {
      "type": "string",
      "description": "When **true,** DocuSign sends data to the designated Salesforce account through Connect. The default value is **true.**"
    },
    "requiresAcknowledgement": {
      "type": "string",
      "description": "When **true,** event delivery acknowledgements are enabled for your Connect configuration.\n\nDocuSign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back.\n\n#### When **true** and Send Individual Messages (SIM) mode is activated\n\nIf the HTTP status response to a notification message is not in the range of 200-299,\nthen the message delivery failed, and the configuration is marked as down.\n\nThe message will be queued and retried once per day.\nWhile a Connect configuration is marked down, subsequent notifications will not be tried. Instead they will be immediately queued with the reason `Pending`.\nWhen a message succeeds, all queued messages for the configuration will be tried immediately, in order.\n\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **true** and SIM mode is not activated\n\nIf the HTTP Status response to a notification message is not in the range of 200-299,  then the message delivery failed, and the message is queued.\n\nThe message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription).  Subsequent notifications will be tried when they occur.\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **false**\n\nWhen `requiresAcknowledgement` is set to **false** and you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.\n\n"
    },
    "includeEnvelopeVoidReason": {
      "type": "string",
      "description": "When **true,** Connect will include the voidedReason for voided envelopes."
    },
    "includeTimeZoneInformation": {
      "type": "string",
      "description": "When **true,** Connect will include the envelope time zone information."
    },
    "includeCertificateOfCompletion": {
      "type": "string",
      "description": "When **true,** the Connect Service includes the Certificate of Completion with completed envelopes. "
    },
    "signMessageWithX509Certificate": {
      "type": "string",
      "description": "When **true,** Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. "
    },
    "includeSenderAccountasCustomField": {
      "type": "string",
      "description": "When **true,** Connect will include the sender account as Custom Field in the data."
    },
    "salesforceDocumentsAsContentFiles": {
      "type": "string",
      "description": "When **true,** DocuSign can use documents in your Salesforce account for sending and signing."
    }
  },
  "x-ds-order": "10",
  "description": "Contains information about a DocuSign Connect configuration.",
  "x-ms-summary": "Contains information about a DocuSign Connect configuration.",
  "x-ds-category": "Connect",
  "x-ds-definition-name": "connectCustomConfiguration"
}
object ConnectEvents 
{
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectLog"
      },
      "description": "A list of Connect general logs."
    },
    "type": {
      "type": "string",
      "description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`\n"
    },
    "failures": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectLog"
      },
      "description": "A list of Connect failure logs."
    },
    "totalRecords": {
      "type": "string",
      "description": "The count of records in the log list."
    }
  },
  "x-ds-order": "20",
  "description": "Connect event logging information. This object contains sections for regular Connect logs and for Connect failures. ",
  "x-ms-summary": "Connect event logging information. This object contains sections for regular Connect logs and for Connect failures. ",
  "x-ds-category": "Connect",
  "x-ds-definition-name": "connectLogs"
}
object ConnectSecret 
{
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectLog"
      },
      "description": "A list of Connect general logs."
    },
    "type": {
      "type": "string",
      "description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`\n"
    },
    "failures": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectLog"
      },
      "description": "A list of Connect failure logs."
    },
    "totalRecords": {
      "type": "string",
      "description": "The count of records in the log list."
    }
  },
  "x-ds-order": "50",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Connect",
  "x-ds-definition-name": "connectLogs"
}
object Contacts 
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the contact."
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The email address or addresses associated with the contact."
    },
    "shared": {
      "type": "string",
      "description": "When **true,** the contact is shared. For more information, see [Shared Contacts](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=twh1578456324503.html).\n\n**Note:** The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:\n\n- Sending an envelope by using SMS\n- Using phone authentication\n\nYou must ask the user who added the contact for the phone number and then manually enter it into the authentication box."
    },
    "isOwner": {
      "type": "boolean",
      "description": "When **true,** the current user is the owner of the contact."
    },
    "contactId": {
      "type": "string",
      "description": "The ID of a contact person in the account's address book."
    },
    "contactUri": {
      "type": "string",
      "description": "The URI for retrieving information about the contact."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "organization": {
      "type": "string",
      "description": "The name of the contact's organization."
    },
    "signingGroup": {
      "type": "string",
      "description": "If the contact belongs to a signing group, this property contains the `signingGroupId`."
    },
    "cloudProvider": {
      "type": "string",
      "description": "The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)\n\n<!-- Future:\n\n- `Box`\n- `GoogleDrive`\n- `Dropbox`\n- `SalesForce`\n- `SkyDrive`\n\n-->"
    },
    "roomContactType": {
      "type": "string",
      "description": ""
    },
    "signingGroupName": {
      "type": "string",
      "description": "The name of the signing group that the contact belongs to."
    },
    "contactPhoneNumbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contactPhoneNumber"
      },
      "description": "A list of the contact's phone numbers.\n\n**Note:** The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:\n\n- Sending an envelope by using SMS\n- Using phone authentication\n\nYou must ask the user who added the contact for the phone number and then manually enter it into the authentication box."
    },
    "notaryContactDetails": {
      "$ref": "#/components/schemas/notaryContactDetails"
    },
    "cloudProviderContainerId": {
      "type": "string",
      "description": "The ID of the container at the cloud provider. For example, this might be the room ID for a DocuSign Transaction Room."
    }
  },
  "x-ds-order": "50",
  "description": "The `Contacts` resource enables you to manage the contact in an account's address book.",
  "x-ms-summary": "The `Contacts` resource enables you to manage the contact in an account's address book.",
  "x-ds-category": "Users",
  "x-ds-definition-name": "contact"
}
object CustomTabs 
{
  "type": "object",
  "properties": {
    "bold": {
      "type": "string",
      "description": "When **true,** the information in the tab is bold."
    },
    "font": {
      "type": "string",
      "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
    },
    "name": {
      "type": "string",
      "description": "The name of the custom tab."
    },
    "type": {
      "type": "string",
      "description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "If the tab is a list, this represents the values that are possible for the tab."
    },
    "width": {
      "type": "string",
      "description": "The width of the tab in pixels.\nMust be an integer."
    },
    "anchor": {
      "type": "string",
      "description": "An optional string that is used to auto-match tabs to strings located in the documents of an envelope."
    },
    "height": {
      "type": "string",
      "description": "The height of the tab in pixels.\nMust be an integer."
    },
    "italic": {
      "type": "string",
      "description": "When **true,** the information in the tab is italic."
    },
    "locked": {
      "type": "string",
      "description": "When **true,** the signer cannot change the data of the custom tab."
    },
    "shared": {
      "type": "string",
      "description": "When **true,** this custom tab is shared."
    },
    "editable": {
      "type": "string",
      "description": "When **true,** the custom tab is editable. Otherwise the custom tab cannot be modified."
    },
    "fontSize": {
      "type": "string",
      "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
    },
    "required": {
      "type": "string",
      "description": "When **true,** the signer is required to fill out this tab."
    },
    "selected": {
      "type": "string",
      "description": "When **true,** the radio button is selected."
    },
    "tabLabel": {
      "type": "string",
      "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
    },
    "fontColor": {
      "type": "string",
      "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
    },
    "stampType": {
      "type": "string",
      "description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null"
    },
    "underline": {
      "type": "string",
      "description": "When **true,** the information in the tab is underlined."
    },
    "mergeField": {
      "$ref": "#/components/schemas/mergeField"
    },
    "requireAll": {
      "type": "string",
      "description": "When **true** and shared is true, information must be entered in this field to complete the envelope. "
    },
    "scaleValue": {
      "type": "string",
      "description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size."
    },
    "anchorUnits": {
      "type": "string",
      "description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
    },
    "customTabId": {
      "type": "string",
      "description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all of the custom tab properties."
    },
    "initialValue": {
      "type": "string",
      "description": "The original value of the tab."
    },
    "lastModified": {
      "type": "string",
      "description": "The UTC DateTime this object was last modified. This is in ISO 8601 format."
    },
    "localePolicy": {
      "$ref": "#/components/schemas/localePolicyTab"
    },
    "anchorXOffset": {
      "type": "string",
      "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
    },
    "anchorYOffset": {
      "type": "string",
      "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
    },
    "collaborative": {
      "type": "string",
      "description": ""
    },
    "maximumLength": {
      "type": "string",
      "description": "The maximum number of entry characters supported by the custom tab."
    },
    "numericalValue": {
      "type": "string",
      "description": ""
    },
    "validationType": {
      "type": "string",
      "description": "Specifies how numerical data is validated. Valid values:\n\n- `number`\n- `currency`\n"
    },
    "createdByUserId": {
      "type": "string",
      "description": "The userId of the DocuSign user who created this object."
    },
    "disableAutoSize": {
      "type": "string",
      "description": "When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes."
    },
    "includedInEmail": {
      "type": "string",
      "description": "When **true,** the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs."
    },
    "paymentItemCode": {
      "type": "string",
      "description": "If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id.\n\nExample: `SHAK1`\n\nMaximum Length: 100 characters."
    },
    "paymentItemName": {
      "type": "string",
      "description": "If the custom tab is for a payment request, this is the name of the item associated with the charge.\n\nMaximum Length: 100 characters.\n\nExample: `Hamlet`"
    },
    "maxNumericalValue": {
      "type": "string",
      "description": ""
    },
    "minNumericalValue": {
      "type": "string",
      "description": ""
    },
    "stampTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "validationMessage": {
      "type": "string",
      "description": "The message displayed if the custom tab fails input validation (either custom of embedded)."
    },
    "validationPattern": {
      "type": "string",
      "description": "A regular expression used to validate input for the tab."
    },
    "anchorCaseSensitive": {
      "type": "string",
      "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n  $~><|^+=\n\n  For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n  Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n  Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n  Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
    },
    "signatureProviderId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "anchorMatchWholeWord": {
      "type": "string",
      "description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n  $~><|^+=\n\n  For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n  Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n  Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n  Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
    },
    "createdByDisplayName": {
      "type": "string",
      "description": "The user name of the DocuSign user who created this object."
    },
    "lastModifiedByUserId": {
      "type": "string",
      "description": "The userId of the DocuSign user who last modified this object."
    },
    "concealValueOnDocument": {
      "type": "string",
      "description": "When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes."
    },
    "paymentItemDescription": {
      "type": "string",
      "description": "If the custom tab is for a payment request, this is the description of the item associated with the charge.\n\nExample: `The Danish play by Shakespeare`\n\nMaximum Length: 100 characters."
    },
    "anchorIgnoreIfNotPresent": {
      "type": "string",
      "description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
    },
    "anchorHorizontalAlignment": {
      "type": "string",
      "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
    },
    "lastModifiedByDisplayName": {
      "type": "string",
      "description": "The User Name of the DocuSign user who last modified this object."
    },
    "requireInitialOnSharedChange": {
      "type": "string",
      "description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field."
    }
  },
  "x-ds-order": "10",
  "description": "Custom tabs",
  "x-ms-summary": "Custom tabs",
  "x-ds-category": "CustomTabs",
  "x-ds-definition-name": "tabMetadata"
}
object DocumentGeneration 
{
  "type": "object",
  "properties": {
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "docGenFormFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/docGenFormFields"
      },
      "description": ""
    }
  },
  "x-ds-order": "100",
  "description": "Document Generation for eSignature allows you to\ndynamically generate\ndocuments from a Word template to send for\nsignature within the eSignature sending workflow.",
  "x-ms-summary": "Document Generation for eSignature allows you to\ndynamically generate\ndocuments from a Word template to send for\nsignature within the eSignature sending workflow.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "docGenFormFieldResponse"
}
object DocumentResponsiveHtml 
{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "100",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentHtmlDefinitionOriginals"
}
object DocumentResponsiveHtmlPreview 
{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "230",
  "description": "This resource is used to create a responsive preview of a specific document.",
  "x-ms-summary": "This resource is used to create a responsive preview of a specific document.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentHtmlDefinitions"
}
string DocumentsGetDocumentResponse 
{
  "type": "string",
  "format": "binary"
}
string DocumentsGetTemplateDocumentResponse 
{
  "type": "string",
  "format": "binary"
}
string DocumentsPutDocumentRequest 
{
  "type": "string",
  "format": "binary"
}
object ENoteConfigurations 
{
  "type": "object",
  "properties": {
    "apiKey": {
      "type": "string",
      "description": ""
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "userName": {
      "type": "string",
      "description": "The name of the user."
    },
    "organization": {
      "type": "string",
      "description": ""
    },
    "eNoteConfigured": {
      "type": "string",
      "description": ""
    },
    "connectConfigured": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "110",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "eNoteConfiguration"
}
object EnvelopeAttachments 
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the attachment."
    },
    "label": {
      "type": "string",
      "description": "A label for the attachment. Potential values include: \n\n- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.\n- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. "
    },
    "attachmentId": {
      "type": "string",
      "description": "The unique identifier for the attachment."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "accessControl": {
      "type": "string",
      "description": "Valid values are `sender` and `senderAndAllRecipients`."
    },
    "attachmentType": {
      "type": "string",
      "description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`"
    }
  },
  "x-ds-order": "60",
  "description": "The EnvelopeAttachments resource provides methods that allow you to\nassociate files with an envelope.",
  "x-ms-summary": "The EnvelopeAttachments resource provides methods that allow you to\nassociate files with an envelope.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "envelopeAttachment"
}
object EnvelopeConsumerDisclosures 
{
  "type": "object",
  "properties": {
    "pdfId": {
      "type": "string",
      "description": "**Deprecated.** \n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. "
    },
    "custom": {
      "type": "string",
      "description": "When **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**"
    },
    "useBrand": {
      "type": "string",
      "description": "When **true,** specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience.  \n\nWhen **false** (default), or if the signing brand does not specify a company name, the account name is used instead.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. "
    },
    "esignText": {
      "type": "string",
      "description": "The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.\n\n**Note:** If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting."
    },
    "changeEmail": {
      "type": "string",
      "description": "If the customer needs to change their email address, this is the email address to which they should the change request."
    },
    "companyName": {
      "type": "string",
      "description": "Specifies the company name used in the disclosure. The default value is the account name.\n\nHowever, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true.** Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true.**\n"
    },
    "enableEsign": {
      "type": "string",
      "description": "When **true** (default), indicates that eSign is enabled."
    },
    "companyPhone": {
      "type": "string",
      "description": "The phone number of the company associated with the consumer disclosure, as a free-formatted string."
    },
    "languageCode": {
      "type": "string",
      "description": "The simple type enumeration for the language to use when displaying the disclosure. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`."
    },
    "withdrawCity": {
      "type": "string",
      "description": "Contains the city of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 50 characters. "
    },
    "withdrawEmail": {
      "type": "string",
      "description": "Contains the email address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawOther": {
      "type": "string",
      "description": "Contains any other information needed to withdraw consent.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We do not need any other information from you to withdraw consent.`"
    },
    "withdrawPhone": {
      "type": "string",
      "description": "Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.\n\nMaximum length: 20 characters. "
    },
    "withdrawState": {
      "type": "string",
      "description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.\n\nExample: `PA`"
    },
    "accountEsignId": {
      "type": "string",
      "description": "The GUID of the account associated with the consumer disclosure."
    },
    "esignAgreement": {
      "type": "string",
      "description": "The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting."
    },
    "withdrawByMail": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.**"
    },
    "allowCDWithdraw": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.**\n**Note:** Only Admin users can change this setting."
    },
    "copyCostPerPage": {
      "type": "string",
      "description": "The cost per page if the customer requests paper copies.\n\nExample: \n\n`0.0000`"
    },
    "withdrawByEmail": {
      "type": "string",
      "description": "When **true** (default), indicates that the customer can withdraw consent by email."
    },
    "withdrawByPhone": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw consent by phone. The default is **false.**"
    },
    "changeEmailOther": {
      "type": "string",
      "description": "Other information about the requirements for the user to change their email address.\n\nExample: \n\n`We do not require any other information from you to change your email address.`"
    },
    "copyRequestEmail": {
      "type": "string",
      "description": "The email address to which the customer should send a request for copies of a document.\n\nMaximum length: 100 characters."
    },
    "mustAgreeToEsign": {
      "type": "string",
      "description": "When **true,** the  recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions."
    },
    "withdrawPostalCode": {
      "type": "string",
      "description": "Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 20 characters. "
    },
    "withdrawAddressLine1": {
      "type": "string",
      "description": "Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawAddressLine2": {
      "type": "string",
      "description": "Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawConsequences": {
      "type": "string",
      "description": "Text indicating the consequences of withdrawing consent.\n\nMaximum length: 255 characters."
    },
    "allowCDWithdrawMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "copyFeeCollectionMethod": {
      "type": "string",
      "description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We will bill you for any fees at that time, if any.`"
    },
    "useConsumerDisclosureWithinAccount": {
      "type": "string",
      "description": "When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement."
    },
    "useConsumerDisclosureWithinAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "x-ds-order": "90",
  "description": "Details about envelope consumer disclosures.",
  "x-ms-summary": "Details about envelope consumer disclosures.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "consumerDisclosure"
}
object EnvelopeCustomFields 
{
  "type": "object",
  "properties": {
    "listCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/listCustomField"
      },
      "description": "An array of list custom fields."
    },
    "textCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/textCustomField"
      },
      "description": "An array of text custom fields."
    }
  },
  "x-ds-order": "70",
  "description": "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\".\n\nWhen 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](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=qor1583277385137.html).",
  "x-ms-summary": "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\".\n\nWhen 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](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=qor1583277385137.html).",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "customFields"
}
object EnvelopeDocumentFields 
{
  "type": "object",
  "properties": {
    "documentFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: \n\n* name - A string that can be a maximum of 50 characters. \n* value - A string that can be a maximum of 200 characters.\n\n*IMPORTANT*: If you are using xml, the name/value pair is contained in a nameValue element. \n"
    }
  },
  "x-ds-order": "60",
  "description": "Envelope document fields",
  "x-ms-summary": "Envelope document fields",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentFieldsInformation"
}
object EnvelopeDocumentHtmlDefinitions 
{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "220",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentHtmlDefinitionOriginals"
}
object EnvelopeDocumentTabs 
{
  "type": "object",
  "properties": {
    "ssnTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ssn"
      },
      "description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "zipTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/zip"
      },
      "description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered 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 value can be set.\n\n\n[zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "dateTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/date"
      },
      "description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters.\n\n**Note:** If you need to enforce a specific date format, DocuSign recommends that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "drawTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/draw"
      },
      "description": "A list of Draw Tabs.\n\nA Draw Tab allows the recipient to add a free-form drawing to the document."
    },
    "listTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/list"
      },
      "description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "noteTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/note"
      },
      "description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "textTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/text"
      },
      "description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "viewTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/view"
      },
      "description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents.  This value can be set.\n\n[view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "emailTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/email"
      },
      "description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "tabGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tabGroup"
      },
      "description": "An array of `tabGroup` items.\n\nTo associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array.\n"
    },
    "titleTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/title"
      },
      "description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title.  This value can't be set.\n\n\n[title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "numberTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/number"
      },
      "description": "A list of Number tabs.\n\nNumber tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](https://raw.githubusercontent.com) in the Concepts guide.\nFor specific information about number tabs\nsee [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs).\n\n[number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "approveTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/approve"
      },
      "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:          /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "companyTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/company"
      },
      "description": "A list of\n[Company tabs][company].\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n[company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company\n"
    },
    "declineTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/decline"
      },
      "description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "formulaTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/formulaTab"
      },
      "description": "A list of [Formula tabs][formulaTab].\n\nThe 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. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n[paymentguide]:     https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n[formulaTab]:       /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "prefillTabs": {
      "$ref": "#/components/schemas/prefillTabs"
    },
    "checkboxTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/checkbox"
      },
      "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "fullNameTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/fullName"
      },
      "description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "lastNameTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/lastName"
      },
      "description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "notarizeTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/notarize"
      },
      "description": "A list of  [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note:** Only one notarize tab can appear on a page.\n\n[notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "signHereTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signHere"
      },
      "description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "firstNameTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/firstName"
      },
      "description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname\n"
    },
    "numericalTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/numerical"
      },
      "description": "A list of numerical tabs.\n\nNumerical  tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation.                                                                                                                                                                                                                                                                                                                                                                                                                                                             \n\nTo learn more about the different forms of number tabs,\nsee [Number fields](https://raw.githubusercontent.com) in the Concepts guide.\nFor specific information about numerical tabs\nsee [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs)."
    },
    "dateSignedTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/dateSigned"
      },
      "description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "envelopeIdTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeId"
      },
      "description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab  displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid\n"
    },
    "notarySealTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/notarySeal"
      },
      "description": "A list of Notary Seal tabs.\n\nA 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].\n\n[notary]: /docs/notary-api/"
    },
    "radioGroupTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/radioGroup"
      },
      "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "initialHereTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/initialHere"
      },
      "description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "phoneNumberTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/phoneNumber"
      },
      "description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[cc]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
    },
    "emailAddressTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/emailAddress"
      },
      "description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "smartSectionTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/smartSection"
      },
      "description": "A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account."
    },
    "commentThreadTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commentThread"
      },
      "description": "An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set."
    },
    "commissionStateTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commissionState"
      },
      "description": "A list of\n[Commission State tabs][cc].\n\n\nA Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[cc]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
    },
    "polyLineOverlayTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/polyLineOverlay"
      },
      "description": "This type of tab enables the recipient to strike through document text. This value can't be set.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "
    },
    "commissionCountyTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commissionCounty"
      },
      "description": "A list of\n[Commission County tabs][cc].\n\n\nA Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[cc]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
    },
    "commissionNumberTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commissionNumber"
      },
      "description": "A list of\n[Commission Number tabs][tabref].\n\n\nA Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[tabref]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
    },
    "signerAttachmentTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signerAttachment"
      },
      "description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "commissionExpirationTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commissionExpiration"
      },
      "description": "A list of\n[Commission Expiration tabs][tabref].\n\n\nA Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[tabref]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
    }
  },
  "x-ds-order": "50",
  "description": "Document tabs are tabs that are associated with a document rather than with a recipient.",
  "x-ms-summary": "Document tabs are tabs that are associated with a document rather than with a recipient.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "tabs"
}
object EnvelopeDocumentVisibility 
{
  "type": "object",
  "properties": {
    "documentVisibility": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentVisibility"
      },
      "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients."
    }
  },
  "x-ds-order": "170",
  "description": "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.\n\n**Note:** Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- 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.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe 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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=eui1578456411411.html).",
  "x-ms-summary": "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.\n\n**Note:** Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- 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.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe 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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=eui1578456411411.html).",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentVisibilityList"
}
object EnvelopeDocuments 
{
  "type": "object",
  "properties": {
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "envelopeDocuments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDocument"
      },
      "description": "An array of document objects."
    }
  },
  "x-ds-order": "40",
  "description": "Envelope documents",
  "x-ms-summary": "Envelope documents",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "envelopeDocumentsResult"
}
object EnvelopeEmailSettings 
{
  "type": "object",
  "properties": {
    "bccEmailAddresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bccEmailAddress"
      },
      "description": "An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters.\n\nWhile this property is an array, note that it takes only a single email address.\n\n**Note:** Only users with the `canManageAccount` setting set to **true** can use this option. \n\nDocuSign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. \n\n**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."
    },
    "replyEmailNameOverride": {
      "type": "string",
      "description": "The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters."
    },
    "replyEmailAddressOverride": {
      "type": "string",
      "description": "The Reply To email address to use for email replies, instead of the one that is configured at the account level. DocuSign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters."
    }
  },
  "x-ds-order": "30",
  "description": "Envelope email settings",
  "x-ms-summary": "Envelope email settings",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "emailSettings"
}
object EnvelopeFormData 
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n"
    },
    "formData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/formDataItem"
      },
      "description": "An array of form data objects."
    },
    "envelopeId": {
      "type": "string",
      "description": "The ID of the envelope."
    },
    "emailSubject": {
      "type": "string",
      "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
    },
    "sentDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the envelope was sent. This property is read-only."
    },
    "prefillFormData": {
      "$ref": "#/components/schemas/prefillFormData"
    },
    "recipientFormData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientFormData"
      },
      "description": "An array of form data objects that are associated with specific recipients."
    }
  },
  "x-ds-order": "160",
  "description": "This object contains the data that recipients have entered into the form fields associated with an envelope.",
  "x-ms-summary": "This object contains the data that recipients have entered into the form fields associated with an envelope.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "envelopeFormData"
}
object EnvelopeHtmlDefinitions 
{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "240",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentHtmlDefinitionOriginals"
}
object EnvelopeLocks 
{
  "type": "object",
  "properties": {
    "lockType": {
      "type": "string",
      "description": "The type of lock.  Currently `edit` is the only supported type."
    },
    "lockToken": {
      "type": "string",
      "description": "A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock."
    },
    "lockedByApp": {
      "type": "string",
      "description": "The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "lockedByUser": {
      "$ref": "#/components/schemas/userInfo"
    },
    "useScratchPad": {
      "type": "string",
      "description": "When **true,** a scratchpad is used to edit information.\n "
    },
    "lockedUntilDateTime": {
      "type": "string",
      "description": "The date and time that the lock expires."
    },
    "lockDurationInSeconds": {
      "type": "string",
      "description": "\nThe number of seconds until the lock expires when there is no activity on the envelope.\n\nThe default value is 300 seconds. The maximum value is 1,800 seconds.\n\nThe lock duration can be extended.\n"
    }
  },
  "x-ds-order": "80",
  "description": "Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope.\n",
  "x-ms-summary": "Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope.\n",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "lockInformation"
}
Load more schemas