Signing APIs Format
The E-Signing service is reachable using 2 different communication protocols:
-
TSOS – the legacy interface built on top of XMLDSIG over HTTP
-
ESOS – the newer REST API based on OpenAPI
-
Both TSOS and ESOS are available, and these developer site will cater for both. The underlying service, functions and features will be available through either interface.
-
Unlike TSOS, which had a downloadable client API, the ESOS API will be simpler to interact with as it relies on an OpenAPI specification.
-
ESOS is the E-Signing API for composing and managing sign orders. Please refer to the IN Groupe Developer site for details on how the E-Signing service works, and what the API can be used for.
-
E-Signing order service API specification can be downloaded here:
-
esos-v1 (1).yaml
This specification manages the following resources
-
Orders - a container for all instructions of a sign order
-
Documents - documents that are to be signed
-
Attachments - additional documents (these do not get signed)
-
Signers - definition of users that can sign documents
-
Exec-details - this defines the rules of engagement
Terms and expressions
-
Sign order, or order - the equivalent of a contract that can contain any number of signers, documents, and instructions
-
Merchant/customer - the client or customer using this API to manage orders
-
Order ID - a unique identifier for a sign order (defined by merchants)
-
Sign process - a context defining how signer interacts with the signing service (signer + document + execution detail = sign process)
If you are an existing customer of TSOS and wants to migrate to REST API than refer to this migration quide:
A merchant identifier (MID) and a secret code are required to integrate with ESOS API. The identifier and the code can be received by using the Contact us form to IN Groupe support.
To receive a dedicated setup, you need to be an E-Signing customer. To become a customer, contact our sales department at trustservices@ingroupe.com.
ESOS REST API yaml