The changes between REST API v5 and v6 require bigger changes of the API client implementations, as this version switch addressed many known disadvantages of the v3-v5 API versions. This migration guide should give an overview on how to migrate from API v5 to API v6. As there are no big changes between v4 and v5, this guide will also be helpful for integrations that are still on API v4. For those for projects that are still using API v3 or v4, we recommend to migrate to v5 first following the v3 to v5 guide, and then migrate in a 2nd step from v5 to v6 using this guide.
...
| Info |
|---|
API v5 will remain part of the product beyond the announced removal of v3, while REST API v6 is already available. For existing integrations, staying on API v5 is ok as long as no new features of v6 are required, but our recommendation is to start early to migrate to API v6 even in consideration of the effort, to be prepared for the situation when you need a new functionality that is available on API v6 only. |
| Warning |
|---|
Important information: If you have been utilizing the API v5 to create envelopes and are planning to retrieve theses envelopes using API calls from v6, it is crucial to be aware of potential compatibility issues. Due to changes and updates between API versions, certain calls made from v6 may result in errors related to invalid API version ("InvalidEnvelopeApiVersion") when attempting to retrieve envelopes created with API v5. A possible solution is to continue using the v5 calls to retrieve the envelopes created via v5 if one of the following API calls is needed to retrieve the envelope/template or draft. See following affected api call:
|
| Info | ||
|---|---|---|
| ||
Please keep using API v5 if you are using one of this features listed below:
Already implemented: See also eSignAnyWhere Release News for more detail.
|
...
We take into account that the words "whitelist" and "blacklist" can be perceived as offensive and hurtful words. It has never been our intention to imply discriminatory or other-valued meanings in the use of these terminologies beyond the purely technical interpretation of including or excluding a subset of parameters from larger sets. We have changed our terminology to "allowlist" and "blocklist" to reflect the worldwide discussion of these terms over the past two years, or are now using descriptive namings for an inclusion lists such as in the ActionCallbackSelection.
In an eSignAnyWhere Envelope, we are now using the term "activity" instead of "recipient". The term "recipient" didn't work gracefully for situations where the "recipient" was just a background service activity such as an "automatic signing" or "automatic sealing" activity. We follow the terminology borrowed from the Business Process Modelling Notation (BPMN), as we consider an envelope as being processed in a signature workflow.
...
| API v1-v5 | API v6 | |||
|---|---|---|---|---|
| Status Values envelope/get | Status Value envelope/find | Status Value envelope/get | Status Value envelope/find | Comment |
| Started | Active | Active | Active | |
| InProgress | ||||
| ActionRequired | ActionRequired | ActionRequired is a status interpretation (derived from "Active") in context of the current user who calls envelope/find. | ||
| WaitingForOthers | WaitingForOthers | WaitingForOthers is a status interpretation (derived from "Active") in context of the current user who calls envelope/find. | ||
| Completed | Completed | Completed | Completed | |
| CompletedWithWarnings | ||||
| Canceled | Canceled | Canceled | Canceled | |
| Rejected | Rejected | Rejected | Rejected | |
| (ExpiringSoon) | ExpiringSoon | Active | ExpiringSoon | ExpiringSoon was defined in the v5 model of envelope/get, but actually not used. |
| Expired | Expired | Expired | Expired | |
| BulkCompleted | (n/a) | (n/a) | (n/a) | Separated to API methods in "/envelopebulk" route |
| BulkPartlyCompleted | (n/a) | (n/a) | (n/a) | Separated to API methods in "/envelopebulk" route |
| Draft | Draft | (n/a) | (n/a) | Separated to API methods in "/draft" route |
| Template | Template | (n/a) | (n/a) | Separated to API methods in "/template" route |
...
| API v5 | API v6 |
|---|---|
| CI | IdentityCard |
| PA | DriverLicense |
| PASS | Passport |
| RP | ResidencePermit |
| CIE | NationalElectronicIdentityCard |
| RT | TemporaryResidencePermit |
| DC | EmbassyDocument |
| PD* | |
| ID* | |
| PN* | |
| AT* |
*Not supported with api v6 and UI - but still available with older api versions than api v6.
Complexity Reduction
Structural Changes for Bulk Sending via API & for managing parent envelopes resulting from bulk-sending
...
The functionality of both methods
POST /v5/envelope/:envelopeId/restart
- GET /v5/envelope/:envelopeId/restart/{expirationInDays} (where the verb GET was misleading)
...