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
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
ezsigndocumentEditEzsignsignaturesV1	PUT /1/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
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
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

-(NSURLSessionTask*) ezsigndocumentApplyEzsigntemplateV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentApplyEzsigntemplateV1Request: (EzsigndocumentApplyEzsigntemplateV1Request*) ezsigndocumentApplyEzsigntemplateV1Request
        completionHandler: (void (^)(EzsigndocumentApplyEzsigntemplateV1Response* output, NSError* error)) handler;

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

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentApplyEzsigntemplateV1Request* ezsigndocumentApplyEzsigntemplateV1Request = [[EzsigndocumentApplyEzsigntemplateV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Apply an Ezsigntemplate to the Ezsigndocument.
[apiInstance ezsigndocumentApplyEzsigntemplateV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentApplyEzsigntemplateV1Request:ezsigndocumentApplyEzsigntemplateV1Request
          completionHandler: ^(EzsigndocumentApplyEzsigntemplateV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentApplyEzsigntemplateV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentApplyEzsigntemplateV1Request	EzsigndocumentApplyEzsigntemplateV1Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentApplyEzsigntemplateV2WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentApplyEzsigntemplateV2Request: (EzsigndocumentApplyEzsigntemplateV2Request*) ezsigndocumentApplyEzsigntemplateV2Request
        completionHandler: (void (^)(EzsigndocumentApplyEzsigntemplateV2Response* output, NSError* error)) handler;

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

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentApplyEzsigntemplateV2Request* ezsigndocumentApplyEzsigntemplateV2Request = [[EzsigndocumentApplyEzsigntemplateV2Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Apply an Ezsigntemplate to the Ezsigndocument.
[apiInstance ezsigndocumentApplyEzsigntemplateV2WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentApplyEzsigntemplateV2Request:ezsigndocumentApplyEzsigntemplateV2Request
          completionHandler: ^(EzsigndocumentApplyEzsigntemplateV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentApplyEzsigntemplateV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentApplyEzsigntemplateV2Request	EzsigndocumentApplyEzsigntemplateV2Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentApplyEzsigntemplateglobalV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentApplyEzsigntemplateglobalV1Request: (EzsigndocumentApplyEzsigntemplateglobalV1Request*) ezsigndocumentApplyEzsigntemplateglobalV1Request
        completionHandler: (void (^)(EzsigndocumentApplyEzsigntemplateglobalV1Response* output, NSError* error)) handler;

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

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentApplyEzsigntemplateglobalV1Request* ezsigndocumentApplyEzsigntemplateglobalV1Request = [[EzsigndocumentApplyEzsigntemplateglobalV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Apply an Ezsigntemplateglobal to the Ezsigndocument.
[apiInstance ezsigndocumentApplyEzsigntemplateglobalV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentApplyEzsigntemplateglobalV1Request:ezsigndocumentApplyEzsigntemplateglobalV1Request
          completionHandler: ^(EzsigndocumentApplyEzsigntemplateglobalV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentApplyEzsigntemplateglobalV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentApplyEzsigntemplateglobalV1Request	EzsigndocumentApplyEzsigntemplateglobalV1Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentCreateEzsignelementsPositionedByWordV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentCreateEzsignelementsPositionedByWordV1Request: (EzsigndocumentCreateEzsignelementsPositionedByWordV1Request*) ezsigndocumentCreateEzsignelementsPositionedByWordV1Request
        completionHandler: (void (^)(EzsigndocumentCreateEzsignelementsPositionedByWordV1Response* output, NSError* error)) handler;

Create multiple Ezsignsignatures/Ezsignformfieldgroups

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentCreateEzsignelementsPositionedByWordV1Request* ezsigndocumentCreateEzsignelementsPositionedByWordV1Request = [[EzsigndocumentCreateEzsignelementsPositionedByWordV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Create multiple Ezsignsignatures/Ezsignformfieldgroups
[apiInstance ezsigndocumentCreateEzsignelementsPositionedByWordV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentCreateEzsignelementsPositionedByWordV1Request:ezsigndocumentCreateEzsignelementsPositionedByWordV1Request
          completionHandler: ^(EzsigndocumentCreateEzsignelementsPositionedByWordV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentCreateEzsignelementsPositionedByWordV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentCreateEzsignelementsPositionedByWordV1Request	EzsigndocumentCreateEzsignelementsPositionedByWordV1Request*

Return type

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]

ezsigndocumentCreateObjectV1

-(NSURLSessionTask*) ezsigndocumentCreateObjectV1WithEzsigndocumentCreateObjectV1Request: (NSArray<EzsigndocumentCreateObjectV1Request>*) ezsigndocumentCreateObjectV1Request
        completionHandler: (void (^)(EzsigndocumentCreateObjectV1Response* output, NSError* error)) handler;

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

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSArray<EzsigndocumentCreateObjectV1Request>* ezsigndocumentCreateObjectV1Request = @[[[EzsigndocumentCreateObjectV1Request alloc] init]]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Create a new Ezsigndocument
[apiInstance ezsigndocumentCreateObjectV1WithEzsigndocumentCreateObjectV1Request:ezsigndocumentCreateObjectV1Request
          completionHandler: ^(EzsigndocumentCreateObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentCreateObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
ezsigndocumentCreateObjectV1Request	NSArray<EzsigndocumentCreateObjectV1Request>*

Return type

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

-(NSURLSessionTask*) ezsigndocumentCreateObjectV2WithEzsigndocumentCreateObjectV2Request: (EzsigndocumentCreateObjectV2Request*) ezsigndocumentCreateObjectV2Request
        completionHandler: (void (^)(EzsigndocumentCreateObjectV2Response* output, NSError* error)) handler;

Create a new Ezsigndocument

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


EzsigndocumentCreateObjectV2Request* ezsigndocumentCreateObjectV2Request = [[EzsigndocumentCreateObjectV2Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Create a new Ezsigndocument
[apiInstance ezsigndocumentCreateObjectV2WithEzsigndocumentCreateObjectV2Request:ezsigndocumentCreateObjectV2Request
          completionHandler: ^(EzsigndocumentCreateObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentCreateObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
ezsigndocumentCreateObjectV2Request	EzsigndocumentCreateObjectV2Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentCreateObjectV3WithEzsigndocumentCreateObjectV3Request: (EzsigndocumentCreateObjectV3Request*) ezsigndocumentCreateObjectV3Request
        completionHandler: (void (^)(EzsigndocumentCreateObjectV3Response* output, NSError* error)) handler;

Create a new Ezsigndocument

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


EzsigndocumentCreateObjectV3Request* ezsigndocumentCreateObjectV3Request = [[EzsigndocumentCreateObjectV3Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Create a new Ezsigndocument
[apiInstance ezsigndocumentCreateObjectV3WithEzsigndocumentCreateObjectV3Request:ezsigndocumentCreateObjectV3Request
          completionHandler: ^(EzsigndocumentCreateObjectV3Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentCreateObjectV3: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
ezsigndocumentCreateObjectV3Request	EzsigndocumentCreateObjectV3Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentDeclineToSignV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentDeclineToSignV1Request: (EzsigndocumentDeclineToSignV1Request*) ezsigndocumentDeclineToSignV1Request
        completionHandler: (void (^)(EzsigndocumentDeclineToSignV1Response* output, NSError* error)) handler;

Decline to sign

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentDeclineToSignV1Request* ezsigndocumentDeclineToSignV1Request = [[EzsigndocumentDeclineToSignV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Decline to sign
[apiInstance ezsigndocumentDeclineToSignV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentDeclineToSignV1Request:ezsigndocumentDeclineToSignV1Request
          completionHandler: ^(EzsigndocumentDeclineToSignV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentDeclineToSignV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentDeclineToSignV1Request	EzsigndocumentDeclineToSignV1Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentDeleteObjectV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentDeleteObjectV1Response* output, NSError* error)) handler;

Delete an existing Ezsigndocument

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Delete an existing Ezsigndocument
[apiInstance ezsigndocumentDeleteObjectV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentDeleteObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentDeleteObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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

-(NSURLSessionTask*) ezsigndocumentEditEzsignannotationsV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentEditEzsignannotationsV1Request: (EzsigndocumentEditEzsignannotationsV1Request*) ezsigndocumentEditEzsignannotationsV1Request
        completionHandler: (void (^)(EzsigndocumentEditEzsignannotationsV1Response* output, NSError* error)) handler;

Edit multiple Ezsignannotations

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentEditEzsignannotationsV1Request* ezsigndocumentEditEzsignannotationsV1Request = [[EzsigndocumentEditEzsignannotationsV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Edit multiple Ezsignannotations
[apiInstance ezsigndocumentEditEzsignannotationsV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentEditEzsignannotationsV1Request:ezsigndocumentEditEzsignannotationsV1Request
          completionHandler: ^(EzsigndocumentEditEzsignannotationsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentEditEzsignannotationsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentEditEzsignannotationsV1Request	EzsigndocumentEditEzsignannotationsV1Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentEditEzsignformfieldgroupsV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentEditEzsignformfieldgroupsV1Request: (EzsigndocumentEditEzsignformfieldgroupsV1Request*) ezsigndocumentEditEzsignformfieldgroupsV1Request
        completionHandler: (void (^)(EzsigndocumentEditEzsignformfieldgroupsV1Response* output, NSError* error)) handler;

Edit multiple Ezsignformfieldgroups

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentEditEzsignformfieldgroupsV1Request* ezsigndocumentEditEzsignformfieldgroupsV1Request = [[EzsigndocumentEditEzsignformfieldgroupsV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Edit multiple Ezsignformfieldgroups
[apiInstance ezsigndocumentEditEzsignformfieldgroupsV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentEditEzsignformfieldgroupsV1Request:ezsigndocumentEditEzsignformfieldgroupsV1Request
          completionHandler: ^(EzsigndocumentEditEzsignformfieldgroupsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentEditEzsignformfieldgroupsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentEditEzsignformfieldgroupsV1Request	EzsigndocumentEditEzsignformfieldgroupsV1Request*

Return type

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]

ezsigndocumentEditEzsignsignaturesV1

-(NSURLSessionTask*) ezsigndocumentEditEzsignsignaturesV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentEditEzsignsignaturesV1Request: (EzsigndocumentEditEzsignsignaturesV1Request*) ezsigndocumentEditEzsignsignaturesV1Request
        completionHandler: (void (^)(EzsigndocumentEditEzsignsignaturesV1Response* output, NSError* error)) handler;

Edit multiple Ezsignsignatures

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentEditEzsignsignaturesV1Request* ezsigndocumentEditEzsignsignaturesV1Request = [[EzsigndocumentEditEzsignsignaturesV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Edit multiple Ezsignsignatures
[apiInstance ezsigndocumentEditEzsignsignaturesV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentEditEzsignsignaturesV1Request:ezsigndocumentEditEzsignsignaturesV1Request
          completionHandler: ^(EzsigndocumentEditEzsignsignaturesV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentEditEzsignsignaturesV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentEditEzsignsignaturesV1Request	EzsigndocumentEditEzsignsignaturesV1Request*

Return type

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]

ezsigndocumentEditObjectV1

-(NSURLSessionTask*) ezsigndocumentEditObjectV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentEditObjectV1Request: (EzsigndocumentEditObjectV1Request*) ezsigndocumentEditObjectV1Request
        completionHandler: (void (^)(EzsigndocumentEditObjectV1Response* output, NSError* error)) handler;

Edit an existing Ezsigndocument

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentEditObjectV1Request* ezsigndocumentEditObjectV1Request = [[EzsigndocumentEditObjectV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Edit an existing Ezsigndocument
[apiInstance ezsigndocumentEditObjectV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentEditObjectV1Request:ezsigndocumentEditObjectV1Request
          completionHandler: ^(EzsigndocumentEditObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentEditObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentEditObjectV1Request	EzsigndocumentEditObjectV1Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentEndPrematurelyV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    body: (NSObject*) body
        completionHandler: (void (^)(EzsigndocumentEndPrematurelyV1Response* output, NSError* error)) handler;

End prematurely

End prematurely an Ezsigndocument when some signatures are still required

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
NSObject* body = NULL; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// End prematurely
[apiInstance ezsigndocumentEndPrematurelyV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              body:body
          completionHandler: ^(EzsigndocumentEndPrematurelyV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentEndPrematurelyV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
body	NSObject*

Return type

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

-(NSURLSessionTask*) ezsigndocumentExtractTextV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentExtractTextV1Request: (EzsigndocumentExtractTextV1Request*) ezsigndocumentExtractTextV1Request
        completionHandler: (void (^)(EzsigndocumentExtractTextV1Response* output, NSError* error)) handler;

Extract text from Ezsigndocument area

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentExtractTextV1Request* ezsigndocumentExtractTextV1Request = [[EzsigndocumentExtractTextV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Extract text from Ezsigndocument area
[apiInstance ezsigndocumentExtractTextV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentExtractTextV1Request:ezsigndocumentExtractTextV1Request
          completionHandler: ^(EzsigndocumentExtractTextV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentExtractTextV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentExtractTextV1Request	EzsigndocumentExtractTextV1Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentFlattenV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    body: (NSObject*) body
        completionHandler: (void (^)(EzsigndocumentFlattenV1Response* output, NSError* error)) handler;

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

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
NSObject* body = NULL; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Flatten
[apiInstance ezsigndocumentFlattenV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              body:body
          completionHandler: ^(EzsigndocumentFlattenV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentFlattenV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
body	NSObject*

Return type

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

-(NSURLSessionTask*) ezsigndocumentGetActionableElementsV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetActionableElementsV1Response* output, NSError* error)) handler;

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

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve actionable elements for the Ezsigndocument
[apiInstance ezsigndocumentGetActionableElementsV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetActionableElementsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetActionableElementsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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]

ezsigndocumentGetAttachmentsV1

-(NSURLSessionTask*) ezsigndocumentGetAttachmentsV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetAttachmentsV1Response* output, NSError* error)) handler;

Retrieve Ezsigndocument's Attachments

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve Ezsigndocument's Attachments
[apiInstance ezsigndocumentGetAttachmentsV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetAttachmentsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetAttachmentsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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

-(NSURLSessionTask*) ezsigndocumentGetCompletedElementsV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetCompletedElementsV1Response* output, NSError* error)) handler;

Retrieve completed elements for the Ezsigndocument

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve completed elements for the Ezsigndocument
[apiInstance ezsigndocumentGetCompletedElementsV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetCompletedElementsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetCompletedElementsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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]

ezsigndocumentGetDownloadUrlV1

-(NSURLSessionTask*) ezsigndocumentGetDownloadUrlV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    eDocumentType: (NSString*) eDocumentType
        completionHandler: (void (^)(EzsigndocumentGetDownloadUrlV1Response* output, NSError* error)) handler;

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

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
NSString* eDocumentType = @"eDocumentType_example"; // 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. 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve a URL to download documents.
[apiInstance ezsigndocumentGetDownloadUrlV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              eDocumentType:eDocumentType
          completionHandler: ^(EzsigndocumentGetDownloadUrlV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetDownloadUrlV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
eDocumentType	NSString*	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.

Return type

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

-(NSURLSessionTask*) ezsigndocumentGetEzsignannotationsV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetEzsignannotationsV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsigndocument's Ezsignannotations

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve an existing Ezsigndocument's Ezsignannotations
[apiInstance ezsigndocumentGetEzsignannotationsV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetEzsignannotationsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsignannotationsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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

-(NSURLSessionTask*) ezsigndocumentGetEzsigndiscussionsV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetEzsigndiscussionsV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsigndocument's Ezsigndiscussions

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve an existing Ezsigndocument's Ezsigndiscussions
[apiInstance ezsigndocumentGetEzsigndiscussionsV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetEzsigndiscussionsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsigndiscussionsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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

-(NSURLSessionTask*) ezsigndocumentGetEzsignformfieldgroupsV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetEzsignformfieldgroupsV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsigndocument's Ezsignformfieldgroups

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve an existing Ezsigndocument's Ezsignformfieldgroups
[apiInstance ezsigndocumentGetEzsignformfieldgroupsV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetEzsignformfieldgroupsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsignformfieldgroupsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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

-(NSURLSessionTask*) ezsigndocumentGetEzsignpagesV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetEzsignpagesV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsigndocument's Ezsignpages

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve an existing Ezsigndocument's Ezsignpages
[apiInstance ezsigndocumentGetEzsignpagesV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetEzsignpagesV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsignpagesV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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

-(NSURLSessionTask*) ezsigndocumentGetEzsignsignaturesAutomaticV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetEzsignsignaturesAutomaticV1Response* output, NSError* error)) handler;

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

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve an existing Ezsigndocument's automatic Ezsignsignatures
[apiInstance ezsigndocumentGetEzsignsignaturesAutomaticV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetEzsignsignaturesAutomaticV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsignsignaturesAutomaticV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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

-(NSURLSessionTask*) ezsigndocumentGetEzsignsignaturesV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetEzsignsignaturesV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsigndocument's Ezsignsignatures

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve an existing Ezsigndocument's Ezsignsignatures
[apiInstance ezsigndocumentGetEzsignsignaturesV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetEzsignsignaturesV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetEzsignsignaturesV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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]

ezsigndocumentGetFormDataV1

-(NSURLSessionTask*) ezsigndocumentGetFormDataV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetFormDataV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsigndocument's Form Data

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve an existing Ezsigndocument's Form Data
[apiInstance ezsigndocumentGetFormDataV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetFormDataV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetFormDataV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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

-(NSURLSessionTask*) ezsigndocumentGetObjectV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetObjectV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsigndocument

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve an existing Ezsigndocument
[apiInstance ezsigndocumentGetObjectV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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

-(NSURLSessionTask*) ezsigndocumentGetObjectV2WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Ezsigndocument

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve an existing Ezsigndocument
[apiInstance ezsigndocumentGetObjectV2WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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]

ezsigndocumentGetTemporaryProofV1

-(NSURLSessionTask*) ezsigndocumentGetTemporaryProofV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
        completionHandler: (void (^)(EzsigndocumentGetTemporaryProofV1Response* output, NSError* error)) handler;

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

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve the temporary proof
[apiInstance ezsigndocumentGetTemporaryProofV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
          completionHandler: ^(EzsigndocumentGetTemporaryProofV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetTemporaryProofV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*

Return type

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

-(NSURLSessionTask*) ezsigndocumentGetWordsPositionsV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentGetWordsPositionsV1Request: (EzsigndocumentGetWordsPositionsV1Request*) ezsigndocumentGetWordsPositionsV1Request
        completionHandler: (void (^)(EzsigndocumentGetWordsPositionsV1Response* output, NSError* error)) handler;

Retrieve positions X,Y of given words from a Ezsigndocument

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentGetWordsPositionsV1Request* ezsigndocumentGetWordsPositionsV1Request = [[EzsigndocumentGetWordsPositionsV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Retrieve positions X,Y of given words from a Ezsigndocument
[apiInstance ezsigndocumentGetWordsPositionsV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentGetWordsPositionsV1Request:ezsigndocumentGetWordsPositionsV1Request
          completionHandler: ^(EzsigndocumentGetWordsPositionsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentGetWordsPositionsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentGetWordsPositionsV1Request	EzsigndocumentGetWordsPositionsV1Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentPatchObjectV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentPatchObjectV1Request: (EzsigndocumentPatchObjectV1Request*) ezsigndocumentPatchObjectV1Request
        completionHandler: (void (^)(EzsigndocumentPatchObjectV1Response* output, NSError* error)) handler;

Patch an existing Ezsigndocument

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentPatchObjectV1Request* ezsigndocumentPatchObjectV1Request = [[EzsigndocumentPatchObjectV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Patch an existing Ezsigndocument
[apiInstance ezsigndocumentPatchObjectV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentPatchObjectV1Request:ezsigndocumentPatchObjectV1Request
          completionHandler: ^(EzsigndocumentPatchObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentPatchObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentPatchObjectV1Request	EzsigndocumentPatchObjectV1Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentPrefillEzsignformV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentPrefillEzsignformV1Request: (EzsigndocumentPrefillEzsignformV1Request*) ezsigndocumentPrefillEzsignformV1Request
        completionHandler: (void (^)(EzsigndocumentPrefillEzsignformV1Response* output, NSError* error)) handler;

Prefill an Ezsignform

Using this endpoint, you can prefill an Ezsignform.

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentPrefillEzsignformV1Request* ezsigndocumentPrefillEzsignformV1Request = [[EzsigndocumentPrefillEzsignformV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Prefill an Ezsignform
[apiInstance ezsigndocumentPrefillEzsignformV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentPrefillEzsignformV1Request:ezsigndocumentPrefillEzsignformV1Request
          completionHandler: ^(EzsigndocumentPrefillEzsignformV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentPrefillEzsignformV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentPrefillEzsignformV1Request	EzsigndocumentPrefillEzsignformV1Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentSubmitEzsignformV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    ezsigndocumentSubmitEzsignformV1Request: (EzsigndocumentSubmitEzsignformV1Request*) ezsigndocumentSubmitEzsignformV1Request
        completionHandler: (void (^)(EzsigndocumentSubmitEzsignformV1Response* output, NSError* error)) handler;

Submit the Ezsignform

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
EzsigndocumentSubmitEzsignformV1Request* ezsigndocumentSubmitEzsignformV1Request = [[EzsigndocumentSubmitEzsignformV1Request alloc] init]; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Submit the Ezsignform
[apiInstance ezsigndocumentSubmitEzsignformV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              ezsigndocumentSubmitEzsignformV1Request:ezsigndocumentSubmitEzsignformV1Request
          completionHandler: ^(EzsigndocumentSubmitEzsignformV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentSubmitEzsignformV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
ezsigndocumentSubmitEzsignformV1Request	EzsigndocumentSubmitEzsignformV1Request*

Return type

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

-(NSURLSessionTask*) ezsigndocumentUnsendV1WithPkiEzsigndocumentID: (NSNumber*) pkiEzsigndocumentID
    body: (NSObject*) body
        completionHandler: (void (^)(EzsigndocumentUnsendV1Response* output, NSError* error)) handler;

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

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiEzsigndocumentID = @56; // 
NSObject* body = NULL; // 

ObjectEzsigndocumentApi*apiInstance = [[ObjectEzsigndocumentApi alloc] init];

// Unsend the Ezsigndocument
[apiInstance ezsigndocumentUnsendV1WithPkiEzsigndocumentID:pkiEzsigndocumentID
              body:body
          completionHandler: ^(EzsigndocumentUnsendV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigndocumentApi->ezsigndocumentUnsendV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigndocumentID	NSNumber*
body	NSObject*

Return type

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]

Files

ObjectEzsigndocumentApi.md

Latest commit

History

ObjectEzsigndocumentApi.md

File metadata and controls

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

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

ezsigndocumentEditEzsignsignaturesV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigndocumentEditObjectV1