Gets account settings information
Retrieves the account settings information for the specified account.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/settings"{ "accessCodeFormat": { "formatRequired": "string", "letterRequired": "string", "minimumLength": "string", "numberRequired": "string", "specialCharacterRequired": "string" }, "accountDateTimeFormat": "string", "accountDefaultLanguage": "string", "accountName": "string", "accountNotification": { "expirations": { "expireAfter": "string", "expireEnabled": "string", "expireWarn": "string" }, "reminders": { "maximumReminderCount": "string", "reminderDelay": "string", "reminderEnabled": "string", "reminderFrequency": "string", "smartReminderEnabled": "string" }, "userOverrideEnabled": "string" }, "accountUISettings": { "adminMessage": { "baseMessage": "string", "moreInformation": "string" }, "allowUsersToEditSharedAccess": "string", "askAnAdmin": { "email": "string", "message": "string", "name": "string", "phone": "string" }, "clickwrapSchemaVersion": "string", "disableWebAppAccess": "string", "enableAdminMessage": "string", "enableEasySignCanUseMultiTemplateApply": "string", "enableEasySignTemplateUpload": "string", "enableEnvelopeCopyWithData": "string", "enableEnvelopeTypes": "string", "enableLegacySendflowLink": "string", "hasExternalLinkedAccounts": "string", "hideSendAnEnvelope": "string", "hideUseATemplate": "string", "hideUseATemplateInPrepare": "string", "orderBasedRecipientIdGeneration": "string", "removeEnvelopeForwarding": "string", "shouldRedactAccessCode": "string", "uploadNewImageToSignOrInitial": "string" }, "additionalSettings": [ { "name": "string", "value": "string" } ], "adoptSigConfig": "string", "advancedCorrect": "string", "advancedSearchEnableTabField": "string", "advancedSearchEnableTemplateIdField": "string", "advancedSearchEnableTemplateNameField": "string", "aiAssistedWebFormCreationLevel": "string", "allowAccessCodeFormat": "string", "allowAccountManagementGranular": "string", "allowAccountMemberNameChange": "string", "allowACE": "string", "allowAdvancedRecipientRoutingConditional": "string", "allowAgentNameEmailEdit": "string", "allowAgreementActions": "string", "allowAgreementOrchestrations": "string", "allowAutoNavSettings": "string", "allowAutoTagging": "string", "allowBulkSend": "string", "allowBYOIDV": "string", "allowCDWithdraw": "string", "allowConnectAgreementUI": "string", "allowConnectAuthoritativeCopyReadyEventUI": "string", "allowConnectEnvelopeReminderSentEventUI": "string", "allowConnectEnvelopeRemovedEvent": "string", "allowConnectExtensionUI": "string", "allowConnectHttpListenerConfigs": "string", "AllowConnectIdentityVerificationUI": "string", "allowConnectOAuthUI": "string", "allowConnectSendFinishLater": "string", "allowConnectUnifiedPayloadUI": "string", "allowConnectWorkspaceUploadRequestUI": "string", "allowConsumerDisclosureOverride": "string", "allowDataDownload": "string", "allowDelayedRouting": "string", "allowDelegatedSigning": "string", "allowDocGenDocuments": "string", "allowDocumentDisclosures": "string", "allowDocumentsOnSignedEnvelopes": "string", "allowDocumentVisibility": "string", "allowEditingEnvelopesOnBehalfOfOthers": "string", "allowEHankoStamps": "string", "allowENoteEOriginal": "string", "allowEnvelopeCorrect": "string", "allowEnvelopeCustodyTransfer": "string", "allowEnvelopeCustomFields": "string", "allowEnvelopePublishReporting": "string", "allowEnvelopeReporting": "string", "allowExpression": "string", "allowExpressSignerCertificate": "string", "allowExtendedSendingResourceFile": "string", "allowExternalLinkedAccounts": "string", "allowExternalSignaturePad": "string", "allowFedRampIDVLevel1": "string", "allowFedRampIDVLevel2": "string", "allowIDVForEUQualifiedSignatures": "string", "allowIDVLevel1": "string", "allowIDVLevel1Trial": "string", "allowIDVLevel2": "string", "allowIDVLevel3": "string", "allowIDVPlatform": "string", "allowIdvRiskAssessment": "string", "allowInPerson": "string", "allowInPersonElectronicNotary": "string", "allowManagedStamps": "string", "allowManagingEnvelopesOnBehalfOfOthers": "string", "allowMarkup": "string", "allowMemberTimeZone": "string", "allowMergeFields": "string", "allowMultipleBrandProfiles": "string", "allowMultipleSignerAttachments": "string", "allowNonUSPhoneAuth": "string", "allowOcrOfEnvelopeDocuments": "string", "allowOfflineSigning": "string", "allowOnlyStandaloneWebForms": "string", "allowOpenTrustSignerCertificate": "string", "allowOrganizationBranding": "string", "allowOrganizationDocusignMonitor": "string", "allowOrganizationDocusignMonitorFree": "string", "allowOrganizationDomainUserManagement": "string", "allowOrganizations": "string", "allowOrganizationSsoManagement": "string", "allowOrganizationToUseInPersonElectronicNotary": "string", "allowOrganizationToUseRemoteNotary": "string", "allowOrganizationToUseThirdPartyElectronicNotary": "string", "allowParticipantRecipientType": "string", "allowPaymentProcessing": "string", "allowPendingDestinationUrlEdition": "string", "allowPerformanceAnalytics": "string", "allowPhoneAuthentication": "string", "allowPhoneAuthOverride": "string", "allowPrivateSigningGroups": "string", "allowRecipientConnect": "string", "allowReminders": "string", "allowRemoteNotary": "string", "allowResourceFileBranding": "string", "allowSafeBioPharmaSignerCertificate": "string", "allowScheduledSending": "string", "allowSecurityAppliance": "string", "allowSendingEnvelopesOnBehalfOfOthers": "string", "allowSendToCertifiedDelivery": "string", "allowSendToIntermediary": "string", "allowServerTemplates": "string", "allowSetEmbeddedRecipientStartURL": "string", "allowSharedTabs": "string", "allowSignatureStamps": "string", "allowSignDocumentFromHomePage": "string", "allowSignerReassign": "string", "allowSignerReassignOverride": "string", "allowSigningExtensions": "string", "allowSigningGroups": "string", "allowSigningInsights": "string", "allowSigningRadioDeselect": "string", "allowSignNow": "string", "allowSignNowMetadata": "string", "allowSMSDelivery": "string", "allowSocialIdLogin": "string", "allowSupplementalDocuments": "string", "allowThirdPartyElectronicNotary": "string", "allowTransactionsWorkspace": "string", "allowTransactionsWorkspaceOriginal": "string", "allowUsersToAccessDirectory": "string", "allowValueInsights": "string", "allowWebForms": "string", "allowWhatsAppDelivery": "string", "anchorPopulationScope": "string", "anchorTagVersionedPlacementEnabled": "string", "attachCompletedEnvelope": "string", "authenticationCheck": "string", "autoNavRule": "string", "autoProvisionSignerAccount": "string", "bccEmailArchive": "string", "betaSwitchConfiguration": "string", "billingAddress": { "address1": "string", "address2": "string", "city": "string", "country": "string", "fax": "string", "phone": "string", "postalCode": "string", "stateOrProvince": "string", "zipPlus4": "string" }, "bulkSend": "string", "bulkSendActionResendLimit": "string", "bulkSendMaxCopiesInBatch": "string", "bulkSendMaxUnprocessedEnvelopesCount": "string", "canSelfBrandSend": "string", "canSelfBrandSign": "string", "canUseSalesforceOAuth": "string", "captureVoiceRecording": "string", "cfr21SimplifiedSigningEnabled": "string", "cfrUseWideImage": "string", "checkForMultipleAdminsOnAccount": "string", "chromeSignatureEnabled": "string", "cloudReady": "string", "commentEmailShowMessageText": "string", "commentsAllowEnvelopeOverride": "string", "conditionalFieldsEnabled": "string", "consumerDisclosureFrequency": "string", "convertPdfFields": "string", "customExtractionPlanLevels": "string", "dataPopulationScope": "string", "defaultSigningResponsiveView": "string", "defaultSigningResponsiveViewUseGrade": "string", "defaultToAdvancedEnvelopesFilterForm": "string", "disableAutoTemplateMatching": "string", "disableLegacyKba": "string", "disableLegacySharedEnvelopes": "string", "disableMobileApp": "string", "disableMobilePushNotifications": "string", "disableMobileSending": "string", "disableMultipleSessions": "string", "disableSignerCertView": "string", "disableSignerHistoryView": "string", "disableStyleSignature": "string", "disableUploadSignature": "string", "disableUserSharing": "string", "displayBetaSwitch": "string", "documentConversionRestrictions": "string", "documentRetention": "string", "documentRetentionPurgeTabs": "string", "documentVisibility": "string", "draftEnvelopeRetention": "string", "dss_SIGN_28411_EnableLeavePagePrompt_RadminOption": "string", "dss_SIGN_29182_SlideUpBar_RadminOption": "string", "emailTemplateVersion": "string", "enableAccessCodeGenerator": "string", "enableAccountWideSearch": "string", "enableAdditionalAdvancedWebFormsFeatures": "string", "enableAdmHealthcare": "string", "enableAdvancedEnvelopesSearch": "string", "enableAdvancedPayments": "string", "enableAdvancedPowerForms": "string", "enableAdvancedSearch": "string", "enableAgreementActionsForCLM": "string", "enableAgreementActionsForESign": "string", "enableAgreementDeskAdvanced": "string", "enableAIAgents": "string", "enableAIContractReview": "string", "enableAISenderMessage": "string", "enableAISuggestedFields": "string", "enableAISuggestedFieldsAutoPlace": "string", "enableAutoNav": "string", "enableBatchUpdateEnvelopeTypes": "string", "enableBccDummyLink": "string", "enableCacPivSignatureGroup": "string", "enableCalculatedFields": "string", "enableCFRRapidSigningEmbeddedAuth": "string", "enableClickPlus": "string", "enableClickPlusConditionalContent": "string", "enableClickPlusCustomFields": "string", "enableClickPlusCustomStyle": "string", "enableClickPlusDynamicContent": "string", "enableClickwraps": "string", "enableCombinedPDFDownloadForSBS": "string", "enableCommentsHistoryDownloadInSigning": "string", "enableContactSuggestions": "string", "enableContentSearch": "string", "enableCoupaCoreExtension": "string", "enableCoupaIAMConnector": "string", "enableCustomDataVerificationExtensions": "string", "enableCustomerSatisfactionMetricTracking": "string", "enableDataVerificationExtensions": "string", "enableDocumentTemplateLibrary": "string", "enableDSigEUAdvancedPens": "string", "enableDSigExpressPens": "string", "enableDSigIDCheckForAESPens": "string", "enableDSigIDCheckInPersonForQESPens": "string", "enableDSigIDCheckRemoteForQESPens": "string", "enableDSigIDVerificationPens": "string", "enableDSigIDVerificationPremierPens": "string", "enableDSigPenGroupEuQes": "string", "enableDSigPlgEuQesPens": "string", "enableDSPro": "string", "enableEnvelopeStampingByAccountAdmin": "string", "enableEnvelopeStampingByDSAdmin": "string", "enableESignAPIHourlyLimitManagement": "string", "enableEsignCommunities": "string", "enableEsignTaskList": "string", "enableGenerationWith3PIntegration": "string", "enableGreenhouseApp": "string", "enableI9OnDemand": "string", "enableIAMClauseLibrary": "string", "enableIAMforXEmbeddedUX": "string", "enableIDFxAccountlessSMSAuthForPart11": "string", "enableIDFxIntuitKBA": "string", "enableIDFxPhoneAuthentication": "string", "enableIdfxPhoneAuthSignatureAuthStatus": "string", "enableInboxBrowseViewsPoweredByElasticSearch": "string", "enableInboxRelevanceSort": "string", "enableInBrowserEditor": "string", "enableKeyTermsSuggestionsByDocumentType": "string", "enableLargeFileSupport": "string", "enableLegacySharedEnvelopes": "string", "enableLicenseManagement": "string", "enableMicrosoftDynamics365Extension": "string", "enableMultiUserRepositoryFeatures": "string", "enableNavigatorAPIDataIn": "string", "enableNavigatorAPIDataOut": "string", "enableNavigatorAPIUtilities": "string", "enableNavigatorForHR": "string", "enableNavigatorHierarchyAI": "string", "enableNavigatorPartialIngestion": "string", "enableNavigatorTrial": "string", "enableNotaryOnDemandWitness": "string", "enableObligationManagement": "string", "enablePaymentProcessing": "string", "enablePDFAConversion": "string", "enablePowerForm": "string", "enablePowerFormDirect": "string", "enablePremiumDataVerificationExtensions": "string", "enableRecipientDomainValidation": "string", "enableRecipientMayProvidePhoneNumber": "string", "enableReportLinks": "string", "enableRequireSignOnPaper": "string", "enableReservedDomain": "string", "enableResponsiveSigning": "string", "enableReviewerEventsSetting": "string", "enableSAPAribaExtension": "string", "enableScheduledRelease": "string", "enableSearchServiceAzureUri": "string", "enableSearchSiteSpecificApi": "string", "enableSendingTagsFontSettings": "string", "enableSendToAgent": "string", "enableSendToIntermediary": "string", "enableSendToManage": "string", "enableSequentialSigningAPI": "string", "enableSequentialSigningUI": "string", "enableSignerAttachments": "string", "enableSigningAIFeaturesPlan": "string", "enableSigningExtensionComments": "string", "enableSigningExtensionConversations": "string", "enableSigningGroupContinuePageSetting": "string", "enableSigningOrderSettingsForAccount": "string", "enableSignOnPaper": "string", "enableSignOnPaperOverride": "string", "enableSignWithNotary": "string", "enableSmartContracts": "string", "enableSMSAuthentication": "string", "enableSMSDeliveryAdditionalNotification": "string", "enableSMSDeliveryPrimary": "string", "enableSocialIdLogin": "string", "enableStrikeThrough": "string", "enableTickets": "string", "enableTransactionPoint": "string", "enableUnifiedRepository": "string", "enableVaulting": "string", "enableWebFormsRuntimeAPIs": "string", "enableWebFormsSeparateUserPermissions": "string", "enableWitnessing": "string", "enableWorkdayFinancialsExtension": "string", "enableWorkdayHRApp": "string", "enforceTemplateNameUniqueness": "string", "enforceTlsEmails": "string", "envelopeIntegrationAllowed": "string", "envelopeIntegrationEnabled": "string", "EnvelopeLimitsTotalDocumentSizeAllowedInMB": "string", "EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabled": "string", "envelopeSearchMode": "string", "envelopeStampingDefaultValue": "string", "exitPrompt": "string", "expressSend": "string", "expressSendAllowTabs": "string", "externalDocumentSources": { "boxnetEnabled": "string", "dropboxEnabled": "string", "googleDriveEnabled": "string", "oneDriveEnabled": "string", "salesforceEnabled": "string" }, "externalSignaturePadType": "string", "faxOutEnabled": "string", "finishReminder": "string", "forbidAddingUserStamps": "string", "guidedFormsHtmlAllowed": "string", "guidedFormsHtmlConversionPolicy": "string", "hasRecipientConnectClaimedDomain": "string", "hideAccountAddressInCoC": "string", "hidePricing": "string", "idCheckConfigurations": [ { "authSteps": [ { "authType": "string" } ], "isDefault": "string", "name": "string" } ], "idCheckExpire": "string", "idCheckExpireDays": "string", "idCheckExpireMinutes": "string", "idCheckRequired": "string", "identityVerification": [ { "defaultDescription": "string", "defaultName": "string", "displayOrder": "string", "inputOptions": [ { "isRequired": true, "optionName": "string", "valueType": "string" } ], "isDisabled": "string", "ownerType": "string", "signatureProvider": { "isRequired": "string", "priority": "string", "signatureProviderDisplayName": "string", "signatureProviderId": "string", "signatureProviderName": "string", "signatureProviderOptionsMetadata": [ { "signatureProviderOptionDisplayName": "string", "signatureProviderOptionHintOverrideValue": "string", "signatureProviderOptionId": "string", "signatureProviderOptionName": "string", "signatureProviderOptionRegexValidationPattern": "string" } ], "signatureProviderRequiredOptions": [ { "requiredSignatureProviderOptionIds": [ "string" ], "signerType": "string" } ] }, "workflowId": "string", "workflowLabel": "string", "workflowResourceKey": "string" } ], "idfxKBAAuthenticationOverride": "string", "idfxPhoneAuthenticationOverride": "string", "ignoreErrorIfAnchorTabNotFound": "string", "inPersonIDCheckQuestion": "string", "inPersonSigningEnabled": "string", "inSessionEnabled": "string", "inSessionSuppressEmails": "string", "isConnectDocumentFieldsEnabled": "string", "isvEmbed": "string", "isvOemEmbed": "string", "linkedExternalPrimaryAccounts": [ { "accountName": "string", "configurationId": "string", "email": "string", "exemptMembersOfSameAccountFromAuth": "string", "linkId": "string", "pdfFieldHandlingOption": "string", "pdfFieldHandlingPrefillTabPermission": "string", "pdfFieldHandlingStandardInputTabPermission": "string", "pdfFieldHandlingStandardTabPermission": "string", "recipientAuthRequirements": { "accessCode": "string", "idVerification": "string", "kba": "string", "phone": "string" }, "status": "string", "userId": "string" } ], "maestroPlanLevels": "string", "maximumSigningGroups": "string", "maximumUsersPerSigningGroup": "string", "maxNumberOfCustomStamps": "string", "mergeMixedModeResults": "string", "mobileSessionTimeout": "string", "numberOfActiveCustomStamps": "string", "optInMobileSigningV02": "string", "optInUniversalSignatures": "string", "optOutAutoNavTextAndTabColorUpdates": "string", "optOutNewPlatformSeal": "string", "originalAccountSite": "string", "participantCopyOptOut": "string", "pdfMaxChunkedUploadPartSize": "string", "pdfMaxChunkedUploadTotalSize": "string", "pdfMaxIndividualUploadSize": "string", "phoneAuthRecipientMayProvidePhoneNumber": "string", "pkiSignDownloadedPDFDocs": "string", "readOnlyMode": "string", "recipientsCanSignOffline": "string", "recipientSigningAutoNavigationControl": "string", "recycleBinEnvelopeRetention": "string", "require21CFRpt11Compliance": "string", "requireDeclineReason": "string", "requireExternalUserManagement": "string", "requireSignerCertificateType": "string", "rsaVeridAccountName": "string", "rsaVeridPassword": "string", "rsaVeridRuleset": "string", "rsaVeridUserId": "string", "selfSignedRecipientEmailDocument": "string", "selfSignedRecipientEmailDocumentUserOverride": "string", "senderCanSignInEachLocation": "string", "senderMustAuthenticateSigning": "string", "sendingTagsFontColor": "string", "sendingTagsFontName": "string", "sendingTagsFontSize": "string", "sendLockoutRecipientNotification": "string", "sendToCertifiedDeliveryEnabled": "string", "sessionTimeout": "string", "setRecipEmailLang": "string", "setRecipSignLang": "string", "sharedTemplateFolders": "string", "showCompleteDialogInEmbeddedSession": "string", "showConditionalRoutingOnSend": "string", "showInitialConditionalFields": "string", "showLocalizedWatermarks": "string", "showMaskedFieldsWhenDownloadingDocumentAsSender": "string", "showTutorials": "string", "signatureProviders": [ "string" ], "signDateFormat": "string", "signDateTimeAccountLanguageOverride": "string", "signDateTimeAccountTimezoneOverride": "string", "signerAttachCertificateToEnvelopePDF": "string", "signerAttachConcat": "string", "signerCanCreateAccount": "string", "signerCanSignOnMobile": "string", "signerInSessionUseEnvelopeCompleteEmail": "string", "signerLoginRequirements": "string", "signerMustHaveAccount": "string", "signerMustLoginToSign": "string", "signerShowSecureFieldInitialValues": "string", "signingSessionTimeout": "string", "signingUiVersion": "string", "signTimeFormat": "string", "signTimeShowAmPm": "string", "simplifiedSendingEnabled": "string", "singleSignOnEnabled": "string", "skipAuthCompletedEnvelopes": "string", "socialIdRecipAuth": "string", "specifyDocumentVisibility": "string", "startInAdvancedCorrect": "string", "supplementalDocumentsMustAccept": "string", "supplementalDocumentsMustRead": "string", "supplementalDocumentsMustView": "string", "suppressCertificateEnforcement": "string", "tabAccountSettings": { "allowTabOrder": "string", "approveDeclineTabsEnabled": "string", "calculatedFieldsEnabled": "string", "checkboxTabsEnabled": "string", "dataFieldRegexEnabled": "string", "dataFieldSizeEnabled": "string", "drawTabsEnabled": "string", "enableTabAgreementDetails": "string", "firstLastEmailTabsEnabled": "string", "listTabsEnabled": "string", "noteTabsEnabled": "string", "numericalTabsEnabled": "string", "prefillTabsEnabled": "string", "radioTabsEnabled": "string", "savingCustomTabsEnabled": "string", "senderToChangeTabAssignmentsEnabled": "string", "sharedCustomTabsEnabled": "string", "tabDataLabelEnabled": "string", "tabLocationEnabled": "string", "tabLockingEnabled": "string", "tabScaleEnabled": "string", "tabTextFormattingEnabled": "string", "textTabsEnabled": "string", "uriTabsEnabled": "string" }, "timezoneOffsetAPI": "string", "timezoneOffsetUI": "string", "universalSignatureOptIn": "string", "universalSignatureSkipPlatformSignature": "string", "useAccountLevelEmail": "string", "useConsumerDisclosure": "string", "useConsumerDisclosureWithinAccount": "string", "useDerivedKeys": "string", "useDocuSignExpressSignerCertificate": "string", "useEnvelopeSearchMixedMode": "string", "useMultiAppGroupsData": "string", "useNewBlobForPdf": "string", "useNewEnvelopeSearch": "string", "useNewEnvelopeSearchOnlyWhenSearchingAfterDate": "string", "useNewEnvelopeSearchOnlyWithSearchTerm": "string", "useSAFESignerCertificates": "string", "usesAPI": "string", "useSignatureProviderPlatform": "string", "useSmartContractsV1": "string", "validationsAllowed": "string", "validationsBrand": "string", "validationsCadence": "string", "validationsEnabled": "string", "validationsReport": "string", "waterMarkEnabled": "string", "writeReminderToEnvelopeHistory": "string", "wurflMinAllowableScreenSize": "string"}Deletes the signature for one or more captive recipient records DELETE
This method deletes the signature for one or more captive recipient records. It is primarily used for testing. This functionality provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.
Updates the account settings for an account PUT
Updates the account settings for the specified account. Although the request body for this method is a complete `accountSettingsInformation` object, you only need to provide the properties that you are updating.