...
| 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:
| ||
| 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.
|
...
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.
To emphasize the global aspect of the solution, we have adapted terminologies so that they are suitable for worldwide use. One example is the division of the name into the firstName and lastName, which is not common in every region of the world. Based on common recommendations, we are now using the terms givenName and surname.
Envelope Status Enumeration
The envelope status values have been reviewed, and status values are now aligned with the status value shown in the WebUI.
...
Business Process Modelling Notation (BPMN), as we consider an envelope as being processed in a signature workflow.
To emphasize the global aspect of the solution, we have adapted terminologies so that they are suitable for worldwide use. One example is the division of the name into the firstName and lastName, which is not common in every region of the world. Based on common recommendations, we are now using the terms givenName and surname.
Envelope Status Enumeration
The envelope status values have been reviewed, and status values are now aligned with the status value shown in the WebUI.
| 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 |
Disposable Certificate Enumeration
Please see the following changes referring to the identification types and the document types for disposable certificate:
Identification type
| API v5 | API v6 |
|---|---|
| None | None |
| FOREIGN_TAX_CODE | ForeignTaxCode |
| PERSONAL_NUMBER | PersonalNumber |
| PASSPORT | Passport |
| NATIONAL_IDENTITY_CARD | NationalIdentityCard |
| ITALIAN_TAX_CODE | ItalianTaxCode |
| NO_SERIAL_NUMBER | NoSerialNumber |
| DRIVING_LICENSE | DrivingLicense |
| RESIDENCE_PERMIT | ResidencePermit |
| RESIDENCE_PERMIT_TEMP | TemporaryResidencePermit |
| EMBASSY_DOCUMENT | EmbassyDocument |
Document type
| 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
...