See DocuSign Support Center for Product Release Notes.
API Changes (Click to expand)
Added support for version v2.1-24.2.00.00 of the Docusign ESignature API.
Updated Envelopes: get
Added new optional query parameter named include_anchor_tab_locations of type string.
Updated Envelopes: update
Added new optional query parameter named recycle_on_void of type string.
Updated EnvelopeViews : createCorrect
Request body object correctViewRequest has been changed to envelopeViewRequest.
- Added fields:
freeEnvelopeSendsRemainingForAdvancedDocGen
-
Added fields:
defaultSigningResponsiveViewdefaultSigningResponsiveViewMetadatadss_SCOREFDN_196_Rebrand_DocuSignIsNotAVerbenableAdditionalAdvancedWebFormsFeaturesenableAdditionalAdvancedWebFormsFeaturesMetadata
-
Removed fields:
enableSaveAsEnvelopeCustomFieldInWebFormsenableSaveAsEnvelopeCustomFieldInWebFormsMetadata
- Added field:
rowValues
- Added field:
canNotaryCorrectEnvelope
- Added field:
enableTabAgreementDetailsenableTabAgreementDetailsMetadata
bulkSendingCopyDocGenFormFieldRowValue
- Upgradation of OWASP for vulnerability check of dependencies.
- Updated the SDK release version.
- Deprecation of OLTU library: The OLTU library for handling OAuth is no longer used.
- Upgradation of OWASP for vulnerability check of dependencies.
- Updated the SDK release version.
- Added support for version v2.1-24.2.00.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Model classes are now serializable.
- Resolved an issue where setting a default SSL socket for the entire JVM caused unintended side effects.
- Fixed a memory leak related to the class loader.
- Addressed dependency vulnerabilities in the following libraries:
bcprov-jdk18onupdated to version 1.78.1com.fasterxml.jackson.coreupdated to version 2.17.1org.jsonupdated to version 20240303jerseyupdated to version 3.1.6
The "token_scopes" parameter has been moved from path parameters to query parameters for the above mentioned endpoint.
Updated EnvelopeView:CreateSender and EnvelopeView:CreateEdit
The body parameter returnUrlRequest has been changed to envelopeViewRequest.
envelopeViewRequest has the same properties as the previous returnUrlRequest but now includes additional viewAccess and settings properties, where settings is a complex object with several UI controls for the view experience.
Updated TemplateViews: createEdit
The body parameter returnUrlRequest has been changed to templateViewRequest.
templateViewRequest has the same properties as the previous returnUrlRequest but now includes an additional viewAccess string.
- Updated existing models
-
Added fields:
allowConnectEnvelopeRemovedEventallowOrganizationBrandingallowOrganizationBrandingMetadataallowPendingDestinationUrlEditionallowPendingDestinationUrlEditionMetadatadisableBulkSendRecipientLimitdisableBulkSendRecipientLimitMetaDataenableAdvancedSearchenableAdvancedSearchMetadataenableContentSearchenableContentSearchMetadataenableMultiUserRepositoryFeaturesenableMultiUserRepositoryFeaturesMetadataenablePremiumDataVerificationExtensionsenablePremiumDataVerificationExtensionsMetadataenableSaveAsEnvelopeCustomFieldInWebFormsenableSaveAsEnvelopeCustomFieldInWebFormsMetadataenableScheduledReleaseenableScheduledReleaseMetadataisvOemEmbedisvOemEmbedMetaData
-
Removed fields:
enableInboxRelevanceSortForRecentAccountsenableInboxRelevanceSortForRecentAccountsMetadataenableScheduledReleaseenableScheduledReleaseMetadataenableSearchenableSearchMetadataenableSearchUIenableSearchUIMetadata
- Added fields:
enableEnvelopeTypesenableEnvelopeTypesMetadata
- Added field:
uSigState
- Added field:
uSigState
- Added property:
lastModifiedOn
- Added property:
displayFormat
- Added properties:
accountAgreementsAccessTypeaccountAgreementsAccessTypeMetadatacanBulkUploadAgreementscanBulkUploadAgreementsMetadatacanManageAgreementPartiescanManageAgreementPartiesMetadata
envelopeViewDocumentSettingsenvelopeViewEnvelopeCustomFieldSettingsenvelopeViewRecipientSettingsenvelopeViewRequestenvelopeViewSettingsenvelopeViewTaggerSettingsenvelopeViewTemplateSettingspaletteItemSettingspaletteSettingstemplateViewRequest
returnUrlRequest
- Added support for version v2.1-24.1.01.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Modified the default basePath to
DEMO_REST_BASEPATH.
- Revised the logic to determine the
oAuthBasePathbased on thebasePath. - Added support for version v2.1-23.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-23.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Modified the default basePath to
DEMO_REST_BASEPATH.
- Revised the logic to determine the
oAuthBasePathbased on thebasePath. - Added support for version v2.1-23.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-23.3.01.02 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-23.3.00.01 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-23.2.00.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-23.1.01.01 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-23.1.01.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Migrated from Java EE to Jakarta
- Updated dependencies to the Jakarta supported versions
- In order to use this version of the Java ESign SDK, clients must upgrade to Jakarta
- Clients that are unable to upgrade to Jakarta may reference the Uber JAR in order to maintain backwards compatibility
- Added support for version v2.1-22.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Bundled external dependencies into an uber jar.
- Added support for version v2.1-22.3.01.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-1.2.7 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-22.2.00.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-22.1.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-22.1.01.00 of the DocuSign ESignature API.
- Updated the SDK release version.
-
Following models are renamed
ScheduledSendingApiModelis renamed toScheduledSendingDelayedRoutingApiModelis renamed toDelayedRouting
- Added support for version v2.1-21.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- regression issues with List tabs class wrongly named "ModelList".
- Added support for version v2.1-21.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-21.4.01.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-21.4.00.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Added support for version v2.1-21.3.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Code linting.
- Added support for version v2-21.3.00.00 of the DocuSign eSignature API.
- Updated the SDK release version.
- SSL certificate chain-of-trust validation. (DCM-5802)
- Removed jackson-datatype-joda dependency.
- Added support for version v2.1-21.2.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Removed Joda dependency.
- Added support for version v2.1-21.2.00.00 of the DocuSign eSignature API.
- Updated the SDK release version.
- Added support for version v2.1-21.2.00.00 of the DocuSign eSignature API.
- Updated the SDK release version.
- Issue
#194: Error Reading Entity from Input Stream. (DCM-5802)
- Issue
#194: Error Reading Entity from Input Stream. (DCM-5802)
- Removed methods
getAccountSettingsExport,getSealProvidersfrom Accounts. - Removed methods
createConnectSecret,deleteConnectSecret,generateConnectSecret,getConnectSecretsfrom Connect. - Removed methods
getDynamicSystemSettings,getTemplateInfo,getApplianceInfo,getAccount,getCustomFields,deleteCustomFieldsV2,getDocumentPages,getImage,getLocalePolicy,updatePageInfo,createPageInfo,deletePageInfo,updatePdf,getPdf,getPdfBlob,updatePdfBlob,createPdfBlob,updateRecipientDeniedDocumentCopy,deleteRecipientDeniedDocumentCopy,getSignerAttachment,deleteSignerAttachment, from Envelopes. - Removed methods
completeSignHash,getUserInfo,healthCheck,signHashSessionInfo,updateTransactionfrom TrustServiceProviders. - Removed methods
getUserListExportfrom Users.
- Added new methods
getBulkSendBatchEnvelopesto BulkEnvelopes.
- Added support for version v2.1-21.1.02.00 of the DocuSign eSignature API.
- Updated the SDK release version.
- Added new methods
deleteCustomFieldsV2,deletePageInfoV2,getApplianceEnvelopeInfo,getTemplateInfoto envelopes. - Added new method
deleteConnectSecretto connect.
- Added support for version v2.1-21.1.01.03 of the DocuSign eSignature API.
- Updated the SDK release version.
- Added support for version v2.1-21.1.01 of the DocuSign eSignature API.
- Updated the SDK release version.
- Added support for version v2.1-20.4.01 of the DocuSign eSignature API.
- Updated the SDK release version.
- Expected field name for Group level brands resource model is
brandOptions(as opposed tobrands). The model name has been renamed toGroupBrands(instead ofBrandsResponse). Setter and Getter methods were also updated. (DCM-4463)
- Added support for version v2.1-20.3.01 of the DocuSign eSignature API.
- Updated the SDK release version.
- Updated ApiClient to use an empty JSON object if the body is null. (DCM-4359)
- AccountBrands::updateBrandResourcesByContentType is missing brand file option. (DCM-3868)
- Added support for version v2.1-20.3.01 of the DocuSign eSignature API.
- Updated the SDK release version.
- Added support for version v2.1-20.3.00 of the DocuSign eSignature API.
- Updated the SDK release version.
- Added support for version v2.1-20.3.00 of the DocuSign eSignature API.
- Updated the SDK release version.
- Upgraded the HTTP client from Jersey1 to Jersey 2. This resulted in a non-breaking change but the dependency list has largely been changed. (DCM-3324)
- Added support for request body in all DELETE methods. (DCM-4454)
- Added support for version v2.1-20.2.02 of the DocuSign eSignature API.
- Updated the SDK release version.
- Upgraded the HTTP client from Jersey1 to Jersey 2. This resulted in a non-breaking change but the dependency list has largely been changed. (DCM-3324)
- Added support for request body in all DELETE methods. (DCM-4454)
- Added support for version v2.1-20.2.02 of the DocuSign eSignature API.
- Updated the SDK release version.
- Upgraded the HTTP client from Jersey1 to Jersey 2. This resulted in a non-breaking change but the dependency list has largely been changed. (DCM-3324)
- Added support for version v2.1-20.2.00 of the DocuSign eSignature API.
- Updated the SDK release version.
- Added support for version v2.1-20.1.02 of the DocuSign eSignature API.
- Updated the SDK release version.
- Added support for version v2.1-20.1.00 of the DocuSign eSignature API.
- Updated the SDK release version.
- POST calls fail on some instances of WebLogic server because of strict Content-Length policy (DCM-3939).
- Added the new property
copyRecipientDatato envelopes. When set to true, the information that recipients enter is retained when you clone an envelope. For example, if you resend an envelope that was declined or voided after one or more recipients entered data, that data is retained. Note that the new account UI settingenableEnvelopeCopyWithDatamust be enabled for the account. - Added
RecipientIdentityInputOptionandinputOptionstoRecipientIdentityVerification: Reserved for DocuSign.
- POST calls fail on some instances of WebLogic server because of strict Content-Length policy. (DCM-3939)
- The SDK now supports version 19.4.01 of the DocuSign eSignature v2.1 API.
- SDK Release Version updated.
- The SDK now supports version 19.4.01 of the DocuSign eSignature v2.1 API.
- SDK Release Version updated.
- The SDK now supports version 19.2.02 of the DocuSign eSignature v2.1 API.
- SDK Release Version updated.
- Changed JDK versions for TravisCI as older versions reached EOL.
- Issue
#55: Unable to revoke OAuth token. (DCM-2926) - requestJWTUserToken does not give error response in exception. (DCM-3410)
- The SDK now supports version 19.2.02 of the DocuSign eSignature v2.1 API.
- SDK Release Version updated.
- Issue
#55: Unable to revoke OAuth token. (DCM-2926) - requestJWTUserToken does not give error response in exception. (DCM-3410)
- Issue
#98: 411 Error thrown from BulkEnvelopesAPI updateRecipients call.
- The SDK now supports version v2.1-19.1.02 of the DocuSign eSignature v2.1 API.
- SDK Release Version updated.
- Removed hardcoded test config values from the test cases. Now getting test config values from the environment variables.
- The SDK now supports version v2.1-19.1.02 of the DocuSign eSignature v2.1 API.
- SDK Release Version updated.
- The SDK now supports version 19.1.02 of the DocuSign eSignature API.
- SDK Release Version updated.
- Added support for the new http.nonProxyHosts Proxy option, which you can use to indicate hosts that should be accessed without going through a proxy. (DCM-2850)
- Added new Cache-Control and Pragma headers to OAuth server request calls. (DCM-2242)
- Added a new tabGroupLabels field to all Tabs models
- Added a new Witnesses field to all Recipients models
- Implemented models for Smart Sections feature
- Implemented initial support of HMAC for DocuSign Connect
- A bug with that could cause the moveEnvelopes method call to return a response without a Content-Type header. (DCM-1403)
- A bug that could prevent a user from replacing their JWT auth token. (DCM-3209)
- Removed Gradle references to an insecure/outdated Jackson package. (DCM-3267)
- A regression bug where the ApiClient authentications member field was locked and prevented writing to it.
- The SDK now supports version 19.1.02 of the DocuSign eSignature API.
- SDK Release Version updated.
- Added support for the new http.nonProxyHosts Proxy option, which you can use to indicate hosts that should be accessed without going through a proxy. (DCM-2850)
- Added new Cache-Control and Pragma headers to OAuth server request calls. (DCM-2242)
- Added a new tabGroupLabels field to all Tabs models
- Added a new Witnesses field to all Recipients models
- Implemented models for Smart Sections feature
- Implemented initial support of HMAC for DocuSign Connect
- A bug with that could cause the moveEnvelopes method call to return a response without a Content-Type header. (DCM-1403)
- A bug that could prevent a user from replacing their JWT auth token. (DCM-3209)
- Removed Gradle references to an insecure/outdated Jackson package. (DCM-3267)
- Support for the latest DocuSign API (18.4.02.00).
- Support for HTTP(S) proxy through System Properties. The supported proxy parameters are:
- For HTTPS (recommended): https.proxyHost, https.proxyPort, https.proxyUser and https.proxyPassword
- For HTTP: http.proxyHost, http.proxyPort, http.proxyUser and http.proxyPassword
- Fixed a problem with the AccountsApi.UpdateBrandLogoByType method that prevented it from uploading brand logos.
- Fixed AuthName comparison. (DCM-3160)
- Support for the latest DocuSign API (18.4.02.00).
- Fixed a problem with the AccountsApi.UpdateBrandLogoByType method that prevented it from uploading brand logos.
- Support for HTTP(S) proxy through System Properties. The supported proxy parameters are:
- For HTTPS (recommended): https.proxyHost, https.proxyPort, https.proxyUser and https.proxyPassword
- For HTTP: http.proxyHost, http.proxyPort, http.proxyUser and http.proxyPassword
- CVE-2018-19360.
- CVE-2018-19362.
- CVE-2018-19361.
- CVE-2018-14719.
- CVE-2018-14720.
- CVE-2018-14721.
- CVE-2018-14718.
- Fixed a problem with the BulkEnvelopesApi.UpdateRecipients method that could cause it to return a "Value cannot be null.\r\nParameter name: stream" error rather than add bulk recipients to an envelope. (DCM-2137)
- Fixed a problem with the EnvelopesApi.listStatus methods that could cause them to ignore sets of envelope IDs passed in to get statuses for specific envelopes. (DCM-2953)
- Fixed a problem with the EnvelopesApi.updateChunkedUpload method that could cause it to fail and return a 411 error. (DCM-2978)
- Surfaced the authentication error that might be returned by the ApiClient.JWTUserToken method.
- The SDK now supports version 18.3.02 of the DocuSign API.
- Fixed a typo in a method name: getPasswordRules_0 has been changed to getAccountPasswordRules.
- A jackson-dataformat-csv library has been added to the SDK. You can use this library to serialize Lists into CSV format.
- BountyCastle bcprov library explicitly, for a more flexible dependency management.
- The ConfigureJwtAuthorizationFlowByKey method is now deprecated. Please use the RequestJWTUserToken method instead, which improves security by accepting the private key as a byte array or stream. (DCM-2763)
- The base path for OAuth authentication is now a property of the ApiClient object.
- Added a new method, RequestJWTUserToken. This method is passed a user's client id, user id, requested scopes, and their private key in byte array format, performs JWT authentication for the specified user, and returns an access token. (DCM-2763)
- Added a new method, RequestJWTApplicationToken. This is a reserved method that is only enabled by partners and resellers, which obtains an access token that makes requests on behalf of an application rather than a user. It is passed a user's client id, requested scopes, and a private key in byte array format, then returns an access token. (DCM-2763)
- SetOauthBasePath, which can be used to set the OAuth base path for your ApiClient. (DCM-2731)
- Fixed a problem that could cause the getUserInfo method to generate an exception when returning information about a user who was part of an organization. The method now returns same set of organization data as the oauth/userinfo API endpoint method.
- Forced support of TLS v1.2. See this post on the DocuSign Support Center for more information.
- Support for OAuth implicit grant.
- Support for OAuth Get User Info.
- PR
#71: Empty response body in ApiException. - CVE-2018-7489.
- Electronic Seals API (a.k.a. Advanced Signatures).
- jackson library version updated to 2.9.4.
- README code example description.
- README mention of direct binaries download. Users should use Maven or Gradle repos to download binaries. See Issue
#53.
- PR
#57: Avoid NPE in OAuth updateAccessToken(). - PR
#58: Return ClientHandlerException(), for non 200 response codes, in updateAccessToken(). - PR
#59: Return ApiException(), for non 2xx response codes, in invokeAPI(). - PR
#60: RFC conform handling for grant_type=refresh_token without code. - PR
#61: Check and set refresh_token in body of OAuth request.
- Support for Seals.
- eNotary API.
- Trusted Service Providers (TSP) API.
- 411 error when request body is empty.
- Support for DocuSign JWT OAuth for service integration (2-legged authentication).
- Unit tests under Java8 complain about AccessTokenListener being a nested class.
- Support for DocuSign 3-legged OAuth.
- TravisCI automatic tests.
- TravisCI and Maven badges.
- Updated the
Javadoc. - New test case to validate the
resend_envelopefeature forEnvelopesApi.updateRecipientscall.
- The SDK now supports theFull and latest DocuSign API support(17.1.00.00).
- Updated the package with the latest full API release. No omitted endpoints anymore.
- Updated the code snippet in the README file to use the API base url gotten from the login call, instead of using the default one. Required for integrations when they go live.
- Updated the README file with additional Authentication information.
- Issue
#27: SimpleDateFormat Exception in Java 1.6. - Issue
#89: resend_envelope functionality for envelopes recipients.
- Support of newer version of the DocuSign eSignature API.
- Updated the list of omitted endpoints.
- Issue with datetime on such systems such as Android plateform.
- Updated the package to a newer API release.
- jersey library version updated to 1.19.1.
- jackson library version updated to 2.7.0.
- Initial commit of the new Java SDK for DocuSign API, automatically generated from OpenAPI specification.
- Send-from-template recipe to the README documentation.
- Flattened the folder structure of the project page on Github, to look more like standard Java open-source projects.
- Updated NetBeans project file for unit tests.
- Switched to MIT license.
- Updated "core" recipes.
- Updated the list of omitted endpoints.
- Updated the README documentation.
- Several broken links in the README documentation.