We declared SOAP as deprecated and therefore SOAP will not be included in versions after 21.76. Latest release including SOAP API for eSAW will be 21.76, released in spring 2022 and with the software maintenance on 21.76 until spring 2024. From now on, until discontinuation of SOAP API, the SOAP API will mainly remain as it is, new features will be available only via REST API. On Shared SaaS, the SOAP API will not be available after April 2022.
We recommend using our REST API for your integration and migrate existing projects. Please see also the migration guide.
API and Samplecode
The API is for developers, who want to integrate eSignAnyWhere into their application and for administrators, who want to script interactions with eSignAnyWhere (e.g. user synchronization).
Quick Overview: eSAW uses REST or SOAP (with JSON or XML) as API. We recommend the REST interface (see eSignAnyWhere_SampleCode , Hello World Tutorial, SOAP UI Tutorial, REST tutorial using Postman). The basic workflow is to upload a document (
uploadTemporarySspFile) and then call
sendEnvelope with a envelope configuration (for SOAP the Envelope XML). For more information about the envelope configuration please also have a look at the Beginner-Guide. The configuration consists out of the envelope part (workflow configuration) and for each recipient a definition and a signing configuration (workstep configuration). The workstep configuration is the description (as JSON for REST) of tasks for signer (e.g. Signature Fields, Form-Fields) and additional document configurations.
The easiest way to start is enabling the DeveloperMode for a user. As developer (and power user) you can send envelopes via eSignAnywhere in the UI and download the complete envelope configuration (including the workstep configurations). So eSAW can be a seen as configuration designer, where you can easily prepare the envelope configuration. After you downloaded the configuration you just have to replace the recipient information and configuration.
|REST API Reference (Swagger) | >= 3.1 |||https://demo.esignanywhere.net/Api|
|Migration from SOAP to REST|
For those customers and system integrators who integrated with our SOAP API in the past and now need to migrate to the REST API due to announced discontinuation of the SOAP API.
|REST tutorials||This turorials help getting familiar with the API technology and the most common tools to do first tests of API calls already before implementing your own integration code.|
visit REST tutorial using Postman
visit REST tutorial using SoapUI
|Tutorial: Hello World*|
This tutorial allows to dig into the API integration of eSignAnyWhere a bit deeper. It focuses on audience already familiar with tools to run API calls, such as Postman or SoapUI.
|Developer mode*||visit developer mode|
SOAP API Reference
|visit SOAP API Reference (eSAW & Usermanagement)|
The Envelope XML and WorkstepConfiguration XML
|visit Envelope XML Guide|
eSAW SOAP API endpoint
eSAW SOAP WSDL
Usermanagement SOAP API endpoint
Usermanagement SOAP WSDL
Tutorial: SoapUI (SOAP)
|visit SoapUI Tutorial|
Tutorial: Java Library Tutorial and Sample Code
|visit Java Library Tutorial|
|Sample Code in C# and Java|
SignAnyWhere Viewer 2019
|visit SignAnyWhere Viewer 2019 Information|
|SignAnyWhere Viewer Extended Customization||visit SignAnyWhere Viewer Extended Customization|
|Integration & Use Cases||visit Integration & Use Cases|
|Developer FAQ||visit Developer FAQ|
|eSAW Error Codes||visit eSAW Error Codes|
You can find additional information about callbacks, authorization and the eSAW API for SOAP on the following page: Api-Reference