eZmax API Definition (1.0.18)

Download OpenAPI specification:Download

This API expose all the functionnalities for the eZmax and eZsign application.

We provide SDKs for customers. They are generated using OpenAPI codegen, we encourage customers to use them as we also provide samples for them.

You can choose to build your own implementation manually or can use any compatible OpenAPI 3.0 generator like Swagger Codegen, OpenAPI codegen or any commercial generators.

If you need helping understanding how to use this API, don't waste too much time looking for it. Contact support-api@ezmax.ca, we're here to help. We are developpers so we know programmers don't like bad documentation. If you don't find what you need in the documentation, let us know, we'll improve it and put you rapidly up on track.

Authentication

Authorization

There are 3 types of API Key that can be used to make requests to the API.

  1. API type key which is static and not session based. It can be generated from the admin console. This is the most common type of authentication for "server to server" kind of integration. Never use this in a web based (client) application as the key could be leaked. This type of key begins with the letter A.

  2. Delegated type key which has an expiration time. It is commonly used in mobile or web application where you cannot use an API type key that could be leaked. The application would query a server part that will generate a Delegated type key using an API type key. The Delegated type key could now be used by the mobile or web page application without leaking the API type key. This type of key begins with the letter D.

  3. User type key which are session based and can be retrieved after a successful authentication. This type of key is reserved to specific situation where the other types of key are not desirable. This type of key begins with the letter U.

Security Scheme Type API Key
Header parameter name: Authorization

Activesession

Activesession contains detail about the currently executing api request.

Get Current Activesession

Retrieve the details about the current activesession

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "mPayload":
    {
    },
  • "objDebugPayload":
    {
    },
  • "objDebug":
    {
    }
}

Ezsignfolder

Ezsignfolder contains detail about the container containing signers, documents to sign, etc. Sometimes referred as "Envelopes" in competitor products

Create a new Ezsignfolder

The endpoint allows to create one or many elements at once.

The array can contain simple (Just the object) or compound (The object and its child) objects.

Creating compound elements allows to reduce the multiple requests to create all child objects.

Authorizations:
Request Body schema: application/json
Array ()
object (ezsignfolder-Request)

An Ezsignfolder Object

object (ezsignfolder-RequestCompound)

An Ezsignfolder Object and children to create a complete structure

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "mPayload":
    {
    },
  • "objDebugPayload":
    {
    },
  • "objDebug":
    {
    }
}

Retrieve an existing Ezsignfolder

Authorizations:
path Parameters
pkiEzsignfolderID
required
integer

The unique ID of the Ezsignfolder

Responses

Response samples

Content type
application/json
{
  • "mPayload":
    {
    },
  • "objDebugPayload":
    {
    },
  • "objDebug":
    {
    }
}

Modify an existing Ezsignfolder

Authorizations:
path Parameters
pkiEzsignfolderID
required
integer

The unique ID of the Ezsignfolder

Request Body schema: application/json
object (ezsignfolder-Request)

An Ezsignfolder Object

Responses

Request samples

Content type
application/json
{
  • "objEzsignfolder":
    {
    }
}

Response samples

Content type
application/json
{
  • "objDebugPayload":
    {
    },
  • "objDebug":
    {
    }
}

Delete an existing Ezsignfolder

Authorizations:
path Parameters
pkiEzsignfolderID
required
integer

The unique ID of the Ezsignfolder

Responses

Response samples

Content type
application/json
{
  • "objDebugPayload":
    {