Accounts: create

Creates new DocuSign accounts. You can use this method to create a single account or up to 100 accounts at a time.

When creating a single account, the body of the request is a newAccountDefinition object.

If the request succeeds. it returns a 201 (Created) code. The response returns the new account ID, password and the default user information for each newly created account.

When creating multiple accounts, the body of the request is a newAccountRequests object, which contains one or more newAccountDefinition objects. You can create up to 100 new accounts at a time this way.

The body for a multi-account creation request looks like this in JSON:

{
  "newAccountRequests": [
    {
      "accountName": "accountone",
      . . .
    },
    {
      "accountName": "accounttwo",
      . . .
    }
  ]
}

A multi-account request looks like this in XML:

<newAccountsDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <newAccountRequests>
    <newAccountDefinition>
      . . .
    </newAccountDefinition>
    <newAccountDefinition>
      . . .
    </newAccountDefinition>
  </newAccountRequests>
</newAccountsDefinition>

A multi-account creation request may succeed (report a 201 code) even if some accounts could not be created. In this case, the errorDetails property in the response contains specific information about the failure.

Account Settings

The accountSettings property is a name/value list that can contain the following settings:

Name Type Authorization Required Description
adoptSigConfig Boolean Admin When true, the Signature Adoption Configuration page is available to account administrators.
allowAccessCodeFormat Boolean Admin When true, the Access Code Format page is available to account administrators.
allowAccountManagementGranular Boolean Admin When true, the Delegated Administration functionality is available to account.
allowBulkSend Boolean Admin When true, the account can set if the bulk send feature can be used.
allowCDWithdraw Boolean Admin When true, signers can withdraw their consent to use electronic signatures.
allowConnectSendFinishLater Boolean Reserved Reserved for DocuSign.
allowDataDownload Boolean Admin When true, the account can download envelope data.
allowEnvelopeCorrect Boolean Admin When true, the account allows in process envelopes to be corrected.
allowEnvelopePublishReporting Boolean Admin When true, the account can access the Envelope Publish section in Classic DocuSign Experience Account Administration.
allowExpressSignerCertificate Boolean Admin When true, senders are allowed to use the DocuSign Express digital signatures.
allowExternalSignaturePad Boolean Admin When true, an external signature pad can be used for signing. The signature pad type is set by the externalSignaturePadType property.
allowInPerson Boolean SysAdmin When true, the account allows In Person Signing.
allowMarkup Boolean Admin When true, the document markup feature is enabled for the account.
allowMemberTimezone Boolean Admin When true, account users can set their own time zones.
allowMergeFields Boolean Admin When true, the account can use merge fields in conjunction with DocuSign for Salesforce.
allowMultipleSignerAttachments Boolean Admin When true, multiple signer attachments are allowed for an envelope.
allowOfflineSigning Boolean Admin When true, the account can use Offline Signing and envelopes signed using offline signing on mobile devices are synchronized with this account. This option and the inSessionEnabled option must both be enabled (true) for a caller to use offline signing.
allowOpenTrustSignerCertificate Boolean Admin When true, senders are allowed to use the OpenTrust digital signatures.
allowPaymentProcessing Boolean Admin When true, the account can access the Payment Processing set up page.
allowPersonalSignerCertificate Boolean Admin When true, the account can specify that signers must use personal signer certificates during signing.
allowPrivateSigningGroups Boolean SysAdmin Read Only Reserved for DocuSign. This currently returns false in a response. This setting is only shown in the response when listing account settings.
allowReminders Boolean Admin When true, the reminder and expiration functionality is available when sending envelops.
allowSafeBioPharmaSignerCertificate Boolean Admin When true, senders are allowed to use the SAFE BioPharma digital signatures.
allowSharedTabs Boolean Admin When true, the account allows users to share custom tabs (fields).
This setting is only shown when getting account settings. It cannot be modified.
allowSignDocumentFromHomePage Boolean Admin When true, the Sign a Document Now button is available on the Home tab.
allowSignatureStamps Boolean Reserved Reserved for DocuSign.
allowSignerReassign Boolean Admin When true, the account allows signers to reassign an envelope.
allowSignerReassignOverride Boolean Admin When true, the sender has the option override the default account setting for reassigning recipients.
allowSigningGroups Boolean SysAdmin Read Only When true, the account can use signing groups. This setting is only shown in the response when listing account settings.
allowTabOrder Boolean Admin When true, the Tab Order field is available for use when creating tabs.
allowWorkspaceComments Boolean Reserved Reserved for DocuSign.
allowWorkspaceCreate Boolean Admin When true, account users can create DocuSign Rooms.
attachCompletedEnvelope Boolean SysAdmin When true, envelope documents are included as a PDF file attachment for signing completed emails.
authenticationCheck String Admin Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks:
  • Phone Authentication
  • SMS Authentication
  • Knowledge-Based ID
This setting takes one of the following options:
  • initial_access: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account.

  • each_access: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable timeframe.

autoNavRule String Admin The auto-navigation rule for the account. Enumeration values are:
  • off
  • required_fields
  • required_and_blank_fields
  • all_fields
  • page_then_required_fields
  • page_then_required_and_blank_fields
  • page_then_all_fields
bulkSend Boolean Admin When true, the account allows bulk sending of envelopes.
canSelfBrandSend Boolean SysAdmin When true, account administrators can self-brand their sending console through the DocuSign Console.
canSelfBrandSign Boolean SysAdmin When true, account administrators can self-brand their signing console through the DocuSign Console.
conditionalFieldsEnabled Boolean Admin When true, conditional fields can be used by the account.
consumerDisclosureFrequency enum Admin Possible values are:
  • once: Per account, the supplemental document is displayed once only per userId.
  • always: Per envelope, the supplemental document is displayed once only per userId.
  • each_access: - Per envelope, the supplemental document is displayed once only per recipientId.
dataFieldRegexEnabled Boolean Admin When true, the Regex field is available for tabs with that property.
dataFieldSizeEnabled Boolean Admin When true, the maximum number of characters field is available for tabs with that property.
dataPopulationScope String Admin Specifies how data is shared for tabs with the same tabLabel. There are two possible values:
  • document: Tabs in a document with the same label populate with the same data.
  • envelope: Tabs in all documents in the envelope with the same label populate with the same data.
This setting applies to the following tab types:
  • Check box
  • Company
  • Data Field
  • Dropdown List
  • Full Name
  • Formula
  • Note
  • Title
Changing this setting affects envelopes that have been sent but not completed.
disableMobilePushNotifications Boolean Admin When true, mobile push notifications are disabled on the account.
disableMobileSending Boolean Admin When true, sending from mobile applications is disabled.
disableMultipleSessions Boolean Admin When true, account users cannot be logged into multiple sessions at once.
disableUploadSignature Boolean Admin When true, signers cannot use the upload signature/initials image option when signing a document.
documentConversionRestrictions String Admin Sets the account document upload restriction for non-account administrators. There are three possible values:
  • no_restrictions : there are no restrictions on the type of documents that can be uploaded.
  • allow_pdf_only : only: non-administrators can only upload PDF files.
  • no_upload : Non-administrators cannot upload files.
enableAutoNav Boolean SysAdmin or EnableAutoNavByDSAdmin is set When true, the auto-navigation is enabled for the account.
enableCalculatedFields Boolean Admin & AllowExpression is set When true, this account can use the Calculated Fields feature.
enableDSPro Boolean SysAdmin When true, this account can send and manage envelopes from the DocuSign Desktop Client.
enableEnvelopeStampingByAccountAdmin Boolean SysAdmin or account has EnableEnvelopeStampingByDSAdmin set When true, senders for this account can choose to have the envelope ID stamped in the document margins.
enablePaymentProcessing Boolean Admin & AllowPaymentProcessing is set. When true, Payment Processing is enabled for the account.
enablePowerForm Boolean SysAdmin When true, PowerForm access is enabled for the account.
enablePowerFormDirect Boolean Admin When true, direct PowerForms are enabled for the account.
enableRecipientDomainValidation Boolean Admin When true, validation on recipient email domains for DocuSign Access feature is enabled.
enableRequireSignOnPaper Boolean Admin When true, the account can use the requireSignOnPaper option.
enableReservedDomain Boolean SysAdmin When true, an account administrator can reserve web domain and users.
enableSMSAuthentication Boolean Admin When true, the account can use SMS authentication.
enableSendToAgent Boolean SysAdmin When true, this account can use the Agent Recipient Type.
enableSendToIntermediary Boolean Admin & AllowSendToIntermediary is set When true, this account can use the Intermediary Recipient Type.
enableSendToManage Boolean Admin When true, this account can use the Editor Recipient Type.
enableSequentialSigningAPI Boolean SysAdmin When true, the account can define the routing order of recipients for envelopes sent using the DocuSign API.
enableSequentialSigningUI Boolean SysAdmin When true, the account can define the routing order of recipients for envelopes sent using the DocuSign console.
enableSignOnPaper Boolean Admin When true, a user can allow signers to use the sign on paper option.
enableSignOnPaperOverride Boolean Admin When true, a user can override the default account setting for the sign on paper option.
enableSignerAttachments Boolean Admin When true, a user can request attachments from a signer.
enableTransactionPoint Boolean SysAdmin When true, Transaction Point is enabled for this account.
enableVaulting Boolean SysAdmin When true, this account can use electronic vaulting for documents.
enableWorkspaces Boolean Admin When true, DocuSign Rooms is enabled for the account.
envelopeIntegrationAllowed String SysAdmin Shows the envelope integration rule for the account.
Enumeration values are: NotAllowed, Full, IntegrationSendOnly.
envelopeIntegrationEnabled Boolean Admin & EnvelopeIntegrationAllowed is set When true, envelope integration is enabled for the account.
envelopeStamplingDefaultValue Boolean (GET only) When true, envelopes sent by this account automatically have the envelope ID stamped in the margins, unless the sender selects not to have them stamped.
externalSignaturePadType String Admin Sets the type of signature pad that can be used. Possible values are:
  • none
  • topaz
  • e_padv9
  • e_pad_integrisign
faxOutEnabled Boolean Admin When true, the account can use the fax out feature.
idCheckExpire String Admin Indicates when a user's authentication expires. Possible values are:
  • always
  • never
  • variable: Use the value in idCheckExpireDays
idCheckExpireDays Integer Admin The number of days before a user's authentication expires. Valid only if the IDCheckExpire value is Variable.
idCheckRequired String Admin Indicates if authentication is required by envelope signers. Possible values are:
  • always
  • never
  • optional: Authentication is determined by the sender.
inPersonIDCheckQuestion String Admin The default question used by the In Person signing host for an In Person signing session.
inSessionEnabled Boolean Admin When true, the account can use In Session (embedded) and offline signing. This option and the allowOfflineSigning option must both be enabled (true) for a caller to use offline signing.
inSessionSuppressEmails Boolean Admin When true, emails are not sent to the embedded recipients on an envelope for the account.
maximumSigningGroups String SysAdmin Read Only The maximum number of signing groups an account can have. The default value for this is 50. This setting is only shown in the response when listing account settings.
maximumUsersPerSigningGroup String SysAdmin Read Only The maximum number of members in a signing group. The default value for this is 50. This setting is only shown in the response when listing account settings.
mobileSessionTimeout String Admin Sets the amount of idle activity time, in minutes, before a mobile user is automatically logged off of the system. If the setting is 0, then DocuSign mobile application users are never automatically logged off the system. The minimum setting is 1 minute and the maximum setting is 120 minutes.
This setting only applies to the DocuSign for iOS v2.8.2 or later mobile app.
phoneAuthRecipientMayProvidePhoneNumber Boolean Admin When true, senders can select to allow the recipient to provide a phone number for the Phone Authentication process.
pkiSignDownloadedPDFDocs String Admin The policy for adding a digital certificate to downloaded, printed and emailed documents. Possible values are:
  • no_sign
  • no_sign_allow_user_override
  • yes_sign
recipientsCanSignOffline Boolean Admin When true, envelopes signed using offline signing on mobile devices are synchronized with this account.
requireDeclineReason Boolean Admin When true, recipients that decline to sign an envelope must provide a reason.
requireSignerCertificateType String Admin Sets which Digital Signature certificate is required when sending envelopes. There are three possible values:
  • none: a Digital Signature certificate is not required.
  • docusign_express: signers must use a DocuSign Express certificate.
  • docusign_personal: signers must use a DocuSign personal certificate.
  • open_trust: signers must use an OpenTrust certificate.
rsaVeridAccountName String Admin The RSA account name.
Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this.
rsaVeridPassword String Admin The password used with the RSA account.
Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this.
rsaVeridRuleset String Admin The RSA rule set used with the account.
Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this.
rsaVeridUserId String Admin The user ID for the RSA account.
Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this.
savingCustomTabsEnabled Boolean Admin When true, account users can save custom tabs.
selfSignedRecipientEmailDocument String Admin Sets how self-signed documents are presented to the email recipients. Possible values are:
  • include_pdf: A PDF of the completed document is attached to the email
  • include_link: A secure link to the self-signed documents is included in the email.
selfSignedRecipientEmailDocumentRights Boolean Admin When true, account administrators can set the selfSignedRecipientEmailDocument option.
selfSignedRecipientEmailDocumentUserOverride Boolean Admin When true the selfSignedRecipientEmailDocument userSetting can be set for an individual user. The userSetting will override the account setting.
selfSignedRecipientEmailDocumentUserOverrideRights Boolean Admin When true, account administrators can set the selfSignedRecipientEmailDocumentOverride option.
sendToCertifiedDeliveryEnabled Boolean Admin When true, the Certified Deliveries Recipient type can be used by the account.
senderMustAuthenticateSigning Boolean Admin When true, a sender that is also a recipient of an envelope must follow the authentication requirements for the envelope.
sessionTimeout Integer Admin The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes.
setRecipEmailLang Boolean Admin When true, senders can set the email languages for each recipient.
setRecipSignLang Boolean Admin When true, senders can set the signing language used for each recipient.
sharedCustomTabsEnabled Boolean Admin When true, saved custom tabs can be shared with account users.
signDateFormat String Admin The date/time format applied to Date Signed fields for the account.
signTimeShowAmPm Boolean Admin When true, AM or PM is shown as part of the time for signDateFormat.
signerAttachCertificateToEnvelopePDF Boolean AccountAdmin & account is selected in AccountSigningSettings When true, the Certificate of Completion is included in the envelope documents PDF when it is downloaded.
signerAttachConcat Boolean Admin When true, signer attachments are added to the parent document that the attachment tab is located on, instead of the default behavior that creates a new document in the envelope for every signer attachment.
signerCanCreateAccount Boolean AccountAdmin & account is selected in AccountSigningSettings When true, the signer without a DocuSign account can create a DocuSign account after signing.
signerCanSignOnMobile Boolean AccountAdmin & account is selected in AccountSigningSettings When true, signers can use the DocuSign mobile signing user interface.
signerInSessionUseEnvelopeCompleteEmail Boolean Admin When true, an envelope complete email is sent to an In Session (embedded) or offline signer after DocuSign processes the envelope.
signerLoginRequirements String Admin Sets the Login requirements for the signer. There are four options:
  • login_not_required: The signer is not required to log on to the system.
  • login_required_if_account_holder: If the signer has a DocuSign account, they must log on to sign the document.
  • login_required_per_session: The sender cannot send an envelope to anyone who does not have a DocuSign account.
  • login_required_per_envelope: The sender cannot send an envelope to anyone who does not have a DocuSign account and the signer must log on the system for each envelope they will sign.
If you use Direct PowerForms or captive/embedded signers, the "Account required" settings are bypassed for those signers. If your workflow requires that the signer have an account, you should not use those methods.
signerMustHaveAccount Boolean AccountAdmin & account is selected in AccountSigningSettings When true, senders can only send an envelope to a recipient that has a DocuSign account.
signerMustLoginToSign Boolean AccountAdmin & account is selected in AccountSigningSettings When true, an envelope signer must log in to the DocuSign console to sign an envelope.
signerShowSecureFieldInitialValues Boolean AccountAdmin & account is selected in AccountSigningSettings When true, the initial value of all SecureFields is written to the document when sent.
tabDataLabelEnabled Boolean Admin When true, senders can change the default tabLabel for tabs.
tabLockingEnabled Boolean Admin When true, the locked option is available for tabs with that property.
tabTextFormattingEnabled Boolean Admin When true, the formatting options (font type, font size, font color, bold, italic, and underline) are available for tabs with those properties.
universalSignatureOptIn Boolean Reserved Reserved for DocuSign.
universalSignatureOptOut Boolean Reserved Reserved for DocuSign.
useAccountLevelEmail Boolean AccountAdmin & account is selected in AccountSigningSettings When true, the content of notification emails is determined at the account level.
useConsumerDisclosure Boolean Admin When true, the account can use supplemental documents.
usesAPI Boolean SysAdmin When true, the account can use the DocuSign API.

Request

HTTP request

POST /v2.1/accounts

Parameters

Parameter NameValueDescription
Optional Query Parameters
preview_billing_planstring

When set to true, creates the account using a preview billing plan.

Responses

CodeDescriptionReference
201

Successful response.

newAccountSummary
400

Error encountered.

errorDetails

SDK Method

Accounts::create

Definitions

accessCodeFormat

formatRequiredstring

formatRequiredMetadatasettingsMetadata

letterRequiredstring

letterRequiredMetadatasettingsMetadata

minimumLengthstring

minimumLengthMetadatasettingsMetadata

numberRequiredstring

numberRequiredMetadatasettingsMetadata

specialCharacterRequiredstring

specialCharacterRequiredMetadatasettingsMetadata

accountAddress

Contains information about an account address.

address1string

The first line of the user's address. Maximum length: 100 characters.

address2string

The second line of the user's address. Maximum length: 100 characters.

citystring

The city value of the address.

countrystring

Specifies the country associated with the address.

emailstring

Filters returned user records by the specified email address.

faxstring

firstNamestring

The user's first name. Maximum Length: 50 characters.

lastNamestring

phonestring

postalCodestring

The postal code associated with the address.

statestring

The state or province associated with the address.

supportedCountries[country]

Contains an array of countries supported by the billing plan.

accountIdentityVerificationWorkflow

Specifies an identity verification workflow

defaultDescriptionstring

Text describing the purpose of the ID Verification workflow

defaultNamestring

Name of the ID Verification workflow

signatureProvideraccountSignatureProvider

Signature provider associated with the identity verification workflow

workflowIdstring

Workflow unique ID
This is the ID you must specify when setting ID Verification in an envelope

workflowResourceKeystring

Key for translated resources

accountNotification

expirationsexpirations

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

remindersreminders

A complex element that specifies reminder settings for the envelope

userOverrideEnabledstring

accountSettingsInformation

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

accessCodeFormataccessCodeFormat

accountDateTimeFormatstring

accountDateTimeFormatMetadatasettingsMetadata

Metadata that indicates whether the accountDateTimeFormat property is editable.

accountNamestring

The name of the account.

accountNameMetadatasettingsMetadata

Metadata that indicates whether the accountName property is editable.

accountNotificationaccountNotification

adoptSigConfigstring

If true, Signature Adoption Configuration is enabled.

adoptSigConfigMetadatasettingsMetadata

Metadata that indicates whether the adoptSigConfig property is editable.

advancedCorrectstring

If true, the Advanced Correction feature is enabled for this account.

advancedCorrectMetadatasettingsMetadata

Metadata that indicates whether the advancedCorrect property is editable.

allowAccessCodeFormatstring

allowAccessCodeFormatMetadatasettingsMetadata

Metadata that indicates whether the allowAccessCodeFormat property is editable.

allowAccountManagementGranularstring

allowAccountManagementGranularMetadatasettingsMetadata

Metadata that indicates whether the allowAccountManagementGranular property is editable.

allowAccountMemberNameChangestring

allowAccountMemberNameChangeMetadatasettingsMetadata

Metadata that indicates whether the allowAccountMemberNameChange property is editable.

allowAgentNameEmailEditstring

If true, an agent recipient can change the email addresses of recipients later in the signing order.

allowAgentNameEmailEditMetadatasettingsMetadata

Metadata that indicates whether the allowAgentNameEmailEdit property is editable.

allowAutoNavSettingsstring

If true, auto-navigation can be enabled for this account.

allowAutoNavSettingsMetadatasettingsMetadata

Metadata that indicates whether the allowAutoNavSettings property is editable.

allowBulkSendstring

If true, the account is able to bulk send.

allowBulkSendMetadatasettingsMetadata

Metadata that indicates whether the allowBulkSend property is editable.

allowCDWithdrawstring

Indicates whether the customer can withdraw their acceptance of the consumer disclosure.

allowCDWithdrawMetadatasettingsMetadata

Metadata that indicates whether the allowCDWithdraw property is editable.

allowConnectHttpListenerConfigsstring

allowConnectSendFinishLaterstring

If true, Connect will send FinishLater messages

allowConnectSendFinishLaterMetadatasettingsMetadata

Metadata that indicates whether the allowConnectSendFinishLater property is editable.

allowConsumerDisclosureOverridestring

If true, the account has the ability to change the Consumer Disclosure settin.

allowConsumerDisclosureOverrideMetadatasettingsMetadata

Metadata that indicates whether the allowConsumerDisclosureOverride property is editable.

allowDataDownloadstring

If true, senders can download form data from an envelope.

allowDataDownloadMetadatasettingsMetadata

Metadata that indicates whether the allowDataDownload property is editable.

allowDocumentDisclosuresstring

allowDocumentDisclosuresMetadatasettingsMetadata

Metadata that indicates whether the allowDocumentDisclosures property is editable.

allowDocumentsOnSignedEnvelopesstring

allowDocumentsOnSignedEnvelopesMetadatasettingsMetadata

Metadata that indicates whether the allowDocumentsOnSignedEnvelopes property is editable.

allowDocumentVisibilitystring

If true, administrators can change the document visiblity settings.

allowDocumentVisibilityMetadatasettingsMetadata

Metadata that indicates whether the allowDocumentVisibility property is editable.

allowEHankoStampsstring

If true, eHanko stamps are enabled.

allowEHankoStampsMetadatasettingsMetadata

Metadata that indicates whether the allowEHankoStamps property is editable.

allowENoteEOriginalstring

Specifies whether eNote eOriginal integration is enabled.

allowENoteEOriginalMetadatasettingsMetadata

Metadata that indicates whether the allowENoteEOriginal property is editable.

allowEnvelopeCorrectstring

Specifies whether the correction feature is enabled.

allowEnvelopeCorrectMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeCorrect property is editable.

allowEnvelopeCustodyTransferstring

Specifies whether the account is able to manage rules that transfer ownership of envelopes wthin the same account.

allowEnvelopeCustodyTransferMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeCustodyTransfer property is editable.

allowEnvelopeCustomFieldsstring

Specifies whether envelope custom fields are enabled.

allowEnvelopeCustomFieldsMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeCustomFields property is editable.

allowEnvelopePublishReportingstring

Specifies whether envelope publishing reporting is enabled.

allowEnvelopePublishReportingMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopePublishReporting property is editable.

allowEnvelopeReportingstring

Specifies whether the account has access to reports.

allowEnvelopeReportingMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeReporting property is editable.

allowExpressionstring

If the account plan does not include calculated fields, this setting allows an account to use them.

allowExpressionMetadatasettingsMetadata

Metadata that indicates whether the allowExpression property is editable.

allowExpressSignerCertificatestring

Specifies whether signers are required to use Express Digital Signatures.

allowExpressSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowExpressSignerCertificate property is editable.

allowExtendedSendingResourceFilestring

allowExtendedSendingResourceFileMetadatasettingsMetadata

Metadata that indicates whether the allowExtendedSendingResourceFile property is editable.

allowExternalSignaturePadstring

Specifies whether the account can configure and use signature pads for their recipients.

allowExternalSignaturePadMetadatasettingsMetadata

Metadata that indicates whether the allowExternalSignaturePad property is editable.

allowInPersonstring

Specifies whether the account administrator can enable in person signing.

allowInPersonMetadatasettingsMetadata

Metadata that indicates whether the allowInPerson property is editable.

allowManagedStampsstring

allowManagedStampsMetadatasettingsMetadata

Metadata that indicates whether the allowManagedStamps property is editable.

allowMarkupstring

When true, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this.

allowMarkupMetadatasettingsMetadata

Metadata that indicates whether the allowMarkup property is editable.

allowMemberTimeZonestring

Specifies whether users can set their own time zone settings.

allowMemberTimeZoneMetadatasettingsMetadata

Metadata that indicates whether the allowMemberTimeZone property is editable.

allowMergeFieldsstring

Specified whether merge fields are enabled for the account.

allowMergeFieldsMetadatasettingsMetadata

Metadata that indicates whether the allowMergeFields property is editable.

allowMultipleBrandProfilesstring

Specifies whether the account supports multiple brands.

allowMultipleBrandProfilesMetadatasettingsMetadata

Metadata that indicates whether the allowMultipleBrandProfiles property is editable.

allowMultipleSignerAttachmentsstring

Specifies whether recipients are able to upload multiple signer attachments with a single attachment.

allowMultipleSignerAttachmentsMetadatasettingsMetadata

Metadata that indicates whether the allowMultipleSignerAttachments property is editable.

allowNonUSPhoneAuthstring

Specifies whether users can use international numbers for phone authentication.

allowNonUSPhoneAuthMetadatasettingsMetadata

Metadata that indicates whether the allowNonUSPhoneAuth property is editable.

allowOfflineSigningstring

Specifies whether offline signing is enabled for the account.

allowOfflineSigningMetadatasettingsMetadata

Metadata that indicates whether the allowOfflineSigning property is editable.

allowOpenTrustSignerCertificatestring

allowOpenTrustSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowOpenTrustSignerCertificate property is editable.

allowOrganizationsstring

allowOrganizationsMetadatasettingsMetadata

Metadata that indicates whether the allowOrganizations property is editable.

allowPaymentProcessingstring

allowPaymentProcessingMetadatasettingsMetadata

Metadata that indicates whether the allowPaymentProcessing property is editable.

allowPersonalSignerCertificatestring

allowPersonalSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowPersonalSignerCertificate property is editable.

allowPhoneAuthenticationstring

allowPhoneAuthenticationMetadatasettingsMetadata

Metadata that indicates whether the allowPhoneAuthentication property is editable.

allowPhoneAuthOverridestring

allowPhoneAuthOverrideMetadatasettingsMetadata

Metadata that indicates whether the allowPhoneAuthOverride property is editable.

allowPrivateSigningGroupsstring

allowPrivateSigningGroupsMetadatasettingsMetadata

Metadata that indicates whether the allowPrivateSigningGroups property is editable.

allowRemindersstring

If true, allows an account administrator to turn on reminders and expiration defaults for the account.

allowRemindersMetadatasettingsMetadata

Metadata that indicates whether the allowReminders property is editable.

allowResourceFileBrandingstring

If true, resource files can be uploaded in branding.

allowResourceFileBrandingMetadatasettingsMetadata

Metadata that indicates whether the allowResourceFileBranding property is editable.

allowSafeBioPharmaSignerCertificatestring

If true, allows the account administrator to specify that signers are required to use SAFE digital signatures.

allowSafeBioPharmaSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowSafeBioPharmaSignerCertificate property is editable.

allowSecurityAppliancestring

allowSecurityApplianceMetadatasettingsMetadata

Metadata that indicates whether the allowSecurityAppliance property is editable.

allowSendToCertifiedDeliverystring

If true, the account admin can enable the Send to Certified Delivery feature on the account.

allowSendToCertifiedDeliveryMetadatasettingsMetadata

Metadata that indicates whether the allowSendToCertifiedDelivery property is editable.

allowSendToIntermediarystring

If true, the account admin can enable the Send to Intermediary feature on the account.

allowSendToIntermediaryMetadatasettingsMetadata

Metadata that indicates whether the allowSendToIntermediary property is editable.

allowServerTemplatesstring

If true, the account can use templates.

allowServerTemplatesMetadatasettingsMetadata

Metadata that indicates whether the allowServerTemplates property is editable.

allowSharedTabsstring

If true, the account can use shared tabs.

allowSharedTabsMetadatasettingsMetadata

Metadata that indicates whether the allowSharedTabs property is editable.

allowSignatureStampsstring

allowSignatureStampsMetadatasettingsMetadata

Metadata that indicates whether the allowSignatureStamps property is editable.

allowSignDocumentFromHomePagestring

allowSignDocumentFromHomePageMetadatasettingsMetadata

Metadata that indicates whether the allowSignDocumentFromHomePage property is editable.

allowSignerReassignstring

Account setting that determines whether the recipient of an envelope sent from this account can reassign it to another person.

allowSignerReassignMetadatasettingsMetadata

Metadata that indicates whether the allowSignerReassign property is editable.

allowSignerReassignOverridestring

allowSignerReassignOverrideMetadatasettingsMetadata

Metadata that indicates whether the allowSignerReassignOverride property is editable.

allowSigningExtensionsstring

allowSigningExtensionsMetadatasettingsMetadata

Metadata that indicates whether the allowSigningExtensions property is editable.

allowSigningGroupsstring

allowSigningGroupsMetadatasettingsMetadata

Metadata that indicates whether the allowSigningGroups property is editable.

allowSigningRadioDeselectstring

allowSigningRadioDeselectMetadatasettingsMetadata

Metadata that indicates whether the allowSigningRadioDeselect property is editable.

allowSignNowstring

If true, the account administrator can enable the Sign Now feature.

allowSignNowMetadatastring

Metadata that indicates whether the allowSignNow property is editable.

allowSocialIdLoginstring

If true, the account administrator can enable social id login for the account.

allowSocialIdLoginMetadatasettingsMetadata

Metadata that indicates whether the allowSocialIdLogin property is editable.

allowSupplementalDocumentsstring

When true, this user can use the supplemental documents feature.

allowSupplementalDocumentsMetadatasettingsMetadata

Metadata for allowSupplementalDocuments.

anchorPopulationScopestring

Valid values are:

  • document
  • envelope

anchorPopulationScopeMetadatasettingsMetadata

Metadata that indicates whether the anchorPopulationScope property is editable.

anchorTagVersionedPlacementEnabledstring

Valid values are:

  • system_default
  • off
  • on

anchorTagVersionedPlacementMetadataEnabledsettingsMetadata

attachCompletedEnvelopestring

attachCompletedEnvelopeMetadatasettingsMetadata

Metadata that indicates whether the attachCompletedEnvelope property is editable.

authenticationCheckstring

Specifies how often to check authentication. Valid values are:

  • initial_access
  • each_access

authenticationCheckMetadatasettingsMetadata

Metadata that indicates whether the authenticationCheck property is editable.

autoNavRulestring

Specifies how auto-navigation works. Valid values are:

  • off
  • required_fields
  • required_and_blank_fields
  • all_fields
  • page_then_required_fields
  • page_then_required_and_blank_fields
  • page_then_all_fields

autoNavRuleMetadatasettingsMetadata

Metadata that indicates whether the autoNavRule property is editable.

autoProvisionSignerAccountstring

autoProvisionSignerAccountMetadatasettingsMetadata

Metadata that indicates whether the autoProvisionSignerAccount property is editable.

bccEmailArchivestring

bccEmailArchiveMetadatasettingsMetadata

Metadata that indicates whether the bccEmailArchive property is editable.

betaSwitchConfigurationstring

Reserved for DocuSign.

betaSwitchConfigurationMetadatasettingsMetadata

Metadata that indicates whether the betaSwitchConfiguration property is editable.

billingAddressaddressInformation

The billing address for the account.

billingAddressMetadatasettingsMetadata

Metadata that indicates whether the billingAddress property is editable.

bulkSendstring

When true, this user can use the bulk send feature for the account.

bulkSendMetadatasettingsMetadata

Metadata that indicates whether the bulkSend property is editable.

canSelfBrandSendstring

canSelfBrandSendMetadatasettingsMetadata

Metadata that indicates whether the canSelfBrandSend property is editable.

canSelfBrandSignstring

canSelfBrandSignMetadatasettingsMetadata

Metadata that indicates whether the canSelfBrandSign property is editable.

captureVoiceRecordingstring

captureVoiceRecordingMetadatasettingsMetadata

Metadata that indicates whether the captureVoiceRecording property is editable.

cfrUseWideImagestring

cfrUseWideImageMetadatasettingsMetadata

Metadata that indicates whether the cfrUseWideImage property is editable.

chromeSignatureEnabledstring

chromeSignatureEnabledMetadatasettingsMetadata

Metadata that indicates whether the chromeSignatureEnabled property is editable.

commentEmailShowMessageTextstring

commentEmailShowMessageTextMetadatasettingsMetadata

Metadata that indicates whether the commentEmailShowMessageText property is editable.

commentsAllowEnvelopeOverridestring

commentsAllowEnvelopeOverrideMetadatasettingsMetadata

Metadata that indicates whether the commentsAllowEnvelopeOverride property is editable.

conditionalFieldsEnabledstring

conditionalFieldsEnabledMetadatasettingsMetadata

Metadata that indicates whether the conditionalFieldsEnabled property is editable.

consumerDisclosureFrequencystring

Speficies how often to display the consumer disclosure. Valid values are:

  • once
  • always
  • each_access

consumerDisclosureFrequencyMetadatasettingsMetadata

Metadata that indicates whether the consumerDisclosureFrequency property is editable.

convertPdfFieldsstring

convertPdfFieldsMetadatasettingsMetadata

Metadata that indicates whether the convertPdfFields property is editable.

dataPopulationScopestring

Valid values are:

  • document
  • envelope

dataPopulationScopeMetadatasettingsMetadata

Metadata that indicates whether the dataPopulationScope property is editable.

disableMobileAppstring

When true, the mobile app distributor key is prevented from connecting for account users.

disableMobileAppMetadatasettingsMetadata

Metadata that indicates whether the disableMobileApp property is editable.

disableMobilePushNotificationsstring

When true, push notifications are disabled for the account.

disableMobilePushNotificationsMetadatasettingsMetadata

Metadata that indicates whether the disableMobilePushNotifications property is editable.

disableMobileSendingstring

When true, sending from a mobile application is disabled.

disableMobileSendingMetadatasettingsMetadata

Metadata that indicates whether the disableMobileSending property is editable.

disableMultipleSessionsstring

When true, account users cannot be logged into multiple sessions at the same time.

disableMultipleSessionsMetadatasettingsMetadata

Metadata that indicates whether the disableMultipleSessions property is editable.

disablePurgeNotificationsForSenderMetadatasettingsMetadata

Metadata that indicates whether the disablePurgeNotificationsForSender property is editable.

disableSignerCertViewstring

When true, signers cannot view certificates of completion.

disableSignerCertViewMetadatasettingsMetadata

Metadata that indicates whether the disableSignerCertView property is editable.

disableSignerHistoryViewstring

When true, signers cannot view envelope history.

disableSignerHistoryViewMetadatasettingsMetadata

Metadata that indicates whether the disableSignerHistoryView property is editable.

disableStyleSignaturestring

When true, the Select Style option is hidden from signers and they must draw their signature instead.

disableStyleSignatureMetadatasettingsMetadata

Metadata that indicates whether the disableStyleSignature property is editable.

disableUploadSignaturestring

When true, signers cannot upload custom image files of their signature and initials.

disableUploadSignatureMetadatasettingsMetadata

Metadata that indicates whether the disableUploadSignature property is editable.

disableUserSharingstring

When true, the User Sharing feature is disabled for the account.

disableUserSharingMetadatasettingsMetadata

Metadata that indicates whether the disableUserSharing property is editable.

displayBetaSwitchstring

displayBetaSwitchMetadatasettingsMetadata

Metadata that indicates whether the displayBetaSwitch property is editable.

documentConversionRestrictionsstring

Valid values are:

  • no_restrictions
  • allow_pdf_only
  • no_upload

documentConversionRestrictionsMetadatasettingsMetadata

Metadata that indicates whether the documentConversionRestrictions property is editable.

documentRetentionstring

documentRetentionMetadatasettingsMetadata

Metadata that indicates whether the documentRetention property is editable.

documentRetentionPurgeTabsstring

documentVisibilitystring

Valid values are:

  • Off
  • MustSignToViewUnlessSenderAccount
  • MustSignToViewUnlessSender
  • SenderCanSetMustSignToViewUnlessSenderAccount
  • SenderCanSetMustSignToViewUnlessSender

documentVisibilityMetadatasettingsMetadata

Metadata that indicates whether the documentVisibility property is editable.

emailTemplateVersionstring

emailTemplateVersionMetadatasettingsMetadata

Metadata that indicates whether the emailTemplateVersion property is editable.

enableAccessCodeGeneratorstring

When true, enables Access Code Generator on the account.

enableAccessCodeGeneratorMetadatasettingsMetadata

Metadata that indicates whether the enableAccessCodeGenerator property is editable.

enableAdvancedPaymentsstring

When true, enables Advanced Payments for the account.

enableAdvancedPaymentsMetadatasettingsMetadata

Metadata that indicates whether the enableAdvancedPayments property is editable.

enableAdvancedPowerFormsstring

When true, enables advanced PowerForms for the account.

enableAdvancedPowerFormsMetadatasettingsMetadata

Metadata that indicates whether the enableAdvancedPowerForms property is editable.

enableAutoNavstring

When true, enables the account to set the AutoNav rule setting, which allows a sender to override the auto navigation setting per envelope.

enableAutoNavMetadatasettingsMetadata

Metadata that indicates whether the enableAutoNav property is editable.

enableCalculatedFieldsstring

When true, the account is enabled to use calculated fields (must be allowed at the account level for this setting to be changeable).

enableCalculatedFieldsMetadatasettingsMetadata

Metadata that indicates whether the enableCalculatedFields property is editable.

enableClickwrapsstring

enableClickwrapsMetadatasettingsMetadata

Metadata that indicates whether the enableClickwraps property is editable.

enableCustomerSatisfactionMetricTrackingstring

When true, enables customer satisfaction metric tracking for the account.

enableCustomerSatisfactionMetricTrackingMetadatasettingsMetadata

Metadata that indicates whether the enableCustomerSatisfactionMetricTracking property is editable.

enableDSProstring

Reserved for DocuSign.

enableDSProMetadatasettingsMetadata

Metadata that indicates whether the enableDSPro property is editable.

enableEnvelopeStampingByAccountAdminstring

When true, enables the account administrator to control envelope stamping for an account (placement of the EnvelopeID).

enableEnvelopeStampingByAccountAdminMetadatasettingsMetadata

Metadata that indicates whether the enableEnvelopeStampingByAccountAdmin property is editable.

enableEnvelopeStampingByDSAdminstring

When true, enables the DocuSign administrator to control envelope stamping for an account (placement of the EnvelopeID).

enableEnvelopeStampingByDSAdminMetadatasettingsMetadata

Metadata that indicates whether the enableEnvelopeStampingByDSAdmin property is editable.

enablePaymentProcessingstring

When true, enables payment processing for this account.

enablePaymentProcessingMetadatasettingsMetadata

Metadata that indicates whether the enablePaymentProcessing property is editable.

enablePowerFormstring

When true, enables PowerForms for an account.

enablePowerFormDirectstring

When true, enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms.

enablePowerFormDirectMetadatasettingsMetadata

Metadata that indicates whether the enablePowerFormDirect property is editable.

enablePowerFormMetadatasettingsMetadata

Metadata that indicates whether the enablePowerForm property is editable.

enableRecipientDomainValidationstring

Reserved for DocuSign.

enableRecipientDomainValidationMetadatasettingsMetadata

Metadata that indicates whether the enableRecipientDomainValidation property is editable.

enableReportLinksstring

Enables direct links to envelopes in reports for administrators in the following scopes:

  • NoEnvelopes
  • AllEnvelopes
  • OnlyOwnEnvelopes

enableReportLinksMetadatasettingsMetadata

Metadata that indicates whether the enableReportLinks property is editable.

enableRequireSignOnPaperstring

When true, the account can use the requireSignOnPaper option.

enableRequireSignOnPaperMetadatasettingsMetadata

Metadata that indicates whether the enableRequireSignOnPaper property is editable.

enableReservedDomainstring

When true, enables reserved domains for an account. This is configured by the account administrators on a page which they can specify reserved domain and reserved users in their domain. This allows them to lock down email address domains to exist only in their account and in no other location in DocuSign.

enableReservedDomainMetadatasettingsMetadata

Metadata that indicates whether the enableReservedDomain property is editable.

enableResponsiveSigningstring

When true, enables responsive signing.

enableResponsiveSigningMetadatasettingsMetadata

Metadata that indicates whether the enableResponsiveSigning property is editable.

enableScheduledReleasestring

enableScheduledReleaseMetadatasettingsMetadata

Metadata that indicates whether the enableScheduledRelease property is editable.

enableSendingTagsFontSettingsstring

When true, enables fonts to be set on tags.

enableSendingTagsFontSettingsMetadatasettingsMetadata

Metadata that indicates whether the enableSendingTagsFontSettings property is editable.

enableSendToAgentstring

When true, this account can use the agent recipient type.

enableSendToAgentMetadatasettingsMetadata

Metadata that indicates whether the enableSendToAgent property is editable.

enableSendToIntermediarystring

When true, this account can use the intermediary recipient type.

enableSendToIntermediaryMetadatasettingsMetadata

Metadata that indicates whether the enableSendToIntermediary property is editable.

enableSendToManagestring

When true, this account can use the editor recipient type.

enableSendToManageMetadatasettingsMetadata

Metadata that indicates whether the enableSendToManage property is editable.

enableSequentialSigningAPIstring

When true, the account can define the routing order of recipients for envelopes sent using the DocuSign API.

enableSequentialSigningAPIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningAPI property is editable.

enableSequentialSigningUIstring

When true, the account can define the routing order of recipients for envelopes sent using the DocuSign application.

enableSequentialSigningUIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningUI property is editable.

enableSignerAttachmentsstring

When true, this user can use the signing attachments feature.

enableSignerAttachmentsMetadatasettingsMetadata

Metadata that indicates whether the enableSignerAttachments property is editable.

enableSigningExtensionCommentsstring

When true, enables commenting functionality.

enableSigningExtensionCommentsMetadatasettingsMetadata

Metadata that indicates whether the enableSigningExtensionComments property is editable.

enableSigningExtensionConversationsstring

When true, enables conversation functionality.

enableSigningExtensionConversationsMetadatasettingsMetadata

Metadata that indicates whether the enableSigningExtensionConversations property is editable.

enableSigningOrderSettingsForAccountstring

When true, switches Signing Order to On by default for new envelopes.

enableSigningOrderSettingsForAccountMetadatasettingsMetadata

Metadata that indicates whether the enableSigningOrderSettingsForAccount property is editable.

enableSignOnPaperstring

When true, a sender can allow signers to use the sign on paper option.

enableSignOnPaperMetadatasettingsMetadata

Metadata that indicates whether the enableSignOnPaper property is editable.

enableSignOnPaperOverridestring

When true, this user can override the Sign on Paper account setting, which specifies whether signers can sign documents on paper as an option to signing electronically.

enableSignOnPaperOverrideMetadatasettingsMetadata

Metadata that indicates whether the enableSignOnPaperOverride property is editable.

enableSignWithNotarystring

When set to true, Sign with Notary functionality is enabled on the envelope.

enableSignWithNotaryMetadatasettingsMetadata

Metadata that indicates whether the enableSignWithNotary property is editable.

enableSMSAuthenticationstring

When true, the account can use SMS authentication.

enableSMSAuthenticationMetadatasettingsMetadata

Metadata that indicates whether the enableSMSAuthentication property is editable.

enableSocialIdLoginstring

When true, enables the ability to use social IDs to login to an account.

enableSocialIdLoginMetadatasettingsMetadata

Metadata that indicates whether the enableSocialIdLogin property is editable.

enableStrikeThroughstring

When true, enables strikethrough formatting in documents.

enableStrikeThroughMetadatasettingsMetadata

Metadata that indicates whether the enableStrikeThrough property is editable.

enableTransactionPointstring

Reserved for DocuSign.

enableTransactionPointMetadatasettingsMetadata

Metadata that indicates whether the enableTransactionPoint property is editable.

enableVaultingstring

When true, Vaulting is enabled for the account.

enableVaultingMetadatasettingsMetadata

Metadata that indicates whether the enableVaulting property is editable.

enableWitnessingstring

When true, enables documents to be signed by a witness.

enableWitnessingMetadatasettingsMetadata

Metadata that indicates whether the enableWitnessing property is editable.

enforceTemplateNameUniquenessstring

When true, the template name must be unique.

enforceTemplateNameUniquenessMetadatasettingsMetadata

Metadata that indicates whether the enforceTemplateNameUniqueness property is editable.

envelopeIntegrationAllowedstring

When true, allows custom admins to enable Connect for their accounts.

envelopeIntegrationAllowedMetadatasettingsMetadata

Metadata that indicates whether the envelopeIntegrationAllowed property is editable.

envelopeIntegrationEnabledstring

When true, enables Connect for an account. Note that Connect integration requires additional configuration that must be set up for it to take effect; this switch is only the on/off control for the account.

envelopeIntegrationEnabledMetadatasettingsMetadata

Metadata that indicates whether the envelopeIntegrationEnabled property is editable.

envelopeStampingDefaultValuestring

envelopeStampingDefaultValueMetadatasettingsMetadata

Metadata that indicates whether the envelopeStampingDefaultValue property is editable.

expressSendstring

expressSendAllowTabsstring

expressSendAllowTabsMetadatasettingsMetadata

Metadata that indicates whether the expressSendAllowTabs property is editable.

expressSendMetadatasettingsMetadata

Metadata that indicates whether the expressSend property is editable.

externalDocumentSourcesexternalDocumentSources

externalSignaturePadTypestring

Specifies the signature pad type. Valid values are:

  • none
  • topaz
  • e_padv9
  • e_pad_integrisign
  • topaz_sigplusextlite

externalSignaturePadTypeMetadatasettingsMetadata

Metadata that indicates whether the externalSignaturePadType property is editable.

faxOutEnabledstring

faxOutEnabledMetadatasettingsMetadata

Metadata that indicates whether the faxOutEnabled property is editable.

hideAccountAddressInCoCstring

hideAccountAddressInCoCMetadatasettingsMetadata

Metadata that indicates whether the hideAccountAddressInCoC property is editable.

hidePricingstring

hidePricingMetadatasettingsMetadata

Metadata that indicates whether the hidePricing property is editable.

idCheckConfigurations[idCheckConfiguration]

idCheckExpirestring

Determines when a user's authentication with the account expires. Valid values are:

  • always: Users are required to authenticate each time.
  • variable: If the authentication for a user is valid and falls within the value for the idCheckExpireDays property, the user is not required to authenticate again.

idCheckExpireDaysstring

The number of days before user authentication credentials expire. A value of 0 specifies that users must re-authenticate for each new session.

idCheckExpireDaysMetadatasettingsMetadata

Metadata that indicates whether the idCheckExpireDays property is editable.

idCheckExpireMetadatasettingsMetadata

Metadata that indicates whether the idCheckExpire property is editable.

idCheckExpireMinutesstring

The number of minutes before user authentication credentials expire.

idCheckExpireMinutesMetadatasettingsMetadata

Metadata that indicates whether the idCheckExpireMinutes property is editable.

idCheckRequiredstring

Determines how authentication is configured for the account. Valid values are:

  • always: Authentication checks are performed on every envelope.
  • never: Authentication checks are not performed on any envelopes.
  • optional: Authentication is configurable per envelope.

idCheckRequiredMetadatasettingsMetadata

Metadata that indicates whether the idCheckRequired property is editable.

identityVerification[accountIdentityVerificationWorkflow]

identityVerificationMetadatasettingsMetadata

Metadata that indicates whether the identityVerification property is editable.

ignoreErrorIfAnchorTabNotFoundstring

Reserved for DocuSign.

ignoreErrorIfAnchorTabNotFoundMetadataEnabledsettingsMetadata

Reserved for DocuSign.

inPersonIDCheckQuestionstring

A text field containing the question that an in-person signing host uses to collect personal information from the recipient. The recipient's response to this question is saved and can be viewed in the certificate associated with the envelope.

inPersonIDCheckQuestionMetadatasettingsMetadata

Metadata that indicates whether the inPersonIDCheckQuestion property is editable.

inPersonSigningEnabledstring

When true, in-person signing is enabled for the account.

inPersonSigningEnabledMetadatasettingsMetadata

Metadata that indicates whether the inPersonSigningEnabled property is editable.

inSessionEnabledstring

When true, the account can send in-session (embedded) envelopes.

inSessionEnabledMetadatasettingsMetadata

Metadata that indicates whether the inSessionEnabled property is editable.

inSessionSuppressEmailsstring

When true, emails cannot be sent to the in-session (embedded) recipients on an envelope.

inSessionSuppressEmailsMetadatasettingsMetadata

Metadata that indicates whether the inSessionSuppressEmails property is editable.

maximumSigningGroupsstring

The maximum number of signing groups allowed for the account.

maximumSigningGroupsMetadatasettingsMetadata

Metadata that indicates whether the maximumSigningGroups property is editable.

maximumUsersPerSigningGroupstring

The maximum number of users per signing group.

maximumUsersPerSigningGroupMetadatasettingsMetadata

Metadata that indicates whether the maximumUsersPerSigningGroup property is editable.

maxNumberOfCustomStampsstring

The maximum number of custom stamps.

mobileSessionTimeoutstring

The number of minutes of inactivity before a mobile user is automatically logged out of the system. Valid values are 1 to 120 minutes. The default value is 20 minutes.

mobileSessionTimeoutMetadatasettingsMetadata

Metadata that indicates whether the mobileSessionTimeout property is editable.

numberOfActiveCustomStampsstring

optInMobileSigningV02string

optInMobileSigningV02MetadatasettingsMetadata

Metadata that indicates whether the optInMobileSigningV02 property is editable.

optOutAutoNavTextAndTabColorUpdatesstring

optOutAutoNavTextAndTabColorUpdatesMetadatasettingsMetadata

Metadata that indicates whether the optOutAutoNavTextAndTabColorUpdates property is editable.

optOutNewPlatformSealstring

optOutNewPlatformSealPlatformMetadatasettingsMetadata

Metadata that indicates whether the optOutNewPlatformSealPlatform property is editable.

phoneAuthRecipientMayProvidePhoneNumberstring

phoneAuthRecipientMayProvidePhoneNumberMetadatasettingsMetadata

Metadata that indicates whether the phoneAuthRecipientMayProvidePhoneNumber property is editable.

pkiSignDownloadedPDFDocsstring

Always true. Specifies that PDF files downloaded from the platform are signed.

pkiSignDownloadedPDFDocsMetadatasettingsMetadata

Metadata that indicates whether the pkiSignDownloadedPDFDocs property is editable.

recipientsCanSignOfflinestring

If true, recipients recieving envelopes from this account can sign offline.

recipientsCanSignOfflineMetadatasettingsMetadata

Metadata that indicates whether the recipientsCanSignOffline property is editable.

recipientSigningAutoNavigationControlstring

recipientSigningAutoNavigationControlMetadatasettingsMetadata

Metadata that indicates whether the recipientSigningAutoNavigationControl property is editable.

require21CFRpt11Compliancestring

If true, recipients are required to use a 21 CFR part 11-compliant signing experience.

require21CFRpt11ComplianceMetadatasettingsMetadata

Metadata that indicates whether the require21CFRpt11Compliance property is editable.

requireDeclineReasonstring

If true, requires signers who decline to sign an envelope sent from this account to provide a reason for declining.

requireDeclineReasonMetadatasettingsMetadata

Metadata that indicates whether the requireDeclineReason property is editable.

requireExternalUserManagementstring

requireExternalUserManagementMetadatasettingsMetadata

Metadata that indicates whether the requireExternalUserManagement property is editable.

requireSignerCertificateTypestring

Valid values are:

  • none
  • docusign_express
  • docusign_personal
  • safe
  • open_trust

requireSignerCertificateTypeMetadatasettingsMetadata

Metadata that indicates whether the requireSignerCertificateType property is editable.

rsaVeridAccountNamestring

The RSA account name.

Note: Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

rsaVeridPasswordstring

The password used with the RSA account.

Note: Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

rsaVeridRulesetstring

The RSA rule set used with the account.

Note: Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

rsaVeridUserIdstring

The user ID for the RSA account.

Note: Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

selfSignedRecipientEmailDocumentstring

Valid values are:

  • include_pdf
  • include_link

selfSignedRecipientEmailDocumentMetadatasettingsMetadata

Metadata that indicates whether the selfSignedRecipientEmailDocument property is editable.

selfSignedRecipientEmailDocumentUserOverridestring

When true the selfSignedRecipientEmailDocument user setting can be set for an individual user. The user setting overrides the account setting.

selfSignedRecipientEmailDocumentUserOverrideMetadatasettingsMetadata

Metadata that indicates whether the selfSignedRecipientEmailDocumentUserOverride property is editable.

senderCanSignInEachLocationstring

senderCanSignInEachLocationMetadatasettingsMetadata

Metadata that indicates whether the senderCanSignInEachLocation property is editable.

senderMustAuthenticateSigningstring

When true, a sender who is also a recipient of an envelope must follow the authentication requirements for the envelope.

senderMustAuthenticateSigningMetadatasettingsMetadata

Metadata that indicates whether the senderMustAuthenticateSigning property is editable.

sendingTagsFontColorstring

sendingTagsFontColorMetadatasettingsMetadata

Metadata that indicates whether the sendingTagsFontColor property is editable.

sendingTagsFontNamestring

sendingTagsFontNameMetadatasettingsMetadata

Metadata that indicates whether the sendingTagsFontName property is editable.

sendingTagsFontSizestring

sendingTagsFontSizeMetadatasettingsMetadata

Metadata that indicates whether the sendingTagsFontSize property is editable.

sendToCertifiedDeliveryEnabledstring

When true, the account can use the certified deliveries recipient type.

sendToCertifiedDeliveryEnabledMetadatasettingsMetadata

Metadata that indicates whether the sendToCertifiedDeliveryEnabled property is editable.

sessionTimeoutstring

The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes.

sessionTimeoutMetadatasettingsMetadata

Metadata that indicates whether the sessionTimeout property is editable.

setRecipEmailLangstring

setRecipEmailLangMetadatasettingsMetadata

Metadata that indicates whether the setRecipEmailLang property is editable.

setRecipSignLangstring

If true, setting a unique language for a recipient not only affects the email language, but also the signing language they are presented with. If false, only the email will be affected by the sender specifying a unique language for a recipient

setRecipSignLangMetadatasettingsMetadata

Metadata that indicates whether the setRecipSignLang property is editable.

sharedTemplateFoldersstring

sharedTemplateFoldersMetadatasettingsMetadata

Metadata that indicates whether the sharedTemplateFolders property is editable.

showCompleteDialogInEmbeddedSessionstring

showCompleteDialogInEmbeddedSessionMetadatasettingsMetadata

Metadata that indicates whether the showCompleteDialogInEmbeddedSession property is editable.

showInitialConditionalFieldsstring

showInitialConditionalFieldsMetadatasettingsMetadata

Metadata that indicates whether the showInitialConditionalFields property is editable.

showLocalizedWatermarksstring

showLocalizedWatermarksMetadatasettingsMetadata

Metadata that indicates whether the showLocalizedWatermarks property is editable.

showTutorialsstring

If true, show tutorials.

showTutorialsMetadatasettingsMetadata

Metadata that indicates whether the showTutorials property is editable.

signatureProviders[array]

signatureProvidersMetadatasettingsMetadata

Metadata that indicates whether the signatureProviders property is editable.

signDateFormatstring

The format for the signature date. Valid values are:

  • d/M/yyyy
  • dd-MM-yy
  • dd-MMM-yy
  • dd-MM-yyyy
  • dd.MM.yyyy
  • dd-MMM-yyyy
  • dd MMMM yyyy
  • M/d/yyyy
  • MM-dd-yyyy
  • MM/dd/yyyy
  • MM/dd/yy
  • MMM-dd-yyyy
  • MMM d, yyyy
  • MMMM d, yyyy
  • yyyy-MM-dd
  • yyyy-MMM-dd
  • yyyy/MM/dd
  • yyyy MMMM d

signDateFormatMetadatasettingsMetadata

Metadata that indicates whether the signDateFormat property is editable.

signerAttachCertificateToEnvelopePDFstring

If true, the certificate of completion is included in the envelope documents PDF when it is downloaded.

signerAttachCertificateToEnvelopePDFMetadatasettingsMetadata

Metadata that indicates whether the signerAttachCertificateToEnvelopePDF property is editable.

signerAttachConcatstring

If true, signer attachments are added to the parent document that contains the attachment. The default behavior creates a new document in the envelope for every signer attachment.

signerAttachConcatMetadatasettingsMetadata

Metadata that indicates whether the signerAttachConcat property is editable.

signerCanCreateAccountstring

If true, the signer can create a DocuSign account after signing.

signerCanCreateAccountMetadatasettingsMetadata

Metadata that indicates whether the signerCanCreateAccount property is editable.

signerCanSignOnMobilestring

When set to true, the recipient can sign on a mobile device.

signerCanSignOnMobileMetadatasettingsMetadata

Metadata that indicates whether the signerCanSignOnMobile property is editable.

signerInSessionUseEnvelopeCompleteEmailstring

If true, send only a completed email to an in-session signer and only if in-session emails are not supressed.

signerInSessionUseEnvelopeCompleteEmailMetadatasettingsMetadata

Metadata that indicates whether the signerInSessionUseEnvelopeCompleteEmail property is editable.

signerLoginRequirementsstring

Speficies whether a signer has to log in. Valid values are:

  • login_not_required
  • login_required_if_account_holder
  • login_required_per_session
  • login_required_per_envelope

signerLoginRequirementsMetadatasettingsMetadata

Metadata that indicates whether the signerLoginRequirements property is editable.

signerMustHaveAccountstring

When true, senders can only send an envelope to a recipient that has a DocuSign account.

signerMustHaveAccountMetadatasettingsMetadata

Metadata that indicates whether the signerMustHaveAccount property is editable.

signerMustLoginToSignstring

When true, signers must log in to the DocuSign platform to sign an envelope.

signerMustLoginToSignMetadatasettingsMetadata

Metadata that indicates whether the signerMustLoginToSign property is editable.

signerShowSecureFieldInitialValuesstring

When true, the initial value of all SecureFields is written to the document when sent.

signerShowSecureFieldInitialValuesMetadatasettingsMetadata

Metadata that indicates whether the signerShowSecureFieldInitialValues property is editable.

signingSessionTimeoutstring

The number of minutes that a signing session stays alive without any activity.

signingSessionTimeoutMetadatasettingsMetadata

Metadata that indicates whether the signingSessionTimeout property is editable.

signingUiVersionstring

Reserved for DocuSign.

signingUiVersionMetadatasettingsMetadata

Metadata that indicates whether the signingUiVersion property is editable.

signTimeFormatstring

The format for the signature time. Valid values are:

  • none
  • HH:mm
  • h:mm
  • HH:mm:ss
  • h:mm:ss

signTimeFormatMetadatasettingsMetadata

Metadata that indicates whether the signTimeFormat property is editable.

signTimeShowAmPmstring

If true, the time shows the AM or PM indicator.

signTimeShowAmPmMetadatasettingsMetadata

Metadata that indicates whether the signTimeShowAmPm property is editable.

simplifiedSendingEnabledstring

simplifiedSendingEnabledMetadatasettingsMetadata

Metadata that indicates whether the simplifiedSendingEnabled property is editable.

singleSignOnEnabledstring

If true, single sign-on (SSO) is enabled.

singleSignOnEnabledMetadatasettingsMetadata

Metadata that indicates whether the singleSignOnEnabled property is editable.

skipAuthCompletedEnvelopesstring

If true, do not require authentication prompt for viewing completed envelopes

skipAuthCompletedEnvelopesMetadatasettingsMetadata

Metadata that indicates whether the skipAuthCompletedEnvelopes property is editable.

socialIdRecipAuthstring

If true, recipients can use social ids when signing

socialIdRecipAuthMetadatasettingsMetadata

Metadata that indicates whether the socialIdRecipAuth property is editable.

specifyDocumentVisibilitystring

If true, a sender can specify the document visibility for an envelope. This makes the doc specific grid available, which allows a sender to override visibility on a per document level.

specifyDocumentVisibilityMetadatasettingsMetadata

Metadata that indicates whether the specifyDocumentVisibility property is editable.

startInAdvancedCorrectstring

If true, when initiating correction of an in-flight envelope the sender starts in advanced correct mode.

startInAdvancedCorrectMetadatasettingsMetadata

Metadata that indicates whether the startInAdvancedCorrect property is editable.

supplementalDocumentsMustAcceptstring

When true, this user must accept supplemental documents.

supplementalDocumentsMustAcceptMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustAccept property is editable.

supplementalDocumentsMustReadstring

When true, this user must read supplemental documents.

supplementalDocumentsMustReadMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustRead property is editable.

supplementalDocumentsMustViewstring

When true, this user must view supplemental documents.

supplementalDocumentsMustViewMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustView property is editable.

suppressCertificateEnforcementstring

suppressCertificateEnforcementMetadatasettingsMetadata

Metadata that indicates whether the suppressCertificateEnforcement property is editable.

tabAccountSettingsAccountTabSettings

timezoneOffsetAPIstring

Specifies the time zone to use with the API.

Valid values are:

  • TZ_01_AfghanistanStandardTime
  • TZ_02_AlaskanStandardTime
  • TZ_03_ArabStandardTime
  • TZ_04_ArabianStandardTime
  • TZ_05_ArabicStandardTime
  • TZ_06_ArgentinaStandardTime
  • TZ_07_AtlanticStandardTime
  • TZ_08_AUS_CentralStandardTime
  • TZ_09_AUS_EasternStandardTime
  • TZ_10_AzerbaijanStandardTime
  • TZ_11_AzoresStandardTime
  • TZ_12_BangladeshStandardTime
  • TZ_13_CanadaCentralStandardTime
  • TZ_14_CapeVerdeStandardTime
  • TZ_15_CaucasusStandardTime
  • TZ_16_CentralAustraliaStandardTime
  • TZ_17_CentralAmericaStandardTime
  • TZ_18_CentralAsiaStandardTime
  • TZ_19_CentralBrazilianStandardTime
  • TZ_20_CentralEuropeStandardTime
  • TZ_21_CentralEuropeanStandardTime
  • TZ_22_CentralPacificStandardTime
  • TZ_23_CentralStandardTime
  • TZ_24_CentralStandardTimeMexico
  • TZ_25_ChinaStandardTime
  • TZ_26_DatelineStandardTime
  • TZ_27_E_AfricaStandardTime
  • TZ_28_E_AustraliaStandardTime
  • TZ_29_E_EuropeStandardTime
  • TZ_30_E_SouthAmericaStandardTime
  • TZ_31_EasternStandardTime
  • TZ_32_EgyptStandardTime
  • TZ_33_EkaterinburgStandardTime
  • TZ_34_FijiStandardTime
  • TZ_35_FLE_StandardTime
  • TZ_36_GeorgianStandardTime
  • TZ_37_GMT_StandardTime
  • TZ_38_GreenlandStandardTime
  • TZ_39_GreenwichStandardTime
  • TZ_40_GTB_StandardTime
  • TZ_41_HawaiianStandardTime
  • TZ_42_IndiaStandardTime
  • TZ_43_IranStandardTime
  • TZ_44_IsraelStandardTime
  • TZ_45_JordanStandardTime
  • TZ_46_KaliningradStandardTime
  • TZ_47_KamchatkaStandardTime
  • TZ_48_KoreaStandardTime
  • TZ_49_MagadanStandardTime
  • TZ_50_MauritiusStandardTime
  • TZ_51_MidAtlanticStandardTime
  • TZ_52_MiddleEastStandardTime
  • TZ_53_MontevideoStandardTime
  • TZ_54_MoroccoStandardTime
  • TZ_55_MountainStandardTime
  • TZ_56_MountainStandardTimeMMexico
  • TZ_57_MyanmarStandardTime
  • TZ_58_N_CentralAsiaStandardTime
  • TZ_59_NamibiaStandardTime
  • TZ_60_NepalStandardTime
  • TZ_61_NewZealandStandardTime
  • TZ_62_NewfoundlandStandardTime
  • TZ_63_NorthAsiaEastStandardTime
  • TZ_64_NorthAsiaStandardTime
  • TZ_65_PacificSAStandardTime
  • TZ_66_PacificStandardTime
  • TZ_67_PacificStandardTimeMexico
  • TZ_68_PakistanStandardTime
  • TZ_69_ParaguayStandardTime
  • TZ_70_RomanceStandardTime
  • TZ_71_RussianStandardTime
  • TZ_72_SAEasternStandardTime
  • TZ_73_SAPacificStandardTime
  • TZ_74_SAWesternStandardTime
  • TZ_75_SamoaStandardTime
  • TZ_76_SE_AsiaStandardTime
  • TZ_77_SingaporeStandardTime
  • TZ_78_SouthAfricaStandardTime
  • TZ_79_SriLankaStandardTime
  • TZ_80_SyriaStandardTime
  • TZ_81_TaipeiStandardTime
  • TZ_82_TasmaniaStandardTime
  • TZ_83_TokyoStandardTime
  • TZ_84_TongaStandardTime
  • TZ_85_TurkeyStandardTime
  • TZ_86_UlaanbaatarStandardTime
  • TZ_87_US_EasternStandardTime
  • TZ_88_USMountainStandardTime
  • TZ_89_VenezuelaStandardTime
  • TZ_90_VladivostokStandardTime
  • TZ_91_W_AustraliaStandardTime
  • TZ_92_W_CentralAfricaStandardTime
  • TZ_93_W_EuropeStandardTime
  • TZ_94_WestAsiaStandardTime
  • TZ_95_WestPacificStandardTime
  • TZ_96_YakutskStandardTime

timezoneOffsetAPIMetadatasettingsMetadata

Metadata that indicates whether the timezoneOffsetAPI property is editable.

timezoneOffsetUIstring

Specifies the time zone to use in the UI.

Valid values are:

  • TZ_01_AfghanistanStandardTime
  • TZ_02_AlaskanStandardTime
  • TZ_03_ArabStandardTime
  • TZ_04_ArabianStandardTime
  • TZ_05_ArabicStandardTime
  • TZ_06_ArgentinaStandardTime
  • TZ_07_AtlanticStandardTime
  • TZ_08_AUS_CentralStandardTime
  • TZ_09_AUS_EasternStandardTime
  • TZ_10_AzerbaijanStandardTime
  • TZ_11_AzoresStandardTime
  • TZ_12_BangladeshStandardTime
  • TZ_13_CanadaCentralStandardTime
  • TZ_14_CapeVerdeStandardTime
  • TZ_15_CaucasusStandardTime
  • TZ_16_CentralAustraliaStandardTime
  • TZ_17_CentralAmericaStandardTime
  • TZ_18_CentralAsiaStandardTime
  • TZ_19_CentralBrazilianStandardTime
  • TZ_20_CentralEuropeStandardTime
  • TZ_21_CentralEuropeanStandardTime
  • TZ_22_CentralPacificStandardTime
  • TZ_23_CentralStandardTime
  • TZ_24_CentralStandardTimeMexico
  • TZ_25_ChinaStandardTime
  • TZ_26_DatelineStandardTime
  • TZ_27_E_AfricaStandardTime
  • TZ_28_E_AustraliaStandardTime
  • TZ_29_E_EuropeStandardTime
  • TZ_30_E_SouthAmericaStandardTime
  • TZ_31_EasternStandardTime
  • TZ_32_EgyptStandardTime
  • TZ_33_EkaterinburgStandardTime
  • TZ_34_FijiStandardTime
  • TZ_35_FLE_StandardTime
  • TZ_36_GeorgianStandardTime
  • TZ_37_GMT_StandardTime
  • TZ_38_GreenlandStandardTime
  • TZ_39_GreenwichStandardTime
  • TZ_40_GTB_StandardTime
  • TZ_41_HawaiianStandardTime
  • TZ_42_IndiaStandardTime
  • TZ_43_IranStandardTime
  • TZ_44_IsraelStandardTime
  • TZ_45_JordanStandardTime
  • TZ_46_KaliningradStandardTime
  • TZ_47_KamchatkaStandardTime
  • TZ_48_KoreaStandardTime
  • TZ_49_MagadanStandardTime
  • TZ_50_MauritiusStandardTime
  • TZ_51_MidAtlanticStandardTime
  • TZ_52_MiddleEastStandardTime
  • TZ_53_MontevideoStandardTime
  • TZ_54_MoroccoStandardTime
  • TZ_55_MountainStandardTime
  • TZ_56_MountainStandardTimeMMexico
  • TZ_57_MyanmarStandardTime
  • TZ_58_N_CentralAsiaStandardTime
  • TZ_59_NamibiaStandardTime
  • TZ_60_NepalStandardTime
  • TZ_61_NewZealandStandardTime
  • TZ_62_NewfoundlandStandardTime
  • TZ_63_NorthAsiaEastStandardTime
  • TZ_64_NorthAsiaStandardTime
  • TZ_65_PacificSAStandardTime
  • TZ_66_PacificStandardTime
  • TZ_67_PacificStandardTimeMexico
  • TZ_68_PakistanStandardTime
  • TZ_69_ParaguayStandardTime
  • TZ_70_RomanceStandardTime
  • TZ_71_RussianStandardTime
  • TZ_72_SAEasternStandardTime
  • TZ_73_SAPacificStandardTime
  • TZ_74_SAWesternStandardTime
  • TZ_75_SamoaStandardTime
  • TZ_76_SE_AsiaStandardTime
  • TZ_77_SingaporeStandardTime
  • TZ_78_SouthAfricaStandardTime
  • TZ_79_SriLankaStandardTime
  • TZ_80_SyriaStandardTime
  • TZ_81_TaipeiStandardTime
  • TZ_82_TasmaniaStandardTime
  • TZ_83_TokyoStandardTime
  • TZ_84_TongaStandardTime
  • TZ_85_TurkeyStandardTime
  • TZ_86_UlaanbaatarStandardTime
  • TZ_87_US_EasternStandardTime
  • TZ_88_USMountainStandardTime
  • TZ_89_VenezuelaStandardTime
  • TZ_90_VladivostokStandardTime
  • TZ_91_W_AustraliaStandardTime
  • TZ_92_W_CentralAfricaStandardTime
  • TZ_93_W_EuropeStandardTime
  • TZ_94_WestAsiaStandardTime
  • TZ_95_WestPacificStandardTime
  • TZ_96_YakutskStandardTime

timezoneOffsetUIMetadatasettingsMetadata

Metadata that indicates whether the timezoneOffsetUI property is editable.

universalSignatureOptInstring

Reserved for DocuSign.

useAccountLevelEmailstring

Reserved for DocuSign.

useAccountLevelEmailMetadatasettingsMetadata

Metadata that indicates whether the useAccountLevelEmail property is editable.

useConsumerDisclosurestring

If true, the account is using consumer disclosures.

useConsumerDisclosureMetadatasettingsMetadata

Metadata that indicates whether the useConsumerDisclosure property is editable.

useConsumerDisclosureWithinAccountstring

useConsumerDisclosureWithinAccountMetadatasettingsMetadata

Metadata that indicates whether the useConsumerDisclosureWithinAccount property is editable.

useDerivedKeysstring

Reserved for DocuSign.

useDerivedKeysMetadatasettingsMetadata

Metadata that indicates whether the useDerivedKeys property is editable.

useDocuSignExpressSignerCertificatestring

If true, signers are required to use Express Digital Signatures.

useDocuSignExpressSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the useDocuSignExpressSignerCertificate property is editable.

useNewBlobForPdfstring

Reserved for DocuSign.

useNewBlobForPdfMetadatasettingsMetadata

Metadata that indicates whether the useNewBlobForPdf property is editable.

useSAFESignerCertificatesstring

If true, signers are required to use SAFE digital signatures.

useSAFESignerCertificatesMetadatasettingsMetadata

Metadata that indicates whether the useSAFESignerCertificates property is editable.

usesAPIstring

If true, the account can use the API.

usesAPIMetadatasettingsMetadata

Metadata that indicates whether the usesAPI property is editable.

useSignatureProviderPlatformstring

useSignatureProviderPlatformMetadatasettingsMetadata

Metadata that indicates whether the useSignatureProviderPlatform property is editable.

validationsAllowedstring

validationsAllowedMetadatasettingsMetadata

Metadata that indicates whether the validationsAllowed property is editable.

validationsBrandstring

Valid values are:

  • docusign
  • account

validationsBrandMetadatasettingsMetadata

Metadata that indicates whether the validationsBrand property is editable.

validationsCadencestring

Valid values are:

  • none
  • monthly

validationsCadenceMetadatasettingsMetadata

Metadata that indicates whether the validationsCadence property is editable.

validationsEnabledstring

If true, enables validations.

validationsEnabledMetadatasettingsMetadata

Metadata that indicates whether the validationsEnabled property is editable.

validationsReportstring

Valid values are:

  • none
  • life_sciences_part11

validationsReportMetadatasettingsMetadata

Metadata that indicates whether the validationsReport property is editable.

waterMarkEnabledstring

If true, the watermark feature is enabled for the account.

waterMarkEnabledMetadatasettingsMetadata

Metadata that indicates whether the waterMarkEnabled property is editable.

writeReminderToEnvelopeHistorystring

If true, sent reminders are included in the envelope history.

writeReminderToEnvelopeHistoryMetadatasettingsMetadata

Metadata that indicates whether the writeReminderToEnvelopeHistory property is editable.

wurflMinAllowableScreenSizestring

The smallest screen allowed.

wurflMinAllowableScreenSizeMetadatasettingsMetadata

Metadata that indicates whether the wurflMinAllowableScreenSize property is editable.

accountSignatureProvider

Signature provider associated with the identity verification workflow. If empty, then this specific workflow is not intended for signers

signatureProviderNamestring

The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. The current provider list.

addOn

Contains information about add ons.

activestring

Reserved:

addOnIdstring

Reserved:

idstring

A unique ID for the Salesforce object.

namestring

Reserved:

addressInformation

Contains address information.

address1string

The first line of the user's address. Maximum length: 100 characters.

address2string

The second line of the user's address. Maximum length: 100 characters.

citystring

The user's city.

countrystring

The user's country.

faxstring

A fax number associated with the address, if one is available.

phonestring

A phone number associated with the address.

postalCodestring

The user's postal code.

stateOrProvincestring

The user's state or province.

billingInvoiceItem

Contains information about an item on a billing invoice.

chargeAmountstring

Reserved: TBD

chargeNamestring

Reserved: TBD

invoiceItemIdstring

Reserved: TBD

quantitystring

The quantity of envelopes to add to the account.

unitPricestring

Reserved: TBD

billingPlanPreview

Contains information about a preview billing plan.

currencyCodestring

Specifies the ISO currency code for the account.

invoiceInvoices

isProratedstring

subtotalAmountstring

taxAmountstring

totalAmountstring

connectUserObject

configurationtypestring

The type of custom Connect configuration being accessed.

connectIdstring

The ID of the custom Connect configuration being accessed.

enabledstring

Boolean value that indicates whether the custom Connect configuration is enabled or not.

hasAccessstring

senderSearchableItems[array]

country

isoCodestring

namestring

provinces[province]

provinceValidatedstring

creditCardInformation

addressaddressInformation

A complex element containing the credit card billing address information.

This can be the same as billing address and follows the same rules as billingAddress. It contains the following elements: street1, street2, city, state, zip, zipPlus4, phone, fax, and country.

cardNumberstring

The number on the credit card.

cardTypestring

The credit card type. Valid values are: visa, mastercard, or amex.

cvNumberstring

expirationMonthstring

The month that the credit card expires (1-12).

expirationYearstring

The year 4 digit year in which the credit card expires.

nameOnCardstring

The exact name printed on the credit card.

currencyFeatureSetPrice

currencyCodestring

Specifies the alternate ISO currency code for the account.

currencySymbolstring

Specifies the alternate currency symbol for the account.

envelopeFeestring

An incremental envelope cost for plans with envelope overages (when isEnabled is set to true.)

fixedFeestring

Specifies a one-time fee associated with the plan (when isEnabled is set to true.)

seatFeestring

Specifies an incremental seat cost for seat-based plans (when isEnabled is set to true.)

directDebitProcessorInformation

bankBranchCodestring

bankCheckDigitstring

bankCodestring

bankNamestring

bankTransferAccountNamestring

bankTransferAccountNumberstring

bankTransferTypestring

countrystring

Specifies the country associated with the address.

emailstring

Filters returned user records by the specified email address.

firstNamestring

The user's first name. Maximum Length: 50 characters.

iBANstring

lastNamestring

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

expirations

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

expireAfterstring

An integer that sets the number of days a sent envelope is active before it expires.

In a response, a negative number indicates that the envelope has already expired.

expireEnabledstring

When set to true, the envelope expires (is no longer available for signing) a certain number of days after it is sent (the sentDateTime). Use the expireAfter property to set the number of days before an envelope expires.

If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

expireWarnstring

An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

externalDocumentSources

boxnetEnabledstring

boxnetMetadatasettingsMetadata

dropboxEnabledstring

dropboxMetadatasettingsMetadata

googleDriveEnabledstring

googleDriveMetadatasettingsMetadata

oneDriveEnabledstring

oneDriveMetadatasettingsMetadata

salesforceEnabledstring

salesforceMetadatasettingsMetadata

featureSet

currencyFeatureSetPrices[currencyFeatureSetPrice]

A complex type that contains alternate currency values that are configured for this plan feature set.

envelopeFeestring

featureSetIdstring

A unique ID for the feature set.

fixedFeestring

is21CFRPart11string

When set to true, indicates that this module is enabled on the account.

isActivestring

Reserved for DocuSign.

isEnabledstring

Specifies whether the feature set is actively enabled as part of the plan.

namestring

The name of the feature set.

seatFeestring

An incremental seat cost for seat-based plans. Only valid when isEnabled for the feature set is set to true.

forgottenPasswordInformation

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

forgottenPasswordAnswer1string

The answer to the first forgotten password challenge question.

forgottenPasswordAnswer2string

The answer to the second forgotten password challenge question.

forgottenPasswordAnswer3string

The answer to the third forgotten password challenge question.

forgottenPasswordAnswer4string

The answer to the fourth forgotten password challenge question.

forgottenPasswordQuestion1string

The first challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion2string

The second challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion3string

The third challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion4string

The fourth challenge question presented to a user who has forgotten their password.

group

Information about groups.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

groupIdstring

The DocuSign group ID for the group.

groupNamestring

The name of the group.

groupTypestring

The group type. Potential values for POST and PUT requests include:

  • adminstrators
  • everyone
  • customGroup

permissionProfileIdstring

The ID of the permission profile associated with the group. Potential values include:

  • 2301416 (for the DocuSign Viewer profile)
  • 2301415 (for the DocuSign Sender profile)
  • 2301414 (for the Account Administrator profile)

users[userInfo]

A list of the users in the group.

usersCountstring

The total number of users in the group.

idCheckConfiguration

authSteps[idCheckSecurityStep]

isDefaultstring

When set to true, indicates that the signature is the default signature for the user.

namestring

idCheckSecurityStep

authTypestring

localePolicy

addressFormatstring

addressFormatMetadatasettingsMetadata

allowRegionstring

calendarTypestring

calendarTypeMetadatasettingsMetadata

cultureNamestring

cultureNameMetadatasettingsMetadata

currencyCodestring

The currency code for the account, based on the ISO 4217 currency code.

currencyCodeMetadatasettingsMetadata

currencyNegativeFormatstring

currencyNegativeFormatMetadatasettingsMetadata

currencyPositiveFormatstring

currencyPositiveFormatMetadatasettingsMetadata

customDateFormatstring

customSignDateFormatstring

customSignTimeFormatstring

customTimeFormatstring

dateFormatstring

dateFormatMetadatasettingsMetadata

effectiveAddressFormatstring

effectiveCalendarTypestring

effectiveCurrencyCodestring

effectiveCurrencyNegativeFormatstring

effectiveCurrencyPositiveFormatstring

effectiveCustomDateFormatstring

effectiveCustomTimeFormatstring

effectiveDateFormatstring

effectiveInitialFormatstring

effectiveNameFormatstring

effectiveTimeFormatstring

effectiveTimeZonestring

initialFormatstring

initialFormatMetadatasettingsMetadata

nameFormatstring

nameFormatMetadatasettingsMetadata

signDateFormatstring

The format for the signature date. Valid values are:

  • d/M/yyyy
  • dd-MM-yy
  • dd-MMM-yy
  • dd-MM-yyyy
  • dd.MM.yyyy
  • dd-MMM-yyyy
  • dd MMMM yyyy
  • M/d/yyyy
  • MM-dd-yyyy
  • MM/dd/yyyy
  • MM/dd/yy
  • MMM-dd-yyyy
  • MMM d, yyyy
  • MMMM d, yyyy
  • yyyy-MM-dd
  • yyyy-MMM-dd
  • yyyy/MM/dd
  • yyyy MMMM d

signDateFormatMetadatasettingsMetadata

Metadata that indicates whether the signDateFormat property is editable.

signTimeFormatstring

The format for the signature time. Valid values are:

  • none
  • HH:mm
  • h:mm
  • HH:mm:ss
  • h:mm:ss

signTimeFormatMetadatasettingsMetadata

Metadata that indicates whether the signTimeFormat property is editable.

timeFormatstring

timeFormatMetadatasettingsMetadata

timeZonestring

timeZoneMetadatasettingsMetadata

nameValue

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

newAccountDefinition

accountNamestring

The account name for the new account.

accountSettingsaccountSettingsInformation

The list of account settings that determine the features available for the account. Note that some features are determined by the plan used to create the account and cannot be overridden.

addressInformationaccountAddress

A complex type that contains the following information for the new account (all string content): address1, address2, city, country, fax, phone, postalCode and state.

Note: If country is US (United States) then State codes are validated for US States. Otherwise, State is treated as a non-validated string and serves the purpose of entering a state/province/region.

The maximum characters for the strings are:

  • address1, address2, city, country and state: 100 characters
  • postalCode, phone, and fax: 20 characters

creditCardInformationcreditCardInformation

A complex type that has information about the credit card used to pay for this account.

directDebitProcessorInformationdirectDebitProcessorInformation

Information about the bank that processes direct debits for the payment plan.

distributorCodestring

The code that identifies the billing plan groups and plans for the new account.

distributorPasswordstring

The password for the distributorCode.

initialUserUsers

A complex type with the initial user information for the new account. Note that some user information is set internally based on the plan and cannot be overridden.

paymentMethodstring

The payment method used for the billing plan. Valid values are:

  • NotSupported
  • CreditCard
  • PurchaseOrder
  • Premium
  • Freemium
  • FreeTrial
  • AppStore
  • DigitalExternal
  • DirectDebit

paymentProcessorInformationpaymentProcessorInformation

Information about the entity that processes payments for the billing plan.

planInformationplanInformation

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

referralInformationreferralInformation

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

Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only.

socialAccountInformationUserSocialAccountLogins

Contains properties that map a DocuSign user to a social account (Facebook, Yahoo, etc.)

newAccountSummary

accountIdstring

The account ID associated with the envelope.

accountIdGuidstring

The GUID associated with the account ID.

accountNamestring

The account name for the new account.

apiPasswordstring

Contains a token that can be used for authentication in API calls instead of using the user name and password.

baseUrlstring

The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl.

billingPlanPreviewbillingPlanPreview

userIdstring

Specifies the user ID of the new user.

paymentProcessorInformation

addressaddressInformation

The user's address.

billingAgreementIdstring

emailstring

Filters returned user records by the specified email address.

planInformation

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

addOns[addOn]

Reserved for DocuSign.

currencyCodestring

Specifies the ISO currency code for the account.

freeTrialDaysOverridestring

Reserved for DocuSign use only.

planFeatureSets[featureSet]

A complex type that sets the feature sets for the account.

planIdstring

The DocuSign plan id for the account.

recipientDomains[recipientDomain]

province

isoCodestring

namestring

recipientDomain

activestring

domainCodestring

domainNamestring

recipientDomainIdstring

referralInformation

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

Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only.

advertisementIdstring

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

Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only.

enableSupportstring

When set to true, then customer support is provided as part of the account plan.

externalOrgIdstring

groupMemberIdstring

idTypestring

includedSeatsstring

The number of seats (users) included.

industrystring

planStartMonthstring

promoCodestring

publisherIdstring

referralCodestring

referrerNamestring

saleDiscountAmountstring

Reserved for DocuSign use only.

saleDiscountFixedAmountstring

Reserved for DocuSign use only.

saleDiscountPercentstring

Reserved for DocuSign use only.

saleDiscountPeriodsstring

Reserved for DocuSign use only.

saleDiscountSeatPriceOverridestring

Reserved for DocuSign use only.

shopperIdstring

reminders

A complex element that specifies reminder settings for the envelope

reminderDelaystring

An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.

reminderEnabledstring

When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

reminderFrequencystring

An interger that sets the interval, in days, between reminder emails.

sealIdentifier

sealDisplayNamestring

sealNamestring

senderEmailNotifications

changedSignerstring

When set to true, the sender receives notification if the signer changes.

commentsOnlyPrivateAndMentionstring

When set to true, the user receives only comments in which that user name is mentioned.

commentsReceiveAllstring

When set to true, the user receives all comments.

deliveryFailedstring

When set to true, the sender receives notification if the delivery of the envelope fails.

envelopeCompletestring

When set to true, the user receives notification that the envelope has been completed.

offlineSigningFailedstring

When set to true, the user receives notification if the offline signing failed.

purgeDocumentsstring

When set to true, the user receives notification of document purges.

recipientViewedstring

When set to true, the sender receives notification that the recipient viewed the enveloper.

senderEnvelopeDeclinedstring

When set to true, the sender receives notification that the envelope was declined.

withdrawnConsentstring

When set to true, the user receives notification if consent is withdrawn.

settingsMetadata

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

is21CFRPart11string

When set to true, indicates that this module is enabled on the account.

options[array]

An array of option strings supported by this setting.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

uiHintstring

Reserved for DocuSign.

uiOrderstring

Reserved for DocuSign.

uiTypestring

Reserved for DocuSign.

signerEmailNotifications

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

agentNotificationstring

When set to true, the user receives agent notification emails.

carbonCopyNotificationstring

When set to true, the user receives notifications of carbon copy deliveries.

certifiedDeliveryNotificationstring

When set to true, the user receives notifications of certified deliveries.

commentsOnlyPrivateAndMentionstring

When set to true, the user receives only comments in which that user name is mentioned.

commentsReceiveAllstring

When set to true, the user receives all comments.

documentMarkupActivationstring

When set to true, the user receives notification that document markup has been activated.

envelopeActivationstring

When set to true, the user receives notification that the envelope has been activated.

envelopeCompletestring

When set to true, the user receives notification that the envelope has been completed.

envelopeCorrectedstring

When set to true, the user receives notification that the envelope has been corrected.

envelopeDeclinedstring

When set to true, the user receives notification that the envelope has been declined.

envelopeVoidedstring

When set to true, the user receives notification that the envelope has been voided.

faxReceivedstring

Reserved for DocuSign.

offlineSigningFailedstring

When set to true, the user receives notification if the offline signing failed.

purgeDocumentsstring

When set to true, the user receives notification of document purges.

reassignedSignerstring

When set to true, the user receives notification that the envelope has been reassigned.

whenSigningGroupMemberstring

When set to true, the user receives notification that he or she is a member of the signing group.

userAccountManagementGranularInformation

Describes which account management capabilities a user has.

canManageAccountSecuritySettingsstring

True if the user can manage account security settings.

canManageAccountSecuritySettingsMetadatasettingsMetadata

canManageAccountSettingsstring

True if the user can manage account settings.

canManageAccountSettingsMetadatasettingsMetadata

canManageAdminsstring

True if the user can manage administrators.

canManageAdminsMetadatasettingsMetadata

Metadata that indicates whether the canManageAdmins property is editable.

canManageReportingstring

True if the user can manage reporting.

canManageReportingMetadatasettingsMetadata

canManageSharingstring

True if the user can manage sharing.

canManageSharingMetadatasettingsMetadata

Metadata that indicates whether the canManageSharing property is editable.

canManageSigningGroupsstring

True if the user can manage signing groups.

canManageSigningGroupsMetadatasettingsMetadata

canManageUsersstring

True if the user can manage users.

canManageUsersMetadatasettingsMetadata

Metadata that indicates whether the canManageUsers property is editable.

userInfo

accountIdstring

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

accountNamestring

The name of the account associated with the current workspace user.

activationAccessCodestring

Access code provided to the user to activate the account.

emailstring

Filters returned user records by the specified email address.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

loginStatusstring

Boolean value that indicates whether the user is currently logged in or not.

membershipIdstring

The user's membership ID.

sendActivationEmailstring

When set to true, specifies that an activation email be sent to the user.

uristring

URI containing the user ID.

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Administrator on the account, this can be another user the Admin user is accessing. Note: For Envelopes:listStatusChanges (GET /v2.1/accounts/{accountId}/envelopes), the user_id query parameter is not implemented and should not be used.

userNamestring

The name of the user.

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

The type of user, for example CompanyUser.

userSettingsInformation

Data that describes settings for a user. Some elements of this object have a metadata property, which includes the following:

  • rights: The calling users permissions to edit this setting (can be editable or read_only)
  • uiHint: Internally used to build UIs (can be available or hidden)
  • options: The values supported for this setting (not all settings have this element)

accountManagementGranularuserAccountManagementGranularInformation

Describes which account management capabilities a user has.

adminOnlystring

Reserved for DocuSign.

adminOnlyMetadatasettingsMetadata

Reserved for DocuSign.

allowEnvelopeTransferTostring

Boolean value that indicates whether the user can participate in envelope transfers on the account.

allowEnvelopeTransferToMetadatasettingsMetadata

Reserved for DocuSign.

allowEsealRecipientsstring

allowEsealRecipientsMetadatasettingsMetadata

allowPowerFormsAdminToAccessAllPowerFormEnvelopestring

allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadatasettingsMetadata

allowRecipientLanguageSelectionstring

When true, this user can set the language used in the standard email format for a recipient when creating an envelope.

allowRecipientLanguageSelectionMetadatasettingsMetadata

Metadata for allowRecipientLanguageSelection.

allowSendOnBehalfOfstring

When true, this user can send envelopes "on behalf of" other users through the API.

allowSendOnBehalfOfMetadatasettingsMetadata

Metadata for allowSendOnBehalfOf.

allowSupplementalDocumentsstring

When true, this user can use the supplemental documents feature.

allowSupplementalDocumentsMetadatasettingsMetadata

Metadata for allowSupplementalDocuments.

anchorTagVersionedPlacementEnabledstring

Valid values are:

  • system_default
  • off
  • on

apiAccountWideAccessstring

When true, indicates that this user can send envelope-specific API requests on the account.

apiAccountWideAccessMetadatasettingsMetadata

Metadata for apiAccountWideAccess.

apiCanExportACstring

When true, this user can export authoritative copy for the account.

apiCanExportACMetadatasettingsMetadata

bulkSendstring

When true, this user can use the bulk send feature for the account.

bulkSendMetadatasettingsMetadata

Metadata that indicates whether the bulkSend property is editable.

canChargeAccountstring

Reserved for DocuSign.

canChargeAccountMetadatasettingsMetadata

Reserved for DocuSign.

canEditSharedAddressbookstring

When true, this user can edit the shared address book for the account.

canEditSharedAddressbookMetadatasettingsMetadata

canLockEnvelopesstring

canLockEnvelopesMetadatasettingsMetadata

canManageAccountstring

When true, this user is an administrator for the account.

canManageAccountMetadatasettingsMetadata

canManageDistributorstring

Reserved for DocuSign.

canManageDistributorMetadatasettingsMetadata

canManageTemplatesstring

When true, this user can manage templates for the account.

canManageTemplatesMetadatasettingsMetadata

canSendAPIRequestsstring

When true, this user can send API requests on the account.

canSendAPIRequestsMetadatasettingsMetadata

canSendEnvelopestring

When true, this user can send envelopes on the account.

canSendEnvelopeMetadatasettingsMetadata

canSignEnvelopestring

When true, this user can sign envelopes.

canSignEnvelopeMetadatasettingsMetadata

canUseScratchpadstring

canUseScratchpadMetadatasettingsMetadata

disableDocumentUploadstring

When true, this user is prohibited from uploading documents during sending.

disableDocumentUploadMetadatasettingsMetadata

Metadata that indicates whether the disableDocumentUpload property is editable.

disableOtherActionsstring

disableOtherActionsMetadatasettingsMetadata

Metadata that indicates whether the disableOtherActions property is editable.

enableDSProstring

Reserved for DocuSign.

enableDSProMetadatasettingsMetadata

Metadata that indicates whether the enableDSPro property is editable.

enableSequentialSigningAPIstring

When true, the account can define the routing order of recipients for envelopes sent using the DocuSign API.

enableSequentialSigningAPIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningAPI property is editable.

enableSequentialSigningUIstring

When true, the account can define the routing order of recipients for envelopes sent using the DocuSign application.

enableSequentialSigningUIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningUI property is editable.

enableSignerAttachmentsstring

When true, this user can use the signing attachments feature.

enableSignerAttachmentsMetadatasettingsMetadata

Metadata that indicates whether the enableSignerAttachments property is editable.

enableSignOnPaperOverridestring

When true, this user can override the Sign on Paper account setting, which specifies whether signers can sign documents on paper as an option to signing electronically.

enableSignOnPaperOverrideMetadatasettingsMetadata

Metadata that indicates whether the enableSignOnPaperOverride property is editable.

enableTransactionPointstring

Reserved for DocuSign.

enableTransactionPointMetadatasettingsMetadata

Metadata that indicates whether the enableTransactionPoint property is editable.

enableVaultingstring

When true, Vaulting is enabled for the account.

enableVaultingMetadatasettingsMetadata

Metadata that indicates whether the enableVaulting property is editable.

expressSendOnlystring

localestring

The user's locale code:

  • zh_CN
  • zh_TW
  • nl
  • en
  • fr
  • de
  • it
  • ja
  • ko
  • pt
  • pt_BR
  • ru
  • es

localeMetadatasettingsMetadata

localePolicylocalePolicy

Reserved for DocuSign.

modifiedBystring

User ID (GUID) of the user who last modified this user record.

modifiedByMetadatasettingsMetadata

modifiedDatestring

Most recent date on which this user record was modified.

modifiedDateMetadatasettingsMetadata

modifiedPagestring

Note referencing the page that modified this user record.

modifiedPageMetadatasettingsMetadata

newSendUIstring

Reserved for DocuSign.

newSendUIMetadatasettingsMetadata

powerFormModestring

Indicates the Power Form mode setting for the user:

  • none
  • admin
  • user

powerFormModeMetadatasettingsMetadata

recipientViewedNotificationstring

When true, this user receives notifications when envelopes are viewed.

recipientViewedNotificationMetadatasettingsMetadata

sealIdentifiers[sealIdentifier]

selfSignedRecipientEmailDocumentstring

Valid values are:

  • include_pdf
  • include_link

selfSignedRecipientEmailDocumentMetadatasettingsMetadata

Metadata that indicates whether the selfSignedRecipientEmailDocument property is editable.

senderEmailNotificationssenderEmailNotifications

An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign.

The user inherits the default account sender email notification settings when the user is created. The email notifications are:

  • envelopeComplete
  • changedSigner
  • senderEnvelopeDeclined
  • withdrawnConsent
  • recipientViewed
  • deliveryFailed

signerEmailNotificationssignerEmailNotifications

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

supplementalDocumentIncludeInDownloadstring

When true, this user gets supplemental documents when downloading documents.

supplementalDocumentsMustAcceptstring

When true, this user must accept supplemental documents.

supplementalDocumentsMustAcceptMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustAccept property is editable.

supplementalDocumentsMustReadstring

When true, this user must read supplemental documents.

supplementalDocumentsMustReadMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustRead property is editable.

supplementalDocumentsMustViewstring

When true, this user must view supplemental documents.

supplementalDocumentsMustViewMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustView property is editable.

templateActiveCreationstring

templateActiveCreationMetadatasettingsMetadata

templateApplyNotifystring

templateApplyNotifyMetadatasettingsMetadata

templateAutoMatchingstring

templateAutoMatchingMetadatasettingsMetadata

templateMatchingSensitivitystring

Percentage used when matching templates.

templateMatchingSensitivityMetadatasettingsMetadata

templatePageLevelMatchingstring

When true, users see template matching functionality.

templatePageLevelMatchingMetadatasettingsMetadata

timezoneDSTstring

When true, daylight savings time is in effect for this user's time zone.

timezoneDSTMetadatasettingsMetadata

timezoneMaskstring

timezoneMaskMetadatasettingsMetadata

timezoneOffsetstring

The timezone offset for the user. Valid values:

  • tz_01_afghanistan
  • tz_02_alaskan
  • tz_03_arab
  • tz_04_arabian
  • tz_05_arabic
  • tz_06_argentina
  • tz_07_atlantic
  • tz_08_aus_central
  • tz_09_aus_eastern
  • tz_10_azerbaijan
  • tz_11_azores
  • tz_12_bangladesh
  • tz_13_canada_central
  • tz_14_cape_verde
  • tz_15_caucasus
  • tz_16_central_australia
  • tz_17_central_america
  • tz_18_central_asia
  • tz_19_central_brazilian
  • tz_20_central_europe
  • tz_21_central_european
  • tz_22_central_pacific
  • tz_23_central
  • tz_24_central_mexico
  • tz_25_china
  • tz_26_dateline
  • tz_27_east_africa
  • tz_28_east_australia
  • tz_29_east_europe
  • tz_30_east_south_america
  • tz_31_eastern
  • tz_32_egypt
  • tz_33_ekaterinburg
  • tz_34_fiji
  • tz_35_fli
  • tz_36_georgian
  • tz_37_gmt
  • tz_38_greenland
  • tz_39_greenwich
  • tz_40_gtb
  • tz_41_hawaiian
  • tz_42_india
  • tz_43_iran
  • tz_44_israel
  • tz_45_jordan
  • tz_46_kaliningrad
  • tz_47_kamchatka
  • tz_48_korea
  • tz_49_magadan
  • tz_50_mauritius
  • tz_51_mid_atlantic
  • tz_52_middle_east
  • tz_53_montevideo
  • tz_54_morocco
  • tz_55_mountain
  • tz_56_mountain_mexico
  • tz_57_myanmar
  • tz_58_north_central_asia
  • tz_59_namibia
  • tz_60_nepal
  • tz_61_new_zealand
  • tz_62_new_foundland
  • tz_63_north_asia_east
  • tz_64_north_asia
  • tz_65_pacific_sa
  • tz_66_pacific
  • tz_67_pacific_mexico
  • tz_68_pakistan
  • tz_69_paraguay
  • tz_70_romance
  • tz_71_russian
  • tz_72_sa_eastern
  • tz_73_sa_pacific
  • tz_74_sa_western
  • tz_75_samoa
  • tz_76_se_asia
  • tz_77_singapore
  • tz_78_south_africa
  • tz_79_sriLanka
  • tz_80_syria
  • tz_81_taipei
  • tz_82_tasmania
  • tz_83_tokyo
  • tz_84_tonga
  • tz_85_turkey
  • tz_86_ulaanbaatar
  • tz_87_us_eastern
  • tz_88_us_mountain
  • tz_89_venezuela
  • tz_90_vladivostok
  • tz_91_west_australia
  • tz_92_west_central_africa
  • tz_93_west_europe
  • tz_94_west_asia
  • tz_95_west_pacific
  • tz_96_yakutsk

timezoneOffsetMetadatasettingsMetadata

timezoneSendingPrefstring

Reserved for DocuSign.

timezoneSendingPrefMetadatasettingsMetadata

timezoneSigningPrefstring

Reserved for DocuSign.

timezoneSigningPrefMetadatasettingsMetadata

transactionPointSiteNameURLstring

Reserved for DocuSign.

transactionPointSiteNameURLMetadatasettingsMetadata

transactionPointUserNamestring

Reserved for DocuSign.

transactionPointUserNameMetadatasettingsMetadata

vaultingModestring

Indicates the specified Vaulting mode:

  • none
  • estored
  • electronic_original

vaultingModeMetadatasettingsMetadata

Metadata that indicates whether the vaultingMode property is editable.

Invoices

Invoices

amountstring

Reserved: TBD

balancestring

Reserved: TBD

dueDatestring

Reserved: TBD

invoiceIdstring

Reserved: TBD

invoiceItems[billingInvoiceItem]

Reserved: TBD

invoiceNumberstring

Reserved: TBD

invoiceUristring

Contains a URI for an endpoint that you can use to retrieve invoice information.

nonTaxableAmountstring

pdfAvailablestring

taxableAmountstring

Users

User management

activationAccessCodestring

The activation code a new user must enter when activating their account.

companystring

The name of the user's company.

connectConfigurations[connectUserObject]

Object representing the user's custom Connect configuration.

countryCodestring

The three-letter code for the user's country.

createdDateTimestring

The date and time the item was created.

customSettings[nameValue]

The name/value pair information for the user custom setting.

defaultAccountIdstring

The default account ID associated with the user.

emailstring

The user's email address.

enableConnectForUserstring

Boolean value that specifies whether the user is enabled for updates from DocuSign Connect.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

firstNamestring

The user's first name. Maximum Length: 50 characters.

forgottenPasswordInfoforgottenPasswordInformation

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

groupList[group]

A list of the group information for groups to add the user to. Use UserGroups::listGroups to get information about groups.

When setting a user's group, only the groupId is required.

homeAddressaddressInformation

The user's physical home address.

initialsImageUristring

Contains the URI for an endpoint that you can use to retrieve the initials image.

isAdminstring

Determines if the feature set is actively set as part of the plan.

isNAREnabledstring

lastLoginstring

The date and time when the user last logged in to the system.

lastNamestring

The user's last name. Maximum Length: 50 characters.

loginStatusstring

Shows the current status of the user's password. Possible values are:

  • password_reset
  • password_active
  • password_expired
  • password_locked
  • password_reset_failed

middleNamestring

The user's middle name. Limit: 50 characters.

passwordstring

The user's password.

passwordExpirationstring

If password expiration is enabled, the date-time when the user's password expires.

permissionProfileIdstring

The id of the permission profile associated with the user.

permissionProfileNamestring

The name of the permission profile associated with the user.

profileImageUristring

The URL for retrieving the user's profile image.

sendActivationEmailstring

When set to true, specifies that an activation email be sent to the user.

sendActivationOnInvalidLoginstring

When set to true, specifies that an additional activation email be sent if user's log on fails before the account is activated.

signatureImageUristring

An endpoint URI that you can use to retrieve the user's signature image.

subscribestring

suffixNamestring

The suffix for the user's name, such as Jr, IV, PhD, etc.

Limit: 50 characters.

titlestring

The salutation for the user, such as Ms, Dr, Capt., etc.

Limit: 10 characters.

uristring

URI containing the user ID.

userAddedToAccountDateTimestring

The date and time that the user was added to the account.

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Administrator on the account, this can be another user the Admin user is accessing. Note: For Envelopes:listStatusChanges (GET /v2.1/accounts/{accountId}/envelopes), the user_id query parameter is not implemented and should not be used.

userNamestring

The user's full name.

userProfileLastModifiedDatestring

The date and time that the user's profile was last modified.

userSettingsuserSettingsInformation

The collection of settings representing the actions a user can perform. See userSettingsInformation for available settings.

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

The type of user, for example CompanyUser.

workAddressaddressInformation

The user's physical work address.

AccountTabSettings

allowTabOrderstring

allowTabOrderMetadatasettingsMetadata

Metadata that indicates whether the allowTabOrder property is editable.

approveDeclineTabsEnabledstring

approveDeclineTabsMetadatasettingsMetadata

Metadata that indicates whether the approveDeclineTabs property is editable.

calculatedFieldsEnabledstring

calculatedFieldsMetadatasettingsMetadata

Metadata that indicates whether the calculatedFields property is editable.

checkboxTabsEnabledstring

checkBoxTabsMetadatasettingsMetadata

dataFieldRegexEnabledstring

dataFieldRegexMetadatasettingsMetadata

Metadata that indicates whether the dataFieldRegex property is editable.

dataFieldSizeEnabledstring

dataFieldSizeMetadatasettingsMetadata

Metadata that indicates whether the dataFieldSize property is editable.

firstLastEmailTabsEnabledstring

firstLastEmailTabsMetadatasettingsMetadata

Metadata that indicates whether the firstLastEmailTabs property is editable.

listTabsEnabledstring

listTabsMetadatasettingsMetadata

Metadata that indicates whether the listTabs property is editable.

noteTabsEnabledstring

noteTabsMetadatasettingsMetadata

Metadata that indicates whether the noteTabs property is editable.

radioTabsEnabledstring

radioTabsMetadatasettingsMetadata

Metadata that indicates whether the radioTabs property is editable.

savingCustomTabsEnabledstring

savingCustomTabsMetadatasettingsMetadata

Metadata that indicates whether the savingCustomTabs property is editable.

senderToChangeTabAssignmentsEnabledstring

senderToChangeTabAssignmentsMetadatasettingsMetadata

Metadata that indicates whether the senderToChangeTabAssignments property is editable.

sharedCustomTabsEnabledstring

sharedCustomTabsMetadatasettingsMetadata

Metadata that indicates whether the sharedCustomTabs property is editable.

tabDataLabelEnabledstring

tabDataLabelMetadatasettingsMetadata

Metadata that indicates whether the tabDataLabel property is editable.

tabLocationEnabledstring

tabLocationMetadatasettingsMetadata

Metadata that indicates whether the tabLocation property is editable.

tabLockingEnabledstring

tabLockingMetadatasettingsMetadata

Metadata that indicates whether the tabLocking property is editable.

tabScaleEnabledstring

tabScaleMetadatasettingsMetadata

Metadata that indicates whether the tabScale property is editable.

tabTextFormattingEnabledstring

tabTextFormattingMetadatasettingsMetadata

Metadata that indicates whether the tabTextFormatting property is editable.

textTabsEnabledstring

textTabsMetadatasettingsMetadata

Metadata that indicates whether the textTabs property is editable.

Examples

Generic JSON Request/Response

Request
{
  "accountName": "sample string 1",
  "distributorCode": "sample string 2",
  "distributorPassword": "sample string 3",
  "planInformation": {
    "planId": "sample string 1",
    "planFeatureSets": [
      {
        "featureSetId": "sample string 1",
        "isActive": "sample string 2",
        "name": "sample string 3",
        "fixedFee": "sample string 4",
        "envelopeFee": "sample string 5",
        "seatFee": "sample string 6",
        "isEnabled": "sample string 7",
        "is21CFRPart11": "sample string 8",
        "currencyFeatureSetPrices": [
          {
            "currencyCode": "sample string 1",
            "fixedFee": "sample string 2",
            "seatFee": "sample string 3",
            "envelopeFee": "sample string 4",
            "currencySymbol": "sample string 5"
          }
        ]
      }
    ],
    "addOns": [
      {
        "id": "sample string 1",
        "addOnId": "sample string 2",
        "name": "sample string 3",
        "active": "sample string 4"
      }
    ],
    "recipientDomains": [
      {
        "recipientDomainId": "sample string 1",
        "domainCode": "sample string 2",
        "domainName": "sample string 3",
        "active": "sample string 4"
      }
    ],
    "currencyCode": "sample string 2",
    "freeTrialDaysOverride": "sample string 3"
  },
  "creditCardInformation": {
    "cardNumber": "sample string 1",
    "expirationMonth": "sample string 2",
    "expirationYear": "sample string 3",
    "nameOnCard": "sample string 4",
    "cardType": "sample string 5",
    "address": {
      "street1": "sample string 1",
      "street2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "phone": "sample string 6",
      "fax": "sample string 7",
      "country": "sample string 8"
    }
  },
  "referralInformation": {
    "enableSupport": "sample string 1",
    "includedSeats": "sample string 2",
    "saleDiscountPercent": "sample string 3",
    "saleDiscountAmount": "sample string 4",
    "saleDiscountFixedAmount": "sample string 5",
    "saleDiscountPeriods": "sample string 6",
    "saleDiscountSeatPriceOverride": "sample string 7",
    "planStartMonth": "sample string 8",
    "referralCode": "sample string 9",
    "referrerName": "sample string 10",
    "advertisementId": "sample string 11",
    "publisherId": "sample string 12",
    "shopperId": "sample string 13",
    "promoCode": "sample string 14",
    "groupMemberId": "sample string 15",
    "idType": "sample string 16",
    "industry": "sample string 17",
    "externalOrgId": "sample string 18"
  },
  "accountSettings": [
    {}
  ],
  "initialUser": {
    "userName": "sample string 1",
    "userId": "sample string 2",
    "userType": "sample string 3",
    "isAdmin": "sample string 4",
    "userStatus": "sample string 5",
    "uri": "sample string 6",
    "email": "sample string 7",
    "password": "sample string 8",
    "title": "sample string 9",
    "createdDateTime": "sample string 10",
    "firstName": "sample string 11",
    "middleName": "sample string 12",
    "lastName": "sample string 13",
    "suffixName": "sample string 14",
    "permissionProfileId": "sample string 15",
    "permissionProfileName": "sample string 16",
    "countryCode": "sample string 17",
    "subscribe": "sample string 18",
    "userSettings": [
      {}
    ],
    "accountManagementGranular": {
      "canManageUsers": "sample string 1",
      "canManageAdmins": "sample string 2",
      "canManageGroups": "sample string 3",
      "canManageSharing": "sample string 4",
      "canManageUsersMetadata": {
        "rights": "sample string 1",
        "uiHint": "sample string 2",
        "uiType": "sample string 3",
        "uiOrder": "sample string 4",
        "is21CFRPart11": "sample string 5",
        "options": [
          "sample string 1"
        ]
      },
      "canManageAdminsMetadata": {},
      "canManageGroupsMetadata": {},
      "canManageSharingMetadata": {}
    },
    "sendActivationOnInvalidLogin": "sample string 19",
    "activationAccessCode": "sample string 20",
    "enableConnectForUser": "sample string 21",
    "forgottenPasswordInfo": {
      "forgottenPasswordQuestion1": "sample string 1",
      "forgottenPasswordAnswer1": "sample string 2",
      "forgottenPasswordQuestion2": "sample string 3",
      "forgottenPasswordAnswer2": "sample string 4",
      "forgottenPasswordQuestion3": "sample string 5",
      "forgottenPasswordAnswer3": "sample string 6",
      "forgottenPasswordQuestion4": "sample string 7",
      "forgottenPasswordAnswer4": "sample string 8"
    },
    "groupList": [
      {
        "groupId": "sample string 1",
        "groupName": "sample string 2",
        "permissionProfileId": "sample string 3",
        "groupType": "sample string 4",
        "users": [
          {
            "userName": "sample string 1",
            "userId": "sample string 2",
            "email": "sample string 3",
            "userType": "sample string 4",
            "userStatus": "sample string 5",
            "uri": "sample string 6",
            "loginStatus": "sample string 7",
            "sendActivationEmail": "sample string 8",
            "activationAccessCode": "sample string 9"
          }
        ]
      }
    ],
    "workAddress": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "stateOrProvince": "sample string 4",
      "postalCode": "sample string 5",
      "phone": "sample string 6",
      "fax": "sample string 7",
      "country": "sample string 8"
    },
    "homeAddress": {},
    "loginStatus": "sample string 22",
    "passwordExpiration": "sample string 23",
    "lastLogin": "sample string 24",
    "sendActivationEmail": "sample string 25",
    "customSettings": [
      {}
    ],
    "profileImageUri": "sample string 26",
    "userProfileLastModifiedDate": "sample string 27",
    "signatureImageUri": "sample string 28",
    "initialsImageUri": "sample string 29",
    "jobTitle": "sample string 30"
  },
  "addressInformation": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "state": "sample string 4",
    "postalCode": "sample string 5",
    "phone": "sample string 6",
    "fax": "sample string 7",
    "country": "sample string 8",
    "firstName": "sample string 9",
    "lastName": "sample string 10",
    "email": "sample string 11",
    "supportedCountries": [
      {
        "isoCode": "sample string 1",
        "provinceValidated": "sample string 2",
        "name": "sample string 3",
        "provinces": [
          {
            "isoCode": "sample string 1",
            "name": "sample string 2"
          }
        ]
      }
    ]
  },
  "socialAccountInformation": {
    "provider": "sample string 1",
    "email": "sample string 2",
    "socialId": "sample string 3",
    "userName": "sample string 4"
  },
  "PaymentProcessorInformation": {
    "billingAgreementId": "sample string 1",
    "email": "sample string 2",
    "address": {}
  }
}
Response
{
  "accountId": "sample string 1",
  "accountName": "sample string 2",
  "userId": "sample string 3",
  "apiPassword": "sample string 4",
  "baseUrl": "sample string 5",
  "accountIdGuid": "sample string 6",
  "billingPlanPreview": {
    "subtotalAmount": "sample string 1",
    "taxAmount": "sample string 2",
    "totalAmount": "sample string 3",
    "isProrated": "sample string 4",
    "currencyCode": "sample string 5",
    "invoice": {
      "amount": "sample string 1",
      "taxableAmount": "sample string 2",
      "nonTaxableAmount": "sample string 3",
      "balance": "sample string 4",
      "dueDate": "sample string 5",
      "invoiceId": "sample string 6",
      "invoiceNumber": "sample string 7",
      "pdfAvailable": "sample string 8",
      "invoiceUri": "sample string 9",
      "invoiceItems": [
        {
          "chargeAmount": "sample string 1",
          "chargeName": "sample string 2",
          "invoiceItemId": "sample string 3",
          "quantity": "sample string 4",
          "unitPrice": "sample string 5"
        }
      ]
    }
  }
}
Generic XML Request/Response

Request
<newAccountDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <PaymentProcessorInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/API_REST.Models.v2">
    <d2p1:address />
    <d2p1:billingAgreementId>sample string 1</d2p1:billingAgreementId>
    <d2p1:email>sample string 2</d2p1:email>
  </PaymentProcessorInformation>
  <accountName>sample string 1</accountName>
  <accountSettings>
    <nameValue />
  </accountSettings>
  <addressInformation>
    <address1>sample string 1</address1>
    <address2>sample string 2</address2>
    <city>sample string 3</city>
    <country>sample string 8</country>
    <email>sample string 11</email>
    <fax>sample string 7</fax>
    <firstName>sample string 9</firstName>
    <lastName>sample string 10</lastName>
    <phone>sample string 6</phone>
    <postalCode>sample string 5</postalCode>
    <state>sample string 4</state>
    <supportedCountries>
      <country>
        <isoCode>sample string 1</isoCode>
        <name>sample string 3</name>
        <provinceValidated>sample string 2</provinceValidated>
        <provinces>
          <province>
            <isoCode>sample string 1</isoCode>
            <name>sample string 2</name>
          </province>
        </provinces>
      </country>
    </supportedCountries>
  </addressInformation>
  <creditCardInformation>
    <address>
      <city>sample string 3</city>
      <country>sample string 8</country>
      <fax>sample string 7</fax>
      <phone>sample string 6</phone>
      <state>sample string 4</state>
      <street1>sample string 1</street1>
      <street2>sample string 2</street2>
      <zip>sample string 5</zip>
    </address>
    <cardNumber>sample string 1</cardNumber>
    <cardType>sample string 5</cardType>
    <expirationMonth>sample string 2</expirationMonth>
    <expirationYear>sample string 3</expirationYear>
    <nameOnCard>sample string 4</nameOnCard>
  </creditCardInformation>
  <distributorCode>sample string 2</distributorCode>
  <distributorPassword>sample string 3</distributorPassword>
  <initialUser>
    <accountManagementGranular>
      <canManageAdmins>sample string 2</canManageAdmins>
      <canManageAdminsMetadata />
      <canManageGroups>sample string 3</canManageGroups>
      <canManageGroupsMetadata />
      <canManageSharing>sample string 4</canManageSharing>
      <canManageSharingMetadata />
      <canManageUsers>sample string 1</canManageUsers>
      <canManageUsersMetadata>
        <is21CFRPart11>sample string 5</is21CFRPart11>
        <options>
          <string>sample string 1</string>
        </options>
        <rights>sample string 1</rights>
        <uiHint>sample string 2</uiHint>
        <uiOrder>sample string 4</uiOrder>
        <uiType>sample string 3</uiType>
      </canManageUsersMetadata>
    </accountManagementGranular>
    <activationAccessCode>sample string 20</activationAccessCode>
    <countryCode>sample string 17</countryCode>
    <createdDateTime>sample string 10</createdDateTime>
    <customSettings>
      <nameValue />
    </customSettings>
    <email>sample string 7</email>
    <enableConnectForUser>sample string 21</enableConnectForUser>
    <firstName>sample string 11</firstName>
    <forgottenPasswordInfo>
      <forgottenPasswordAnswer1>sample string 2</forgottenPasswordAnswer1>
      <forgottenPasswordAnswer2>sample string 4</forgottenPasswordAnswer2>
      <forgottenPasswordAnswer3>sample string 6</forgottenPasswordAnswer3>
      <forgottenPasswordAnswer4>sample string 8</forgottenPasswordAnswer4>
      <forgottenPasswordQuestion1>sample string 1</forgottenPasswordQuestion1>
      <forgottenPasswordQuestion2>sample string 3</forgottenPasswordQuestion2>
      <forgottenPasswordQuestion3>sample string 5</forgottenPasswordQuestion3>
      <forgottenPasswordQuestion4>sample string 7</forgottenPasswordQuestion4>
    </forgottenPasswordInfo>
    <groupList>
      <group>
        <groupId>sample string 1</groupId>
        <groupName>sample string 2</groupName>
        <groupType>sample string 4</groupType>
        <permissionProfileId>sample string 3</permissionProfileId>
        <users>
          <userInfo>
            <activationAccessCode>sample string 9</activationAccessCode>
            <email>sample string 3</email>
            <loginStatus>sample string 7</loginStatus>
            <sendActivationEmail>sample string 8</sendActivationEmail>
            <uri>sample string 6</uri>
            <userId>sample string 2</userId>
            <userName>sample string 1</userName>
            <userStatus>sample string 5</userStatus>
            <userType>sample string 4</userType>
          </userInfo>
        </users>
      </group>
    </groupList>
    <homeAddress />
    <initialsImageUri>sample string 29</initialsImageUri>
    <isAdmin>sample string 4</isAdmin>
    <jobTitle>sample string 30</jobTitle>
    <lastLogin>sample string 24</lastLogin>
    <lastName>sample string 13</lastName>
    <loginStatus>sample string 22</loginStatus>
    <middleName>sample string 12</middleName>
    <password>sample string 8</password>
    <passwordExpiration>sample string 23</passwordExpiration>
    <permissionProfileId>sample string 15</permissionProfileId>
    <permissionProfileName>sample string 16</permissionProfileName>
    <profileImageUri>sample string 26</profileImageUri>
    <sendActivationEmail>sample string 25</sendActivationEmail>
    <sendActivationOnInvalidLogin>sample string 19</sendActivationOnInvalidLogin>
    <signatureImageUri>sample string 28</signatureImageUri>
    <subscribe>sample string 18</subscribe>
    <suffixName>sample string 14</suffixName>
    <title>sample string 9</title>
    <uri>sample string 6</uri>
    <userId>sample string 2</userId>
    <userName>sample string 1</userName>
    <userProfileLastModifiedDate>sample string 27</userProfileLastModifiedDate>
    <userSettings>
      <nameValue />
    </userSettings>
    <userStatus>sample string 5</userStatus>
    <userType>sample string 3</userType>
    <workAddress>
      <address1>sample string 1</address1>
      <address2>sample string 2</address2>
      <city>sample string 3</city>
      <country>sample string 8</country>
      <fax>sample string 7</fax>
      <phone>sample string 6</phone>
      <postalCode>sample string 5</postalCode>
      <stateOrProvince>sample string 4</stateOrProvince>
    </workAddress>
  </initialUser>
  <planInformation>
    <addOns>
      <addOn>
        <active>sample string 4</active>
        <addOnId>sample string 2</addOnId>
        <id>sample string 1</id>
        <name>sample string 3</name>
      </addOn>
    </addOns>
    <currencyCode>sample string 2</currencyCode>
    <freeTrialDaysOverride>sample string 3</freeTrialDaysOverride>
    <planFeatureSets>
      <featureSet>
        <currencyFeatureSetPrices>
          <currencyFeatureSetPrice>
            <currencyCode>sample string 1</currencyCode>
            <currencySymbol>sample string 5</currencySymbol>
            <envelopeFee>sample string 4</envelopeFee>
            <fixedFee>sample string 2</fixedFee>
            <seatFee>sample string 3</seatFee>
          </currencyFeatureSetPrice>
        </currencyFeatureSetPrices>
        <envelopeFee>sample string 5</envelopeFee>
        <featureSetId>sample string 1</featureSetId>
        <fixedFee>sample string 4</fixedFee>
        <is21CFRPart11>sample string 8</is21CFRPart11>
        <isActive>sample string 2</isActive>
        <isEnabled>sample string 7</isEnabled>
        <name>sample string 3</name>
        <seatFee>sample string 6</seatFee>
      </featureSet>
    </planFeatureSets>
    <planId>sample string 1</planId>
    <recipientDomains>
      <recipientDomain>
        <active>sample string 4</active>
        <domainCode>sample string 2</domainCode>
        <domainName>sample string 3</domainName>
        <recipientDomainId>sample string 1</recipientDomainId>
      </recipientDomain>
    </recipientDomains>
  </planInformation>
  <referralInformation>
    <advertisementId>sample string 11</advertisementId>
    <enableSupport>sample string 1</enableSupport>
    <externalOrgId>sample string 18</externalOrgId>
    <groupMemberId>sample string 15</groupMemberId>
    <idType>sample string 16</idType>
    <includedSeats>sample string 2</includedSeats>
    <industry>sample string 17</industry>
    <planStartMonth>sample string 8</planStartMonth>
    <promoCode>sample string 14</promoCode>
    <publisherId>sample string 12</publisherId>
    <referralCode>sample string 9</referralCode>
    <referrerName>sample string 10</referrerName>
    <saleDiscountAmount>sample string 4</saleDiscountAmount>
    <saleDiscountFixedAmount>sample string 5</saleDiscountFixedAmount>
    <saleDiscountPercent>sample string 3</saleDiscountPercent>
    <saleDiscountPeriods>sample string 6</saleDiscountPeriods>
    <saleDiscountSeatPriceOverride>sample string 7</saleDiscountSeatPriceOverride>
    <shopperId>sample string 13</shopperId>
  </referralInformation>
  <socialAccountInformation>
    <email>sample string 2</email>
    <provider>sample string 1</provider>
    <socialId>sample string 3</socialId>
    <userName>sample string 4</userName>
  </socialAccountInformation>
</newAccountDefinition> 
Response
<newAccountSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <accountId>sample string 1</accountId>
  <accountIdGuid>sample string 6</accountIdGuid>
  <accountName>sample string 2</accountName>
  <apiPassword>sample string 4</apiPassword>
  <baseUrl>sample string 5</baseUrl>
  <billingPlanPreview>
    <currencyCode>sample string 5</currencyCode>
    <invoice>
      <amount>sample string 1</amount>
      <balance>sample string 4</balance>
      <dueDate>sample string 5</dueDate>
      <invoiceId>sample string 6</invoiceId>
      <invoiceItems>
        <billingInvoiceItem>
          <chargeAmount>sample string 1</chargeAmount>
          <chargeName>sample string 2</chargeName>
          <invoiceItemId>sample string 3</invoiceItemId>
          <quantity>sample string 4</quantity>
          <unitPrice>sample string 5</unitPrice>
        </billingInvoiceItem>
      </invoiceItems>
      <invoiceNumber>sample string 7</invoiceNumber>
      <invoiceUri>sample string 9</invoiceUri>
      <nonTaxableAmount>sample string 3</nonTaxableAmount>
      <pdfAvailable>sample string 8</pdfAvailable>
      <taxableAmount>sample string 2</taxableAmount>
    </invoice>
    <isProrated>sample string 4</isProrated>
    <subtotalAmount>sample string 1</subtotalAmount>
    <taxAmount>sample string 2</taxAmount>
    <totalAmount>sample string 3</totalAmount>
  </billingPlanPreview>
  <userId>sample string 3</userId>
</newAccountSummary> 
}} />