Before you use the API, we recommend you to read the Datasure eSign API concept on https://docs.datasure.net, to get an overview about our programming interface, data types and basic concepts.

General Concepts

The application includes user authentication on application level. Therefore, it is required to provide credentials for authorization:

Api token or
Bearer token

We recommend to create different API keys for different application integrations, to avoid configuring the samekey in various integration systems.This allows, e.g. in case of sharing a key by mistake, to disable one key while keeping other integrations working with their existing configuration.You can find the settings for the credentials for authorization in your Settings->Api Tokens andApps.

Note: The ApiToken must be set as header either as apiToken header or bearer token header.

On status change, our back-end notifies integrations by calling an HTTP(S) endpoint as a callback.
Error handling:
1. HTTP 40x for handled errors
  - In a HTTP 40x we return an error code and an error info
2. or HTTP 500 for generic server errors
Callbacks
1. Envelope callbacks: This is the basic callback which is fired if the envelope reaches a final state
2. Envelope status callback: Is fired, based on envelope events/actions
3. Draft callback: Is fired, if a draft is used or deleted

More details about those topics are documented in our online resources

200OK

400BadRequest

403Forbidden

404NotFound