ObjectEzsigndocumentApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method	HTTP request	Description
ezsigndocumentApplyEzsigntemplateV1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate	Apply an Ezsigntemplate to the Ezsigndocument.
ezsigndocumentApplyEzsigntemplateV2	POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate	Apply an Ezsigntemplate to the Ezsigndocument.
ezsigndocumentApplyEzsigntemplateglobalV1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplateglobal	Apply an Ezsigntemplateglobal to the Ezsigndocument.
ezsigndocumentCreateEzsignelementsPositionedByWordV1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord	Create multiple Ezsignsignatures/Ezsignformfieldgroups
ezsigndocumentCreateObjectV1	POST /1/object/ezsigndocument	Create a new Ezsigndocument
ezsigndocumentCreateObjectV2	POST /2/object/ezsigndocument	Create a new Ezsigndocument
ezsigndocumentDeclineToSignV1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign	Decline to sign
ezsigndocumentDeleteObjectV1	DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID}	Delete an existing Ezsigndocument
ezsigndocumentEditEzsignformfieldgroupsV1	PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups	Edit multiple Ezsignformfieldgroups
ezsigndocumentEditEzsignsignaturesV1	PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures	Edit multiple Ezsignsignatures
ezsigndocumentEndPrematurelyV1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely	End prematurely
ezsigndocumentFlattenV1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten	Flatten
ezsigndocumentGetActionableElementsV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements	Retrieve actionable elements for the Ezsigndocument
ezsigndocumentGetAttachmentsV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments	Retrieve Ezsigndocument's Attachments
ezsigndocumentGetCompletedElementsV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements	Retrieve completed elements for the Ezsigndocument
ezsigndocumentGetDownloadUrlV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType}	Retrieve a URL to download documents.
ezsigndocumentGetEzsignannotationsV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations	Retrieve an existing Ezsigndocument's Ezsignannotations
ezsigndocumentGetEzsigndiscussionsV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsigndiscussions	Retrieve an existing Ezsigndocument's Ezsigndiscussions
ezsigndocumentGetEzsignformfieldgroupsV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups	Retrieve an existing Ezsigndocument's Ezsignformfieldgroups
ezsigndocumentGetEzsignpagesV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages	Retrieve an existing Ezsigndocument's Ezsignpages
ezsigndocumentGetEzsignsignaturesAutomaticV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic	Retrieve an existing Ezsigndocument's automatic Ezsignsignatures
ezsigndocumentGetEzsignsignaturesV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignatures	Retrieve an existing Ezsigndocument's Ezsignsignatures
ezsigndocumentGetFormDataV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData	Retrieve an existing Ezsigndocument's Form Data
ezsigndocumentGetObjectV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}	Retrieve an existing Ezsigndocument
ezsigndocumentGetObjectV2	GET /2/object/ezsigndocument/{pkiEzsigndocumentID}	Retrieve an existing Ezsigndocument
ezsigndocumentGetTemporaryProofV1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof	Retrieve the temporary proof
ezsigndocumentGetWordsPositionsV1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions	Retrieve positions X,Y of given words from a Ezsigndocument
ezsigndocumentPatchObjectV1	PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID}	Patch an existing Ezsigndocument
ezsigndocumentSubmitEzsignformV1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform	Submit the Ezsignform
ezsigndocumentUnsendV1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend	Unsend the Ezsigndocument

ezsigndocumentApplyEzsigntemplateV1

EzsigndocumentApplyEzsigntemplateV1Response ezsigndocumentApplyEzsigntemplateV1(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateV1Request)

Apply an Ezsigntemplate to the Ezsigndocument.

This function is deprecated. Please use applyEzsigntemplate instead which is doing the same thing but with a capital "E" to normalize the nomenclature. This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    EzsigndocumentApplyEzsigntemplateV1Request ezsigndocumentApplyEzsigntemplateV1Request = new EzsigndocumentApplyEzsigntemplateV1Request(); // EzsigndocumentApplyEzsigntemplateV1Request | 
    try {
      EzsigndocumentApplyEzsigntemplateV1Response result = apiInstance.ezsigndocumentApplyEzsigntemplateV1(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentApplyEzsigntemplateV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
ezsigndocumentApplyEzsigntemplateV1Request	EzsigndocumentApplyEzsigntemplateV1Request

Return type

EzsigndocumentApplyEzsigntemplateV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentApplyEzsigntemplateV2

EzsigndocumentApplyEzsigntemplateV2Response ezsigndocumentApplyEzsigntemplateV2(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateV2Request)

Apply an Ezsigntemplate to the Ezsigndocument.

This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    EzsigndocumentApplyEzsigntemplateV2Request ezsigndocumentApplyEzsigntemplateV2Request = new EzsigndocumentApplyEzsigntemplateV2Request(); // EzsigndocumentApplyEzsigntemplateV2Request | 
    try {
      EzsigndocumentApplyEzsigntemplateV2Response result = apiInstance.ezsigndocumentApplyEzsigntemplateV2(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateV2Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentApplyEzsigntemplateV2");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
ezsigndocumentApplyEzsigntemplateV2Request	EzsigndocumentApplyEzsigntemplateV2Request

Return type

EzsigndocumentApplyEzsigntemplateV2Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentApplyEzsigntemplateglobalV1

EzsigndocumentApplyEzsigntemplateglobalV1Response ezsigndocumentApplyEzsigntemplateglobalV1(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateglobalV1Request)

Apply an Ezsigntemplateglobal to the Ezsigndocument.

This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    EzsigndocumentApplyEzsigntemplateglobalV1Request ezsigndocumentApplyEzsigntemplateglobalV1Request = new EzsigndocumentApplyEzsigntemplateglobalV1Request(); // EzsigndocumentApplyEzsigntemplateglobalV1Request | 
    try {
      EzsigndocumentApplyEzsigntemplateglobalV1Response result = apiInstance.ezsigndocumentApplyEzsigntemplateglobalV1(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateglobalV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentApplyEzsigntemplateglobalV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
ezsigndocumentApplyEzsigntemplateglobalV1Request	EzsigndocumentApplyEzsigntemplateglobalV1Request

Return type

EzsigndocumentApplyEzsigntemplateglobalV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentCreateEzsignelementsPositionedByWordV1

EzsigndocumentCreateEzsignelementsPositionedByWordV1Response ezsigndocumentCreateEzsignelementsPositionedByWordV1(pkiEzsigndocumentID, ezsigndocumentCreateEzsignelementsPositionedByWordV1Request)

Create multiple Ezsignsignatures/Ezsignformfieldgroups

Using this endpoint, you can create multiple Ezsignsignatures/Ezsignformfieldgroups positioned by word at the same time.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    EzsigndocumentCreateEzsignelementsPositionedByWordV1Request ezsigndocumentCreateEzsignelementsPositionedByWordV1Request = new EzsigndocumentCreateEzsignelementsPositionedByWordV1Request(); // EzsigndocumentCreateEzsignelementsPositionedByWordV1Request | 
    try {
      EzsigndocumentCreateEzsignelementsPositionedByWordV1Response result = apiInstance.ezsigndocumentCreateEzsignelementsPositionedByWordV1(pkiEzsigndocumentID, ezsigndocumentCreateEzsignelementsPositionedByWordV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentCreateEzsignelementsPositionedByWordV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
ezsigndocumentCreateEzsignelementsPositionedByWordV1Request	EzsigndocumentCreateEzsignelementsPositionedByWordV1Request

Return type

EzsigndocumentCreateEzsignelementsPositionedByWordV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentCreateObjectV1

EzsigndocumentCreateObjectV1Response ezsigndocumentCreateObjectV1(ezsigndocumentCreateObjectV1Request)

Create a new Ezsigndocument

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.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    List<EzsigndocumentCreateObjectV1Request> ezsigndocumentCreateObjectV1Request = Arrays.asList(); // List<EzsigndocumentCreateObjectV1Request> | 
    try {
      EzsigndocumentCreateObjectV1Response result = apiInstance.ezsigndocumentCreateObjectV1(ezsigndocumentCreateObjectV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentCreateObjectV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
ezsigndocumentCreateObjectV1Request	List<EzsigndocumentCreateObjectV1Request>

Return type

EzsigndocumentCreateObjectV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successful response	-
413	The request was large. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body. If the error is recoverable sTemporaryFileUrl will be set and you can use this url to try a new request without sending the file over again	-

ezsigndocumentCreateObjectV2

EzsigndocumentCreateObjectV2Response ezsigndocumentCreateObjectV2(ezsigndocumentCreateObjectV2Request)

Create a new Ezsigndocument

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

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    EzsigndocumentCreateObjectV2Request ezsigndocumentCreateObjectV2Request = new EzsigndocumentCreateObjectV2Request(); // EzsigndocumentCreateObjectV2Request | 
    try {
      EzsigndocumentCreateObjectV2Response result = apiInstance.ezsigndocumentCreateObjectV2(ezsigndocumentCreateObjectV2Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentCreateObjectV2");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
ezsigndocumentCreateObjectV2Request	EzsigndocumentCreateObjectV2Request

Return type

EzsigndocumentCreateObjectV2Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successful response	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body. If the error is recoverable sTemporaryFileUrl will be set and you can use this url to try a new request without sending the file over again	-

ezsigndocumentDeclineToSignV1

EzsigndocumentDeclineToSignV1Response ezsigndocumentDeclineToSignV1(pkiEzsigndocumentID, ezsigndocumentDeclineToSignV1Request)

Decline to sign

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    EzsigndocumentDeclineToSignV1Request ezsigndocumentDeclineToSignV1Request = new EzsigndocumentDeclineToSignV1Request(); // EzsigndocumentDeclineToSignV1Request | 
    try {
      EzsigndocumentDeclineToSignV1Response result = apiInstance.ezsigndocumentDeclineToSignV1(pkiEzsigndocumentID, ezsigndocumentDeclineToSignV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentDeclineToSignV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
ezsigndocumentDeclineToSignV1Request	EzsigndocumentDeclineToSignV1Request

Return type

EzsigndocumentDeclineToSignV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentDeleteObjectV1

EzsigndocumentDeleteObjectV1Response ezsigndocumentDeleteObjectV1(pkiEzsigndocumentID)

Delete an existing Ezsigndocument

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentDeleteObjectV1Response result = apiInstance.ezsigndocumentDeleteObjectV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentDeleteObjectV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentDeleteObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentEditEzsignformfieldgroupsV1

EzsigndocumentEditEzsignformfieldgroupsV1Response ezsigndocumentEditEzsignformfieldgroupsV1(pkiEzsigndocumentID, ezsigndocumentEditEzsignformfieldgroupsV1Request)

Edit multiple Ezsignformfieldgroups

Using this endpoint, you can edit multiple Ezsignformfieldgroups at the same time.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    EzsigndocumentEditEzsignformfieldgroupsV1Request ezsigndocumentEditEzsignformfieldgroupsV1Request = new EzsigndocumentEditEzsignformfieldgroupsV1Request(); // EzsigndocumentEditEzsignformfieldgroupsV1Request | 
    try {
      EzsigndocumentEditEzsignformfieldgroupsV1Response result = apiInstance.ezsigndocumentEditEzsignformfieldgroupsV1(pkiEzsigndocumentID, ezsigndocumentEditEzsignformfieldgroupsV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentEditEzsignformfieldgroupsV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
ezsigndocumentEditEzsignformfieldgroupsV1Request	EzsigndocumentEditEzsignformfieldgroupsV1Request

Return type

EzsigndocumentEditEzsignformfieldgroupsV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentEditEzsignsignaturesV1

EzsigndocumentEditEzsignsignaturesV1Response ezsigndocumentEditEzsignsignaturesV1(pkiEzsigndocumentID, ezsigndocumentEditEzsignsignaturesV1Request)

Edit multiple Ezsignsignatures

Using this endpoint, you can edit multiple Ezsignsignatures at the same time.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    EzsigndocumentEditEzsignsignaturesV1Request ezsigndocumentEditEzsignsignaturesV1Request = new EzsigndocumentEditEzsignsignaturesV1Request(); // EzsigndocumentEditEzsignsignaturesV1Request | 
    try {
      EzsigndocumentEditEzsignsignaturesV1Response result = apiInstance.ezsigndocumentEditEzsignsignaturesV1(pkiEzsigndocumentID, ezsigndocumentEditEzsignsignaturesV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentEditEzsignsignaturesV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
ezsigndocumentEditEzsignsignaturesV1Request	EzsigndocumentEditEzsignsignaturesV1Request

Return type

EzsigndocumentEditEzsignsignaturesV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentEndPrematurelyV1

EzsigndocumentEndPrematurelyV1Response ezsigndocumentEndPrematurelyV1(pkiEzsigndocumentID, body)

End prematurely

End prematurely an Ezsigndocument when some signatures are still required

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    Object body = null; // Object | 
    try {
      EzsigndocumentEndPrematurelyV1Response result = apiInstance.ezsigndocumentEndPrematurelyV1(pkiEzsigndocumentID, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentEndPrematurelyV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
body	Object

Return type

EzsigndocumentEndPrematurelyV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentFlattenV1

EzsigndocumentFlattenV1Response ezsigndocumentFlattenV1(pkiEzsigndocumentID, body)

Flatten

Flatten an Ezsigndocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    Object body = null; // Object | 
    try {
      EzsigndocumentFlattenV1Response result = apiInstance.ezsigndocumentFlattenV1(pkiEzsigndocumentID, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentFlattenV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
body	Object

Return type

EzsigndocumentFlattenV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentGetActionableElementsV1

EzsigndocumentGetActionableElementsV1Response ezsigndocumentGetActionableElementsV1(pkiEzsigndocumentID)

Retrieve actionable elements for the Ezsigndocument

Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetActionableElementsV1Response result = apiInstance.ezsigndocumentGetActionableElementsV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetActionableElementsV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetActionableElementsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentGetAttachmentsV1

EzsigndocumentGetAttachmentsV1Response ezsigndocumentGetAttachmentsV1(pkiEzsigndocumentID)

Retrieve Ezsigndocument's Attachments

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetAttachmentsV1Response result = apiInstance.ezsigndocumentGetAttachmentsV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetAttachmentsV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetAttachmentsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

ezsigndocumentGetCompletedElementsV1

EzsigndocumentGetCompletedElementsV1Response ezsigndocumentGetCompletedElementsV1(pkiEzsigndocumentID)

Retrieve completed elements for the Ezsigndocument

Return the completed Ezsignsignatures, Ezsignformfieldgroups and Ezsignannotations at the current step in the process

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetCompletedElementsV1Response result = apiInstance.ezsigndocumentGetCompletedElementsV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetCompletedElementsV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetCompletedElementsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentGetDownloadUrlV1

EzsigndocumentGetDownloadUrlV1Response ezsigndocumentGetDownloadUrlV1(pkiEzsigndocumentID, eDocumentType)

Retrieve a URL to download documents.

This endpoint returns URLs to different files that can be downloaded during the signing process. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    String eDocumentType = "Initial"; // String | The type of document to retrieve.  1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied in current document if eEzsignfolderCompletion is PerEzsigndocument.<br>     Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. 
    try {
      EzsigndocumentGetDownloadUrlV1Response result = apiInstance.ezsigndocumentGetDownloadUrlV1(pkiEzsigndocumentID, eDocumentType);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetDownloadUrlV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
eDocumentType	String	The type of document to retrieve. 1. Initial Is the initial document before any signature were applied. 2. SignatureReady Is the version containing the annotations/form to show the signer. 3. Signed Is the final document once all signatures were applied in current document if eEzsignfolderCompletion is PerEzsigndocument.<br> Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 4. Proofdocument Is the evidence report. 5. Proof Is the complete evidence archive including all of the above and more.	[enum: Initial, SignatureReady, Signed, Proof, Proofdocument]

Return type

EzsigndocumentGetDownloadUrlV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentGetEzsignannotationsV1

EzsigndocumentGetEzsignannotationsV1Response ezsigndocumentGetEzsignannotationsV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Ezsignannotations

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetEzsignannotationsV1Response result = apiInstance.ezsigndocumentGetEzsignannotationsV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignannotationsV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetEzsignannotationsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentGetEzsigndiscussionsV1

EzsigndocumentGetEzsigndiscussionsV1Response ezsigndocumentGetEzsigndiscussionsV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Ezsigndiscussions

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetEzsigndiscussionsV1Response result = apiInstance.ezsigndocumentGetEzsigndiscussionsV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsigndiscussionsV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetEzsigndiscussionsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentGetEzsignformfieldgroupsV1

EzsigndocumentGetEzsignformfieldgroupsV1Response ezsigndocumentGetEzsignformfieldgroupsV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Ezsignformfieldgroups

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetEzsignformfieldgroupsV1Response result = apiInstance.ezsigndocumentGetEzsignformfieldgroupsV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignformfieldgroupsV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetEzsignformfieldgroupsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentGetEzsignpagesV1

EzsigndocumentGetEzsignpagesV1Response ezsigndocumentGetEzsignpagesV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Ezsignpages

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetEzsignpagesV1Response result = apiInstance.ezsigndocumentGetEzsignpagesV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignpagesV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetEzsignpagesV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentGetEzsignsignaturesAutomaticV1

EzsigndocumentGetEzsignsignaturesAutomaticV1Response ezsigndocumentGetEzsignsignaturesAutomaticV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's automatic Ezsignsignatures

Return the Ezsignsignatures that can be signed by the current user at the current step in the process

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetEzsignsignaturesAutomaticV1Response result = apiInstance.ezsigndocumentGetEzsignsignaturesAutomaticV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignsignaturesAutomaticV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetEzsignsignaturesAutomaticV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

ezsigndocumentGetEzsignsignaturesV1

EzsigndocumentGetEzsignsignaturesV1Response ezsigndocumentGetEzsignsignaturesV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Ezsignsignatures

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetEzsignsignaturesV1Response result = apiInstance.ezsigndocumentGetEzsignsignaturesV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignsignaturesV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetEzsignsignaturesV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentGetFormDataV1

EzsigndocumentGetFormDataV1Response ezsigndocumentGetFormDataV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Form Data

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetFormDataV1Response result = apiInstance.ezsigndocumentGetFormDataV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetFormDataV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetFormDataV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/zip, text/csv

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentGetObjectV1

EzsigndocumentGetObjectV1Response ezsigndocumentGetObjectV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetObjectV1Response result = apiInstance.ezsigndocumentGetObjectV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetObjectV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

ezsigndocumentGetObjectV2

EzsigndocumentGetObjectV2Response ezsigndocumentGetObjectV2(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetObjectV2Response result = apiInstance.ezsigndocumentGetObjectV2(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetObjectV2");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

ezsigndocumentGetTemporaryProofV1

EzsigndocumentGetTemporaryProofV1Response ezsigndocumentGetTemporaryProofV1(pkiEzsigndocumentID)

Retrieve the temporary proof

Retrieve the temporary proof while the Ezsigndocument is being processed since the proof isn't available until the Ezsigndocument is completed

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    try {
      EzsigndocumentGetTemporaryProofV1Response result = apiInstance.ezsigndocumentGetTemporaryProofV1(pkiEzsigndocumentID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetTemporaryProofV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer

Return type

EzsigndocumentGetTemporaryProofV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentGetWordsPositionsV1

EzsigndocumentGetWordsPositionsV1Response ezsigndocumentGetWordsPositionsV1(pkiEzsigndocumentID, ezsigndocumentGetWordsPositionsV1Request)

Retrieve positions X,Y of given words from a Ezsigndocument

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    EzsigndocumentGetWordsPositionsV1Request ezsigndocumentGetWordsPositionsV1Request = new EzsigndocumentGetWordsPositionsV1Request(); // EzsigndocumentGetWordsPositionsV1Request | 
    try {
      EzsigndocumentGetWordsPositionsV1Response result = apiInstance.ezsigndocumentGetWordsPositionsV1(pkiEzsigndocumentID, ezsigndocumentGetWordsPositionsV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentGetWordsPositionsV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
ezsigndocumentGetWordsPositionsV1Request	EzsigndocumentGetWordsPositionsV1Request

Return type

EzsigndocumentGetWordsPositionsV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentPatchObjectV1

EzsigndocumentPatchObjectV1Response ezsigndocumentPatchObjectV1(pkiEzsigndocumentID, ezsigndocumentPatchObjectV1Request)

Patch an existing Ezsigndocument

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    EzsigndocumentPatchObjectV1Request ezsigndocumentPatchObjectV1Request = new EzsigndocumentPatchObjectV1Request(); // EzsigndocumentPatchObjectV1Request | 
    try {
      EzsigndocumentPatchObjectV1Response result = apiInstance.ezsigndocumentPatchObjectV1(pkiEzsigndocumentID, ezsigndocumentPatchObjectV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentPatchObjectV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
ezsigndocumentPatchObjectV1Request	EzsigndocumentPatchObjectV1Request

Return type

EzsigndocumentPatchObjectV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

ezsigndocumentSubmitEzsignformV1

EzsigndocumentSubmitEzsignformV1Response ezsigndocumentSubmitEzsignformV1(pkiEzsigndocumentID, ezsigndocumentSubmitEzsignformV1Request)

Submit the Ezsignform

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    EzsigndocumentSubmitEzsignformV1Request ezsigndocumentSubmitEzsignformV1Request = new EzsigndocumentSubmitEzsignformV1Request(); // EzsigndocumentSubmitEzsignformV1Request | 
    try {
      EzsigndocumentSubmitEzsignformV1Response result = apiInstance.ezsigndocumentSubmitEzsignformV1(pkiEzsigndocumentID, ezsigndocumentSubmitEzsignformV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentSubmitEzsignformV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
ezsigndocumentSubmitEzsignformV1Request	EzsigndocumentSubmitEzsignformV1Request

Return type

EzsigndocumentSubmitEzsignformV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body.	-

ezsigndocumentUnsendV1

EzsigndocumentUnsendV1Response ezsigndocumentUnsendV1(pkiEzsigndocumentID, body)

Unsend the Ezsigndocument

Once an Ezsigndocument has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsigndocument and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on this Ezsigndocumentswill be lost.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsigndocumentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectEzsigndocumentApi apiInstance = new ObjectEzsigndocumentApi(defaultClient);
    Integer pkiEzsigndocumentID = 56; // Integer | 
    Object body = null; // Object | 
    try {
      EzsigndocumentUnsendV1Response result = apiInstance.ezsigndocumentUnsendV1(pkiEzsigndocumentID, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectEzsigndocumentApi#ezsigndocumentUnsendV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	Integer
body	Object

Return type

EzsigndocumentUnsendV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

Files

ObjectEzsigndocumentApi.md

Latest commit

History

ObjectEzsigndocumentApi.md

File metadata and controls

ObjectEzsigndocumentApi

ezsigndocumentApplyEzsigntemplateV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigndocumentApplyEzsigntemplateV2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigndocumentApplyEzsigntemplateglobalV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigndocumentCreateEzsignelementsPositionedByWordV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigndocumentCreateObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigndocumentCreateObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigndocumentDeclineToSignV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigndocumentDeleteObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigndocumentEditEzsignformfieldgroupsV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigndocumentEditEzsignsignaturesV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsigndocumentEndPrematurelyV1

Example

Parameters