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/accounts

Parameters

Parameter name Value Description
Optional query parameters
preview_billing_plan string

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

Request Body

Responses

Code Description Reference
201 Created Successful response.
400 Bad Request Error encountered.

SDK Method

Accounts::create

Definitions Expand All | Collapse All

Invoices

Invoices

amount string

Reserved: TBD

balance string

Reserved: TBD

dueDate string

Reserved: TBD

invoiceId string

Reserved: TBD

invoiceItems
[billingInvoiceItem]

Reserved: TBD

invoiceNumber string

Reserved: TBD

invoiceUri string

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

nonTaxableAmount string
pdfAvailable string
taxableAmount string

UserSocialAccountLogins

Users' social account logins

email string

The users email address.

errorDetails errorDetails
provider string

The social account provider (Facebook, Yahoo, etc.)

socialId string

The ID provided by the Socal Account.

userName string

The full user name for the account.

Users

User management

accountManagementGranular userAccountManagementGranularInformation

Describes which account management capabilities a user has.

activationAccessCode string

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

createdDateTime string

Indicates the date and time the item was created.

customSettings
[nameValue]

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

email string

The user's email address.

enableConnectForUser string

Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false.

errorDetails errorDetails
firstName string

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

forgottenPasswordInfo forgottenPasswordInformation

A complex element that has 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. Group information can be found by calling [ML:GET group information]. The only required parameter is groupId.

The parameters are:

  • groupId - The DocuSign group ID for the group.
  • groupName - The name of the group
  • permissionProfileId - The ID of the permission profile associated with the group.
  • groupType - The group type.
homeAddress addressInformation_v2

The user's physical home address.

initialsImageUri string

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

isAdmin string

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

jobTitle string
lastLogin string

The date-time when the user last logged on to the system.

lastName string

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

loginStatus string

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

  • password_reset
  • password_active
  • password_expired
  • password_locked
  • password_reset_failed
middleName string

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

password string
passwordExpiration string

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

permissionProfileId string
permissionProfileName string
profileImageUri string
sendActivationEmail string
sendActivationOnInvalidLogin string

When set to true, specifies that an additional activation email is sent to the user if they fail a log on before activating their account.

signatureImageUri string

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

suffixName string

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

Limit: 50 characters.

title string

Salutation for the user, such as Ms, Dr, Capt., etc.

Limit: 10 characters.

uri string
userId string

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 Admin on the account, this may be another user the Admin user is accessing.

userName string

The user's full name.

userProfileLastModifiedDate string

The date-time when the user's profile was last modified.

userSettings
[nameValue]

The collection of settings that describes the actions a user can perform. See User Settings for a list of available settings.

userStatus string

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
userType string
workAddress addressInformation_v2

The user's physical work address.

accountAddress

Contains information about an account address.

address1 string

First Line of the address. Maximum length: 100 characters.

address2 string

Second Line of the address. Maximum length: 100 characters.

city string

The city value of the address.

country string

Specifies the country associated with the address.

email string
fax string
firstName string

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

lastName string
phone string
postalCode string
state string

The state or province associated with the address.

supportedCountries
[country]

Contains an array of countries supported by the billing plan.

addOn

Contains information about add ons.

active string

Reserved:

addOnId string

Reserved:

id string
name string

Reserved:

addressInformation

Contains address information.

city string

The city associated with the address.

country string

Specifies the country associated with the address.

fax string

A Fax number associated with the address if one is available.

phone string

A phone number associated with the address.

state string

The state or province associated with the address.

street1 string

The first line of the address.

street2 string

The second line of the address (optional).

zip string

The zip or postal code associated with the address.

addressInformation_v2

address1 string

First Line of the address. Maximum length: 100 characters.

address2 string

Second Line of the address. Maximum length: 100 characters.

city string
country string

Specifies the country associated with the address.

fax string
phone string
postalCode string
stateOrProvince string

The state or province associated with the address.

billingInvoiceItem

Contains information about an item on a billing invoice.

chargeAmount string

Reserved: TBD

chargeName string

Reserved: TBD

invoiceItemId string

Reserved: TBD

quantity string

The quantity of envelopes to add to the account.

unitPrice string

Reserved: TBD

billingPlanPreview

Contains information about a preview billing plan.

currencyCode string

Specifies the ISO currency code for the account.

invoice Invoices
isProrated string
subtotalAmount string
taxAmount string
totalAmount string

country

isoCode string
name string
provinces
[province]
provinceValidated string

creditCardInformation

address addressInformation

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.

cardNumber string

The number on the credit card.

cardType string

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

expirationMonth string

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

expirationYear string

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

nameOnCard string

The exact name printed on the credit card.

currencyFeatureSetPrice

currencyCode string

Specifies the alternate ISO currency code for the account.

currencySymbol string

Specifies the alternate currency symbol for the account.

envelopeFee string

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

fixedFee string

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

seatFee string

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

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

featureSet

currencyFeatureSetPrices
[currencyFeatureSetPrice]

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

envelopeFee string
featureSetId string

A unique ID for the feature set.

fixedFee string
is21CFRPart11 string

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

isActive string
isEnabled string

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

name string
seatFee string

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.

forgottenPasswordAnswer1 string

The answer to the first forgotten password challenge question.

forgottenPasswordAnswer2 string

The answer to the second forgotten password challenge question.

forgottenPasswordAnswer3 string

The answer to the third forgotten password challenge question.

forgottenPasswordAnswer4 string

The answer to the fourth forgotten password challenge question.

forgottenPasswordQuestion1 string

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

forgottenPasswordQuestion2 string

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

forgottenPasswordQuestion3 string

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

forgottenPasswordQuestion4 string

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

group

errorDetails errorDetails
groupId string

The DocuSign group ID for the group.

groupName string

The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.

groupType string

The group type.

permissionProfileId string

The ID of the permission profile associated with the group.

users
[userInfo]

nameValue

errorDetails errorDetails
name string

The name or key of a name/value pair.

originalValue string

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

value string

The value field of a name/value pair.

newAccountDefinition

accountName string

The account name for the new account.

accountSettings
[nameValue]

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.

addressInformation accountAddress

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
creditCardInformation creditCardInformation

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

distributorCode string

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

distributorPassword string

The password for the distributorCode.

initialUser Users

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.

PaymentProcessorInformation paymentProcessorInformation
planInformation planInformation

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

referralInformation 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.
socialAccountInformation UserSocialAccountLogins

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

newAccountSummary

accountId string

The account ID associated with the envelope.

accountIdGuid string

The GUID associated with the account ID.

accountName string

The account name for the new account.

apiPassword string

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

baseUrl string

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.

billingPlanPreview billingPlanPreview
userId string

Specifies the user ID of the new user.

paymentProcessorInformation

address addressInformation
billingAgreementId string
email string

planInformation

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

addOns
[addOn]

Reserved:

currencyCode string

Specifies the ISO currency code for the account.

freeTrialDaysOverride string

Reserved for DocuSign use only.

planFeatureSets
[featureSet]

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

planId string

The DocuSign Plan ID for the account.

recipientDomains
[recipientDomain]

province

isoCode string
name string

recipientDomain

active string
domainCode string
domainName string
recipientDomainId string

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.
advertisementId string

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.
enableSupport string

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

externalOrgId string
groupMemberId string
idType string
includedSeats string

The number of seats (users) included.

industry string
planStartMonth string
promoCode string
publisherId string
referralCode string
referrerName string
saleDiscountAmount string

Reserved for DocuSign use only.

saleDiscountFixedAmount string

Reserved for DocuSign use only.

saleDiscountPercent string

Reserved for DocuSign use only.

saleDiscountPeriods string

Reserved for DocuSign use only.

saleDiscountSeatPriceOverride string

Reserved for DocuSign use only.

shopperId string

settingsMetadata

is21CFRPart11 string

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

options
[string]
rights string
uiHint string
uiOrder string
uiType string

userAccountManagementGranularInformation

Describes which account management capabilities a user has.

canManageAdmins string

True if the user can manage admins.

canManageAdminsMetadata settingsMetadata
canManageGroups string

True if the user can manage groups.

canManageGroupsMetadata settingsMetadata
canManageSharing string
canManageSharingMetadata settingsMetadata
canManageUsers string

True if the user can manage users.

canManageUsersMetadata settingsMetadata

userInfo

activationAccessCode string
email string
errorDetails errorDetails
loginStatus string
sendActivationEmail string
uri string
userId string

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 Admin on the account, this may be another user the Admin user is accessing.

userName string
userStatus string

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
userType string

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",
"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 17",
"activationAccessCode": "sample string 18",
"enableConnectForUser": "sample string 19",
"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 20",
"passwordExpiration": "sample string 21",
"lastLogin": "sample string 22",
"sendActivationEmail": "sample string 23",
"customSettings": [
{}
]
,
"profileImageUri": "sample string 24",
"userProfileLastModifiedDate": "sample string 25",
"signatureImageUri": "sample string 26",
"initialsImageUri": "sample string 27",
"jobTitle": "sample string 28"
}
,
"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 18</activationAccessCode>
<createdDateTime>sample string 10</createdDateTime>
<customSettings>
<nameValue />
</customSettings>
<email>sample string 7</email>
<enableConnectForUser>sample string 19</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 27</initialsImageUri>
<isAdmin>sample string 4</isAdmin>
<jobTitle>sample string 28</jobTitle>
<lastLogin>sample string 22</lastLogin>
<lastName>sample string 13</lastName>
<loginStatus>sample string 20</loginStatus>
<middleName>sample string 12</middleName>
<password>sample string 8</password>
<passwordExpiration>sample string 21</passwordExpiration>
<permissionProfileId>sample string 15</permissionProfileId>
<permissionProfileName>sample string 16</permissionProfileName>
<profileImageUri>sample string 24</profileImageUri>
<sendActivationEmail>sample string 23</sendActivationEmail>
<sendActivationOnInvalidLogin>sample string 17</sendActivationOnInvalidLogin>
<signatureImageUri>sample string 26</signatureImageUri>
<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 25</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>