eZmaxAPI\ObjectEzsigndocumentApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path.

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
ezsigndocumentCreateEzsignelementsPositionedByWordV2()	POST /2/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
ezsigndocumentCreateObjectV3()	POST /3/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
ezsigndocumentEditEzsignannotationsV1()	PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignannotations	Edit multiple Ezsignannotations
ezsigndocumentEditEzsignformfieldgroupsV1()	PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups	Edit multiple Ezsignformfieldgroups
ezsigndocumentEditEzsignformfieldgroupsV2()	PUT /2/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups	Edit multiple Ezsignformfieldgroups
ezsigndocumentEditEzsignsignaturesV1()	PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures	Edit multiple Ezsignsignatures
ezsigndocumentEditEzsignsignaturesV2()	PUT /2/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures	Edit multiple Ezsignsignatures
ezsigndocumentEditObjectV1()	PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}	Edit an existing Ezsigndocument
ezsigndocumentEndPrematurelyV1()	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely	End prematurely
ezsigndocumentExtractTextV1()	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/extractText	Extract text from Ezsigndocument area
ezsigndocumentFlattenV1()	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten	Flatten
ezsigndocumentGetActionableElementsV1()	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements	Retrieve actionable elements for the Ezsigndocument
ezsigndocumentGetActionableElementsV2()	GET /2/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements	Retrieve actionable elements for the Ezsigndocument
ezsigndocumentGetActionableElementsV3()	GET /3/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
ezsigndocumentGetCompletedElementsV2()	GET /2/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
ezsigndocumentGetEzsignsignaturesV2()	GET /2/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
ezsigndocumentGetObjectV3()	GET /3/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
ezsigndocumentPrefillEzsignformV1()	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/prefillEzsignform	Prefill an Ezsignform
ezsigndocumentSubmitEzsignformV1()	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform	Submit the Ezsignform
ezsigndocumentUnsendV1()	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend	Unsend the Ezsigndocument

`ezsigndocumentApplyEzsigntemplateV1()`

ezsigndocumentApplyEzsigntemplateV1($pkiEzsigndocumentID, $ezsigndocumentApplyEzsigntemplateV1Request): \eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateV1Response

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentApplyEzsigntemplateV1Request = new \eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateV1Request(); // \eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateV1Request

try {
    $result = $apiInstance->ezsigndocumentApplyEzsigntemplateV1($pkiEzsigndocumentID, $ezsigndocumentApplyEzsigntemplateV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentApplyEzsigntemplateV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentApplyEzsigntemplateV1Request	\eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentApplyEzsigntemplateV2()`

ezsigndocumentApplyEzsigntemplateV2($pkiEzsigndocumentID, $ezsigndocumentApplyEzsigntemplateV2Request): \eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateV2Response

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentApplyEzsigntemplateV2Request = new \eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateV2Request(); // \eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateV2Request

try {
    $result = $apiInstance->ezsigndocumentApplyEzsigntemplateV2($pkiEzsigndocumentID, $ezsigndocumentApplyEzsigntemplateV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentApplyEzsigntemplateV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentApplyEzsigntemplateV2Request	\eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateV2Request

Return type

\eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateV2Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentApplyEzsigntemplateglobalV1()`

ezsigndocumentApplyEzsigntemplateglobalV1($pkiEzsigndocumentID, $ezsigndocumentApplyEzsigntemplateglobalV1Request): \eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateglobalV1Response

Apply an Ezsigntemplateglobal to the Ezsigndocument

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentApplyEzsigntemplateglobalV1Request = new \eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateglobalV1Request(); // \eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateglobalV1Request

try {
    $result = $apiInstance->ezsigndocumentApplyEzsigntemplateglobalV1($pkiEzsigndocumentID, $ezsigndocumentApplyEzsigntemplateglobalV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentApplyEzsigntemplateglobalV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentApplyEzsigntemplateglobalV1Request	\eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateglobalV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentApplyEzsigntemplateglobalV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentCreateEzsignelementsPositionedByWordV1()`

ezsigndocumentCreateEzsignelementsPositionedByWordV1($pkiEzsigndocumentID, $ezsigndocumentCreateEzsignelementsPositionedByWordV1Request): \eZmaxAPI\Model\EzsigndocumentCreateEzsignelementsPositionedByWordV1Response

Create multiple Ezsignsignatures/Ezsignformfieldgroups

Using this endpoint, you can create multiple Ezsignsignatures/Ezsignformfieldgroups positioned by word at the same time. Major step overhaul. Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentCreateEzsignelementsPositionedByWordV1Request = new \eZmaxAPI\Model\EzsigndocumentCreateEzsignelementsPositionedByWordV1Request(); // \eZmaxAPI\Model\EzsigndocumentCreateEzsignelementsPositionedByWordV1Request

try {
    $result = $apiInstance->ezsigndocumentCreateEzsignelementsPositionedByWordV1($pkiEzsigndocumentID, $ezsigndocumentCreateEzsignelementsPositionedByWordV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentCreateEzsignelementsPositionedByWordV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentCreateEzsignelementsPositionedByWordV1Request	\eZmaxAPI\Model\EzsigndocumentCreateEzsignelementsPositionedByWordV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentCreateEzsignelementsPositionedByWordV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentCreateEzsignelementsPositionedByWordV2()`

ezsigndocumentCreateEzsignelementsPositionedByWordV2($pkiEzsigndocumentID, $ezsigndocumentCreateEzsignelementsPositionedByWordV2Request): \eZmaxAPI\Model\EzsigndocumentCreateEzsignelementsPositionedByWordV2Response

Create multiple Ezsignsignatures/Ezsignformfieldgroups

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentCreateEzsignelementsPositionedByWordV2Request = new \eZmaxAPI\Model\EzsigndocumentCreateEzsignelementsPositionedByWordV2Request(); // \eZmaxAPI\Model\EzsigndocumentCreateEzsignelementsPositionedByWordV2Request

try {
    $result = $apiInstance->ezsigndocumentCreateEzsignelementsPositionedByWordV2($pkiEzsigndocumentID, $ezsigndocumentCreateEzsignelementsPositionedByWordV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentCreateEzsignelementsPositionedByWordV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentCreateEzsignelementsPositionedByWordV2Request	\eZmaxAPI\Model\EzsigndocumentCreateEzsignelementsPositionedByWordV2Request

Return type

\eZmaxAPI\Model\EzsigndocumentCreateEzsignelementsPositionedByWordV2Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentCreateObjectV1()`

ezsigndocumentCreateObjectV1($ezsigndocumentCreateObjectV1Request): \eZmaxAPI\Model\EzsigndocumentCreateObjectV1Response

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ezsigndocumentCreateObjectV1Request = array(new \eZmaxAPI\Model\EzsigndocumentCreateObjectV1Request()); // \eZmaxAPI\Model\EzsigndocumentCreateObjectV1Request[]

try {
    $result = $apiInstance->ezsigndocumentCreateObjectV1($ezsigndocumentCreateObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentCreateObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
ezsigndocumentCreateObjectV1Request	\eZmaxAPI\Model\EzsigndocumentCreateObjectV1Request[]

Return type

\eZmaxAPI\Model\EzsigndocumentCreateObjectV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentCreateObjectV2()`

ezsigndocumentCreateObjectV2($ezsigndocumentCreateObjectV2Request): \eZmaxAPI\Model\EzsigndocumentCreateObjectV2Response

Create a new Ezsigndocument

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ezsigndocumentCreateObjectV2Request = new \eZmaxAPI\Model\EzsigndocumentCreateObjectV2Request(); // \eZmaxAPI\Model\EzsigndocumentCreateObjectV2Request

try {
    $result = $apiInstance->ezsigndocumentCreateObjectV2($ezsigndocumentCreateObjectV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentCreateObjectV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
ezsigndocumentCreateObjectV2Request	\eZmaxAPI\Model\EzsigndocumentCreateObjectV2Request

Return type

\eZmaxAPI\Model\EzsigndocumentCreateObjectV2Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentCreateObjectV3()`

ezsigndocumentCreateObjectV3($ezsigndocumentCreateObjectV3Request): \eZmaxAPI\Model\EzsigndocumentCreateObjectV3Response

Create a new Ezsigndocument

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ezsigndocumentCreateObjectV3Request = new \eZmaxAPI\Model\EzsigndocumentCreateObjectV3Request(); // \eZmaxAPI\Model\EzsigndocumentCreateObjectV3Request

try {
    $result = $apiInstance->ezsigndocumentCreateObjectV3($ezsigndocumentCreateObjectV3Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentCreateObjectV3: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
ezsigndocumentCreateObjectV3Request	\eZmaxAPI\Model\EzsigndocumentCreateObjectV3Request

Return type

\eZmaxAPI\Model\EzsigndocumentCreateObjectV3Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentDeclineToSignV1()`

ezsigndocumentDeclineToSignV1($pkiEzsigndocumentID, $ezsigndocumentDeclineToSignV1Request): \eZmaxAPI\Model\EzsigndocumentDeclineToSignV1Response

Decline to sign

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentDeclineToSignV1Request = new \eZmaxAPI\Model\EzsigndocumentDeclineToSignV1Request(); // \eZmaxAPI\Model\EzsigndocumentDeclineToSignV1Request

try {
    $result = $apiInstance->ezsigndocumentDeclineToSignV1($pkiEzsigndocumentID, $ezsigndocumentDeclineToSignV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentDeclineToSignV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentDeclineToSignV1Request	\eZmaxAPI\Model\EzsigndocumentDeclineToSignV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentDeclineToSignV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentDeleteObjectV1()`

ezsigndocumentDeleteObjectV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentDeleteObjectV1Response

Delete an existing Ezsigndocument

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentDeleteObjectV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentDeleteObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentDeleteObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentEditEzsignannotationsV1()`

ezsigndocumentEditEzsignannotationsV1($pkiEzsigndocumentID, $ezsigndocumentEditEzsignannotationsV1Request): \eZmaxAPI\Model\EzsigndocumentEditEzsignannotationsV1Response

Edit multiple Ezsignannotations

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentEditEzsignannotationsV1Request = new \eZmaxAPI\Model\EzsigndocumentEditEzsignannotationsV1Request(); // \eZmaxAPI\Model\EzsigndocumentEditEzsignannotationsV1Request

try {
    $result = $apiInstance->ezsigndocumentEditEzsignannotationsV1($pkiEzsigndocumentID, $ezsigndocumentEditEzsignannotationsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentEditEzsignannotationsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentEditEzsignannotationsV1Request	\eZmaxAPI\Model\EzsigndocumentEditEzsignannotationsV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentEditEzsignannotationsV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentEditEzsignformfieldgroupsV1()`

ezsigndocumentEditEzsignformfieldgroupsV1($pkiEzsigndocumentID, $ezsigndocumentEditEzsignformfieldgroupsV1Request): \eZmaxAPI\Model\EzsigndocumentEditEzsignformfieldgroupsV1Response

Edit multiple Ezsignformfieldgroups

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentEditEzsignformfieldgroupsV1Request = new \eZmaxAPI\Model\EzsigndocumentEditEzsignformfieldgroupsV1Request(); // \eZmaxAPI\Model\EzsigndocumentEditEzsignformfieldgroupsV1Request

try {
    $result = $apiInstance->ezsigndocumentEditEzsignformfieldgroupsV1($pkiEzsigndocumentID, $ezsigndocumentEditEzsignformfieldgroupsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentEditEzsignformfieldgroupsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentEditEzsignformfieldgroupsV1Request	\eZmaxAPI\Model\EzsigndocumentEditEzsignformfieldgroupsV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentEditEzsignformfieldgroupsV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentEditEzsignformfieldgroupsV2()`

ezsigndocumentEditEzsignformfieldgroupsV2($pkiEzsigndocumentID, $ezsigndocumentEditEzsignformfieldgroupsV2Request): \eZmaxAPI\Model\EzsigndocumentEditEzsignformfieldgroupsV2Response

Edit multiple Ezsignformfieldgroups

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentEditEzsignformfieldgroupsV2Request = new \eZmaxAPI\Model\EzsigndocumentEditEzsignformfieldgroupsV2Request(); // \eZmaxAPI\Model\EzsigndocumentEditEzsignformfieldgroupsV2Request

try {
    $result = $apiInstance->ezsigndocumentEditEzsignformfieldgroupsV2($pkiEzsigndocumentID, $ezsigndocumentEditEzsignformfieldgroupsV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentEditEzsignformfieldgroupsV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentEditEzsignformfieldgroupsV2Request	\eZmaxAPI\Model\EzsigndocumentEditEzsignformfieldgroupsV2Request

Return type

\eZmaxAPI\Model\EzsigndocumentEditEzsignformfieldgroupsV2Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentEditEzsignsignaturesV1()`

ezsigndocumentEditEzsignsignaturesV1($pkiEzsigndocumentID, $ezsigndocumentEditEzsignsignaturesV1Request): \eZmaxAPI\Model\EzsigndocumentEditEzsignsignaturesV1Response

Edit multiple Ezsignsignatures

Using this endpoint, you can edit multiple Ezsignsignatures at the same time. Major step overhaul. Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentEditEzsignsignaturesV1Request = new \eZmaxAPI\Model\EzsigndocumentEditEzsignsignaturesV1Request(); // \eZmaxAPI\Model\EzsigndocumentEditEzsignsignaturesV1Request

try {
    $result = $apiInstance->ezsigndocumentEditEzsignsignaturesV1($pkiEzsigndocumentID, $ezsigndocumentEditEzsignsignaturesV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentEditEzsignsignaturesV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentEditEzsignsignaturesV1Request	\eZmaxAPI\Model\EzsigndocumentEditEzsignsignaturesV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentEditEzsignsignaturesV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentEditEzsignsignaturesV2()`

ezsigndocumentEditEzsignsignaturesV2($pkiEzsigndocumentID, $ezsigndocumentEditEzsignsignaturesV2Request): \eZmaxAPI\Model\EzsigndocumentEditEzsignsignaturesV2Response

Edit multiple Ezsignsignatures

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentEditEzsignsignaturesV2Request = new \eZmaxAPI\Model\EzsigndocumentEditEzsignsignaturesV2Request(); // \eZmaxAPI\Model\EzsigndocumentEditEzsignsignaturesV2Request

try {
    $result = $apiInstance->ezsigndocumentEditEzsignsignaturesV2($pkiEzsigndocumentID, $ezsigndocumentEditEzsignsignaturesV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentEditEzsignsignaturesV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentEditEzsignsignaturesV2Request	\eZmaxAPI\Model\EzsigndocumentEditEzsignsignaturesV2Request

Return type

\eZmaxAPI\Model\EzsigndocumentEditEzsignsignaturesV2Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentEditObjectV1()`

ezsigndocumentEditObjectV1($pkiEzsigndocumentID, $ezsigndocumentEditObjectV1Request): \eZmaxAPI\Model\EzsigndocumentEditObjectV1Response

Edit an existing Ezsigndocument

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentEditObjectV1Request = new \eZmaxAPI\Model\EzsigndocumentEditObjectV1Request(); // \eZmaxAPI\Model\EzsigndocumentEditObjectV1Request

try {
    $result = $apiInstance->ezsigndocumentEditObjectV1($pkiEzsigndocumentID, $ezsigndocumentEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentEditObjectV1Request	\eZmaxAPI\Model\EzsigndocumentEditObjectV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentEditObjectV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentEndPrematurelyV1()`

ezsigndocumentEndPrematurelyV1($pkiEzsigndocumentID, $body): \eZmaxAPI\Model\EzsigndocumentEndPrematurelyV1Response

End prematurely

End prematurely an Ezsigndocument when some signatures are still required

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$body = array('key' => new \stdClass); // object

try {
    $result = $apiInstance->ezsigndocumentEndPrematurelyV1($pkiEzsigndocumentID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentEndPrematurelyV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
body	object

Return type

\eZmaxAPI\Model\EzsigndocumentEndPrematurelyV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentExtractTextV1()`

ezsigndocumentExtractTextV1($pkiEzsigndocumentID, $ezsigndocumentExtractTextV1Request): \eZmaxAPI\Model\EzsigndocumentExtractTextV1Response

Extract text from Ezsigndocument area

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentExtractTextV1Request = new \eZmaxAPI\Model\EzsigndocumentExtractTextV1Request(); // \eZmaxAPI\Model\EzsigndocumentExtractTextV1Request

try {
    $result = $apiInstance->ezsigndocumentExtractTextV1($pkiEzsigndocumentID, $ezsigndocumentExtractTextV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentExtractTextV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentExtractTextV1Request	\eZmaxAPI\Model\EzsigndocumentExtractTextV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentExtractTextV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentFlattenV1()`

ezsigndocumentFlattenV1($pkiEzsigndocumentID, $body): \eZmaxAPI\Model\EzsigndocumentFlattenV1Response

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$body = array('key' => new \stdClass); // object

try {
    $result = $apiInstance->ezsigndocumentFlattenV1($pkiEzsigndocumentID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentFlattenV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
body	object

Return type

\eZmaxAPI\Model\EzsigndocumentFlattenV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetActionableElementsV1()`

ezsigndocumentGetActionableElementsV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetActionableElementsV1Response

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. Major step overhaul. Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetActionableElementsV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetActionableElementsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetActionableElementsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetActionableElementsV2()`

ezsigndocumentGetActionableElementsV2($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetActionableElementsV2Response

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetActionableElementsV2($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetActionableElementsV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetActionableElementsV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetActionableElementsV3()`

ezsigndocumentGetActionableElementsV3($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetActionableElementsV3Response

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetActionableElementsV3($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetActionableElementsV3: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetActionableElementsV3Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetAttachmentsV1()`

ezsigndocumentGetAttachmentsV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetAttachmentsV1Response

Retrieve Ezsigndocument's Attachments

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetAttachmentsV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetAttachmentsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetAttachmentsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetCompletedElementsV1()`

ezsigndocumentGetCompletedElementsV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetCompletedElementsV1Response

Retrieve completed elements for the Ezsigndocument

Return the completed Ezsignsignatures, Ezsignformfieldgroups and Ezsignannotations at the current step in the process Major step overhaul. Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetCompletedElementsV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetCompletedElementsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetCompletedElementsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetCompletedElementsV2()`

ezsigndocumentGetCompletedElementsV2($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetCompletedElementsV2Response

Retrieve completed elements for the Ezsigndocument

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetCompletedElementsV2($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetCompletedElementsV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetCompletedElementsV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetDownloadUrlV1()`

ezsigndocumentGetDownloadUrlV1($pkiEzsigndocumentID, $eDocumentType): \eZmaxAPI\Model\EzsigndocumentGetDownloadUrlV1Response

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$eDocumentType = 'eDocumentType_example'; // string | The type of document to retrieve.  1. **original** Is the original document before any repair or conversion were applied. **Initial** Is the initial document after initial 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 {
    $result = $apiInstance->ezsigndocumentGetDownloadUrlV1($pkiEzsigndocumentID, $eDocumentType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetDownloadUrlV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
eDocumentType	string	The type of document to retrieve. 1. original Is the original document before any repair or conversion were applied. Initial Is the initial document after initial 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.

Return type

\eZmaxAPI\Model\EzsigndocumentGetDownloadUrlV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetEzsignannotationsV1()`

ezsigndocumentGetEzsignannotationsV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetEzsignannotationsV1Response

Retrieve an existing Ezsigndocument's Ezsignannotations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetEzsignannotationsV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsignannotationsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetEzsignannotationsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetEzsigndiscussionsV1()`

ezsigndocumentGetEzsigndiscussionsV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetEzsigndiscussionsV1Response

Retrieve an existing Ezsigndocument's Ezsigndiscussions

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetEzsigndiscussionsV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsigndiscussionsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetEzsigndiscussionsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetEzsignformfieldgroupsV1()`

ezsigndocumentGetEzsignformfieldgroupsV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetEzsignformfieldgroupsV1Response

Retrieve an existing Ezsigndocument's Ezsignformfieldgroups

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetEzsignformfieldgroupsV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsignformfieldgroupsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetEzsignformfieldgroupsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetEzsignpagesV1()`

ezsigndocumentGetEzsignpagesV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetEzsignpagesV1Response

Retrieve an existing Ezsigndocument's Ezsignpages

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetEzsignpagesV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsignpagesV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetEzsignpagesV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetEzsignsignaturesAutomaticV1()`

ezsigndocumentGetEzsignsignaturesAutomaticV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetEzsignsignaturesAutomaticV1Response

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetEzsignsignaturesAutomaticV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsignsignaturesAutomaticV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetEzsignsignaturesAutomaticV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetEzsignsignaturesV1()`

ezsigndocumentGetEzsignsignaturesV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetEzsignsignaturesV1Response

Retrieve an existing Ezsigndocument's Ezsignsignatures

Major step overhaul. Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetEzsignsignaturesV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsignsignaturesV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetEzsignsignaturesV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetEzsignsignaturesV2()`

ezsigndocumentGetEzsignsignaturesV2($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetEzsignsignaturesV2Response

Retrieve an existing Ezsigndocument's Ezsignsignatures

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetEzsignsignaturesV2($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsignsignaturesV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetEzsignsignaturesV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetFormDataV1()`

ezsigndocumentGetFormDataV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetFormDataV1Response

Retrieve an existing Ezsigndocument's Form Data

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetFormDataV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetFormDataV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetFormDataV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetObjectV1()`

ezsigndocumentGetObjectV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetObjectV1Response

Retrieve an existing Ezsigndocument

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetObjectV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetObjectV2()`

ezsigndocumentGetObjectV2($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetObjectV2Response

Retrieve an existing Ezsigndocument

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetObjectV2($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetObjectV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetObjectV3()`

ezsigndocumentGetObjectV3($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetObjectV3Response

Retrieve an existing Ezsigndocument

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetObjectV3($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetObjectV3: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetObjectV3Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetTemporaryProofV1()`

ezsigndocumentGetTemporaryProofV1($pkiEzsigndocumentID): \eZmaxAPI\Model\EzsigndocumentGetTemporaryProofV1Response

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int

try {
    $result = $apiInstance->ezsigndocumentGetTemporaryProofV1($pkiEzsigndocumentID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetTemporaryProofV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int

Return type

\eZmaxAPI\Model\EzsigndocumentGetTemporaryProofV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentGetWordsPositionsV1()`

ezsigndocumentGetWordsPositionsV1($pkiEzsigndocumentID, $ezsigndocumentGetWordsPositionsV1Request): \eZmaxAPI\Model\EzsigndocumentGetWordsPositionsV1Response

Retrieve positions X,Y of given words from a Ezsigndocument

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentGetWordsPositionsV1Request = new \eZmaxAPI\Model\EzsigndocumentGetWordsPositionsV1Request(); // \eZmaxAPI\Model\EzsigndocumentGetWordsPositionsV1Request

try {
    $result = $apiInstance->ezsigndocumentGetWordsPositionsV1($pkiEzsigndocumentID, $ezsigndocumentGetWordsPositionsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentGetWordsPositionsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentGetWordsPositionsV1Request	\eZmaxAPI\Model\EzsigndocumentGetWordsPositionsV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentGetWordsPositionsV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentPatchObjectV1()`

ezsigndocumentPatchObjectV1($pkiEzsigndocumentID, $ezsigndocumentPatchObjectV1Request): \eZmaxAPI\Model\EzsigndocumentPatchObjectV1Response

Patch an existing Ezsigndocument

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentPatchObjectV1Request = new \eZmaxAPI\Model\EzsigndocumentPatchObjectV1Request(); // \eZmaxAPI\Model\EzsigndocumentPatchObjectV1Request

try {
    $result = $apiInstance->ezsigndocumentPatchObjectV1($pkiEzsigndocumentID, $ezsigndocumentPatchObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentPatchObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentPatchObjectV1Request	\eZmaxAPI\Model\EzsigndocumentPatchObjectV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentPatchObjectV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentPrefillEzsignformV1()`

ezsigndocumentPrefillEzsignformV1($pkiEzsigndocumentID, $ezsigndocumentPrefillEzsignformV1Request): \eZmaxAPI\Model\EzsigndocumentPrefillEzsignformV1Response

Prefill an Ezsignform

Using this endpoint, you can prefill an Ezsignform. To fill Ezsignformfield with type Dropdown, Text, Textarea, Checkbox, Date, Number, you must provide properties sEzsignformfieldgroupLabel and sEzsignformfieldLabel. To fill Ezsignformfield with type Radio, you must provide only the property sEzsignformfieldgroupLabel. In PowerAutomate if you need to add a line feed in sEzsignformfieldEnteredvalue, you should do it like this: concat('string1',decodeUriComponent('%0A'),'string2',decodeUriComponent('%0A'),'string3')

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentPrefillEzsignformV1Request = new \eZmaxAPI\Model\EzsigndocumentPrefillEzsignformV1Request(); // \eZmaxAPI\Model\EzsigndocumentPrefillEzsignformV1Request

try {
    $result = $apiInstance->ezsigndocumentPrefillEzsignformV1($pkiEzsigndocumentID, $ezsigndocumentPrefillEzsignformV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentPrefillEzsignformV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentPrefillEzsignformV1Request	\eZmaxAPI\Model\EzsigndocumentPrefillEzsignformV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentPrefillEzsignformV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentSubmitEzsignformV1()`

ezsigndocumentSubmitEzsignformV1($pkiEzsigndocumentID, $ezsigndocumentSubmitEzsignformV1Request): \eZmaxAPI\Model\EzsigndocumentSubmitEzsignformV1Response

Submit the Ezsignform

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$ezsigndocumentSubmitEzsignformV1Request = new \eZmaxAPI\Model\EzsigndocumentSubmitEzsignformV1Request(); // \eZmaxAPI\Model\EzsigndocumentSubmitEzsignformV1Request

try {
    $result = $apiInstance->ezsigndocumentSubmitEzsignformV1($pkiEzsigndocumentID, $ezsigndocumentSubmitEzsignformV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentSubmitEzsignformV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
ezsigndocumentSubmitEzsignformV1Request	\eZmaxAPI\Model\EzsigndocumentSubmitEzsignformV1Request

Return type

\eZmaxAPI\Model\EzsigndocumentSubmitEzsignformV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`ezsigndocumentUnsendV1()`

ezsigndocumentUnsendV1($pkiEzsigndocumentID, $body): \eZmaxAPI\Model\EzsigndocumentUnsendV1Response

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectEzsigndocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiEzsigndocumentID = 56; // int
$body = array('key' => new \stdClass); // object

try {
    $result = $apiInstance->ezsigndocumentUnsendV1($pkiEzsigndocumentID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigndocumentApi->ezsigndocumentUnsendV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	int
body	object

Return type

\eZmaxAPI\Model\EzsigndocumentUnsendV1Response

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

ObjectEzsigndocumentApi.md

Latest commit

History

ObjectEzsigndocumentApi.md

File metadata and controls

eZmaxAPI\ObjectEzsigndocumentApi

ezsigndocumentApplyEzsigntemplateV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentApplyEzsigntemplateV2()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentApplyEzsigntemplateglobalV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentCreateEzsignelementsPositionedByWordV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentCreateEzsignelementsPositionedByWordV2()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentCreateObjectV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentCreateObjectV2()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentCreateObjectV3()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentDeclineToSignV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentDeleteObjectV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentEditEzsignannotationsV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentEditEzsignformfieldgroupsV1()

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentEditEzsignformfieldgroupsV2()

`ezsigndocumentApplyEzsigntemplateV1()`

`ezsigndocumentApplyEzsigntemplateV2()`

`ezsigndocumentApplyEzsigntemplateglobalV1()`

`ezsigndocumentCreateEzsignelementsPositionedByWordV1()`

`ezsigndocumentCreateEzsignelementsPositionedByWordV2()`

`ezsigndocumentCreateObjectV1()`

`ezsigndocumentCreateObjectV2()`

`ezsigndocumentCreateObjectV3()`

`ezsigndocumentDeclineToSignV1()`

`ezsigndocumentDeleteObjectV1()`

`ezsigndocumentEditEzsignannotationsV1()`

`ezsigndocumentEditEzsignformfieldgroupsV1()`

`ezsigndocumentEditEzsignformfieldgroupsV2()`

`ezsigndocumentEditEzsignsignaturesV1()`

`ezsigndocumentEditEzsignsignaturesV2()`

`ezsigndocumentEditObjectV1()`

`ezsigndocumentEndPrematurelyV1()`

`ezsigndocumentExtractTextV1()`

`ezsigndocumentFlattenV1()`

`ezsigndocumentGetActionableElementsV1()`

`ezsigndocumentGetActionableElementsV2()`

`ezsigndocumentGetActionableElementsV3()`

`ezsigndocumentGetAttachmentsV1()`