A list of all methods in the SignplusService service. Click on the method name to view detailed information about that method.

Methods	Description
CreateEnvelopeAsync	Create new envelope
CreateEnvelopeFromTemplateAsync	Create new envelope from template
ListEnvelopesAsync	List envelopes
GetEnvelopeAsync	Get envelope
DeleteEnvelopeAsync	Delete envelope
GetEnvelopeDocumentAsync	Get envelope document
GetEnvelopeDocumentsAsync	Get envelope documents
AddEnvelopeDocumentAsync	Add envelope document
SetEnvelopeDynamicFieldsAsync	Set envelope dynamic fields
AddEnvelopeSigningStepsAsync	Add envelope signing steps
SendEnvelopeAsync	Send envelope for signature
DuplicateEnvelopeAsync	Duplicate envelope
VoidEnvelopeAsync	Void envelope
RenameEnvelopeAsync	Rename envelope
SetEnvelopeCommentAsync	Set envelope comment
SetEnvelopeNotificationAsync	Set envelope notification
SetEnvelopeExpirationDateAsync	Set envelope expiration date
SetEnvelopeLegalityLevelAsync	Set envelope legality level
GetEnvelopeAnnotationsAsync	Get envelope annotations
GetEnvelopeDocumentAnnotationsAsync	Get envelope document annotations
AddEnvelopeAnnotationAsync	Add envelope annotation
DeleteEnvelopeAnnotationAsync	Delete envelope annotation
CreateTemplateAsync	Create new template
ListTemplatesAsync	List templates
GetTemplateAsync	Get template
DeleteTemplateAsync	Delete template
DuplicateTemplateAsync	Duplicate template
AddTemplateDocumentAsync	Add template document
GetTemplateDocumentAsync	Get template document
GetTemplateDocumentsAsync	Get template documents
AddTemplateSigningStepsAsync	Add template signing steps
RenameTemplateAsync	Rename template
SetTemplateCommentAsync	Set template comment
SetTemplateNotificationAsync	Set template notification
GetTemplateAnnotationsAsync	Get template annotations
GetDocumentTemplateAnnotationsAsync	Get document template annotations
AddTemplateAnnotationAsync	Add template annotation
DeleteTemplateAnnotationAsync	Delete template annotation
CreateWebhookAsync	Create webhook
ListWebhooksAsync	List webhooks
DeleteWebhookAsync	Delete webhook

CreateEnvelopeAsync

Create new envelope

HTTP Method: POST
Endpoint: /envelope

Parameters

Name	Type	Required	Description
input	CreateEnvelopeRequest	✅	The request body.

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new CreateEnvelopeRequest("name", EnvelopeLegalityLevel.Ses, 2, "comment", true);

var response = await client.Signplus.CreateEnvelopeAsync(input);

Console.WriteLine(response);

CreateEnvelopeFromTemplateAsync

Create new envelope from template

HTTP Method: POST
Endpoint: /envelope/from_template/{template_id}

Parameters

Name	Type	Required	Description
input	CreateEnvelopeFromTemplateRequest	✅	The request body.
templateId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new CreateEnvelopeFromTemplateRequest("name", "comment", true);

var response = await client.Signplus.CreateEnvelopeFromTemplateAsync(input, "template_id");

Console.WriteLine(response);

ListEnvelopesAsync

List envelopes

HTTP Method: POST
Endpoint: /envelopes

Parameters

Name	Type	Required	Description
input	ListEnvelopesRequest	❌	The request body.

Return Type ListEnvelopesResponse Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var tags = new List<string>() { "tags" };
var ids = new List<string>() { "ids" };
var statuses = new List<EnvelopeStatus>() { EnvelopeStatus.Draft };
var folderIds = new List<string>() { "folder_ids" };
var input = new ListEnvelopesRequest("name", tags, "comment", ids, statuses, folderIds, false, 5, 0, "uid", 10, 8, "after", "before", EnvelopeOrderField.CreationDate, false, true);

var response = await client.Signplus.ListEnvelopesAsync(input);

Console.WriteLine(response);

GetEnvelopeAsync

Get envelope

HTTP Method: GET
Endpoint: /envelope/{envelope_id}

Parameters

Name	Type	Required	Description
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeAsync("envelope_id");

Console.WriteLine(response);

DeleteEnvelopeAsync

Delete envelope

HTTP Method: DELETE
Endpoint: /envelope/{envelope_id}

Parameters

Name	Type	Required	Description
envelopeId	string	✅

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

await client.Signplus.DeleteEnvelopeAsync("envelope_id");

GetEnvelopeDocumentAsync

Get envelope document

HTTP Method: GET
Endpoint: /envelope/{envelope_id}/document/{document_id}

Parameters

Name	Type	Required	Description
envelopeId	string	✅
documentId	string	✅

Return Type Document Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeDocumentAsync("envelope_id", "document_id");

Console.WriteLine(response);

GetEnvelopeDocumentsAsync

Get envelope documents

HTTP Method: GET
Endpoint: /envelope/{envelope_id}/documents

Parameters

Name	Type	Required	Description
envelopeId	string	✅

Return Type ListEnvelopeDocumentsResponse Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeDocumentsAsync("envelope_id");

Console.WriteLine(response);

AddEnvelopeDocumentAsync

Add envelope document

HTTP Method: POST
Endpoint: /envelope/{envelope_id}/document

Parameters

Name	Type	Required	Description
input	AddEnvelopeDocumentRequest	✅	The request body.
envelopeId	string	✅

Return Type Document Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new AddEnvelopeDocumentRequest(new byte[] {});

var response = await client.Signplus.AddEnvelopeDocumentAsync(input, "envelope_id");

Console.WriteLine(response);

SetEnvelopeDynamicFieldsAsync

Set envelope dynamic fields

HTTP Method: PUT
Endpoint: /envelope/{envelope_id}/dynamic_fields

Parameters

Name	Type	Required	Description
input	SetEnvelopeDynamicFieldsRequest	✅	The request body.
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var dynamicFieldsItem = new DynamicField("name", "value");
var dynamicFields = new List<DynamicField>() { dynamicFieldsItem };
var input = new SetEnvelopeDynamicFieldsRequest(dynamicFields);

var response = await client.Signplus.SetEnvelopeDynamicFieldsAsync(input, "envelope_id");

Console.WriteLine(response);

AddEnvelopeSigningStepsAsync

Add envelope signing steps

HTTP Method: POST
Endpoint: /envelope/{envelope_id}/signing_steps

Parameters

Name	Type	Required	Description
input	AddEnvelopeSigningStepsRequest	✅	The request body.
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var verification = new RecipientVerification(RecipientVerificationType.Sms, "value");
var recipientsItem = new Recipient("name", "email", RecipientRole.Signer, "id", "uid", verification);
var recipients = new List<Recipient>() { recipientsItem };
var signingStepsItem = new SigningStep(recipients);
var signingSteps = new List<SigningStep>() { signingStepsItem };
var input = new AddEnvelopeSigningStepsRequest(signingSteps);

var response = await client.Signplus.AddEnvelopeSigningStepsAsync(input, "envelope_id");

Console.WriteLine(response);

SendEnvelopeAsync

Send envelope for signature

HTTP Method: POST
Endpoint: /envelope/{envelope_id}/send

Parameters

Name	Type	Required	Description
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.SendEnvelopeAsync("envelope_id");

Console.WriteLine(response);

DuplicateEnvelopeAsync

Duplicate envelope

HTTP Method: POST
Endpoint: /envelope/{envelope_id}/duplicate

Parameters

Name	Type	Required	Description
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.DuplicateEnvelopeAsync("envelope_id");

Console.WriteLine(response);

VoidEnvelopeAsync

Void envelope

HTTP Method: PUT
Endpoint: /envelope/{envelope_id}/void

Parameters

Name	Type	Required	Description
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.VoidEnvelopeAsync("envelope_id");

Console.WriteLine(response);

RenameEnvelopeAsync

Rename envelope

HTTP Method: PUT
Endpoint: /envelope/{envelope_id}/rename

Parameters

Name	Type	Required	Description
input	RenameEnvelopeRequest	✅	The request body.
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new RenameEnvelopeRequest("name");

var response = await client.Signplus.RenameEnvelopeAsync(input, "envelope_id");

Console.WriteLine(response);

SetEnvelopeCommentAsync

Set envelope comment

HTTP Method: PUT
Endpoint: /envelope/{envelope_id}/set_comment

Parameters

Name	Type	Required	Description
input	SetEnvelopeCommentRequest	✅	The request body.
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new SetEnvelopeCommentRequest("comment");

var response = await client.Signplus.SetEnvelopeCommentAsync(input, "envelope_id");

Console.WriteLine(response);

SetEnvelopeNotificationAsync

Set envelope notification

HTTP Method: PUT
Endpoint: /envelope/{envelope_id}/set_notification

Parameters

Name	Type	Required	Description
input	EnvelopeNotification	✅	The request body.
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new EnvelopeNotification("subject", "message", 10);

var response = await client.Signplus.SetEnvelopeNotificationAsync(input, "envelope_id");

Console.WriteLine(response);

SetEnvelopeExpirationDateAsync

Set envelope expiration date

HTTP Method: PUT
Endpoint: /envelope/{envelope_id}/set_expiration_date

Parameters

Name	Type	Required	Description
input	SetEnvelopeExpirationRequest	✅	The request body.
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new SetEnvelopeExpirationRequest(0);

var response = await client.Signplus.SetEnvelopeExpirationDateAsync(input, "envelope_id");

Console.WriteLine(response);

SetEnvelopeLegalityLevelAsync

Set envelope legality level

HTTP Method: PUT
Endpoint: /envelope/{envelope_id}/set_legality_level

Parameters

Name	Type	Required	Description
input	SetEnvelopeLegalityLevelRequest	✅	The request body.
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new SetEnvelopeLegalityLevelRequest(EnvelopeLegalityLevel.Ses);

var response = await client.Signplus.SetEnvelopeLegalityLevelAsync(input, "envelope_id");

Console.WriteLine(response);

GetEnvelopeAnnotationsAsync

Get envelope annotations

HTTP Method: GET
Endpoint: /envelope/{envelope_id}/annotations

Parameters

Name	Type	Required	Description
envelopeId	string	✅	ID of the envelope

Return Type List<Annotation> Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeAnnotationsAsync("envelope_id");

Console.WriteLine(response);

GetEnvelopeDocumentAnnotationsAsync

Get envelope document annotations

HTTP Method: GET
Endpoint: /envelope/{envelope_id}/annotations/{document_id}

Parameters

Name	Type	Required	Description
envelopeId	string	✅	ID of the envelope
documentId	string	✅	ID of document

Return Type ListEnvelopeDocumentAnnotationsResponse Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeDocumentAnnotationsAsync("envelope_id", "document_id");

Console.WriteLine(response);

AddEnvelopeAnnotationAsync

Add envelope annotation

HTTP Method: POST
Endpoint: /envelope/{envelope_id}/annotation

Parameters

Name	Type	Required	Description
input	AddAnnotationRequest	✅	The request body.
envelopeId	string	✅	ID of the envelope

Return Type Annotation Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var signature = new AnnotationSignature("id");
var initials = new AnnotationInitials("id");
var font = new AnnotationFont(AnnotationFontFamily.Unknown, false, false);
var text = new AnnotationText(5.51, 3.68, "value", "tooltip", "dynamic_field_name", font);
var font = new AnnotationFont(AnnotationFontFamily.Unknown, false, false);
var datetime = new AnnotationDateTime(3.25, font, "color", true, "timezone", 0, AnnotationDateTimeFormat.DmyNumericSlash);
var checkbox = new AnnotationCheckbox(false, AnnotationCheckboxStyle.CircleCheck);
var input = new AddAnnotationRequest("document_id", 8, 1.18, 4.42, 7.23, 7.31, AnnotationType.Text, "recipient_id", true, signature, initials, text, datetime, checkbox);

var response = await client.Signplus.AddEnvelopeAnnotationAsync(input, "envelope_id");

Console.WriteLine(response);

DeleteEnvelopeAnnotationAsync

Delete envelope annotation

HTTP Method: DELETE
Endpoint: /envelope/{envelope_id}/annotation/{annotation_id}

Parameters

Name	Type	Required	Description
envelopeId	string	✅	ID of the envelope
annotationId	string	✅	ID of the annotation to delete

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

await client.Signplus.DeleteEnvelopeAnnotationAsync("envelope_id", "annotation_id");

CreateTemplateAsync

Create new template

HTTP Method: POST
Endpoint: /template

Parameters

Name	Type	Required	Description
input	CreateTemplateRequest	✅	The request body.

Return Type Template Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new CreateTemplateRequest("name");

var response = await client.Signplus.CreateTemplateAsync(input);

Console.WriteLine(response);

ListTemplatesAsync

List templates

HTTP Method: POST
Endpoint: /templates

Parameters

Name	Type	Required	Description
input	ListTemplatesRequest	❌	The request body.

Return Type ListTemplatesResponse Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var tags = new List<string>() { "tags" };
var ids = new List<string>() { "ids" };
var input = new ListTemplatesRequest("name", tags, ids, 9, 4, "after", "before", TemplateOrderField.TemplateId, true);

var response = await client.Signplus.ListTemplatesAsync(input);

Console.WriteLine(response);

GetTemplateAsync

Get template

HTTP Method: GET
Endpoint: /template/{template_id}

Parameters

Name	Type	Required	Description
templateId	string	✅

Return Type Template Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateAsync("template_id");

Console.WriteLine(response);

DeleteTemplateAsync

Delete template

HTTP Method: DELETE
Endpoint: /template/{template_id}

Parameters

Name	Type	Required	Description
templateId	string	✅

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

await client.Signplus.DeleteTemplateAsync("template_id");

DuplicateTemplateAsync

Duplicate template

HTTP Method: POST
Endpoint: /template/{template_id}/duplicate

Parameters

Name	Type	Required	Description
templateId	string	✅

Return Type Template Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.DuplicateTemplateAsync("template_id");

Console.WriteLine(response);

AddTemplateDocumentAsync

Add template document

HTTP Method: POST
Endpoint: /template/{template_id}/document

Parameters

Name	Type	Required	Description
input	AddTemplateDocumentRequest	✅	The request body.
templateId	string	✅

Return Type Document Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new AddTemplateDocumentRequest(new byte[] {});

var response = await client.Signplus.AddTemplateDocumentAsync(input, "template_id");

Console.WriteLine(response);

GetTemplateDocumentAsync

Get template document

HTTP Method: GET
Endpoint: /template/{template_id}/document/{document_id}

Parameters

Name	Type	Required	Description
templateId	string	✅
documentId	string	✅

Return Type Document Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateDocumentAsync("template_id", "document_id");

Console.WriteLine(response);

GetTemplateDocumentsAsync

Get template documents

HTTP Method: GET
Endpoint: /template/{template_id}/documents

Parameters

Name	Type	Required	Description
templateId	string	✅

Return Type ListTemplateDocumentsResponse Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateDocumentsAsync("template_id");

Console.WriteLine(response);

AddTemplateSigningStepsAsync

Add template signing steps

HTTP Method: POST
Endpoint: /template/{template_id}/signing_steps

Parameters

Name	Type	Required	Description
input	AddTemplateSigningStepsRequest	✅	The request body.
templateId	string	✅

Return Type Template Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var recipientsItem = new TemplateRecipient("id", "uid", "name", "email", TemplateRecipientRole.Signer);
var recipients = new List<TemplateRecipient>() { recipientsItem };
var signingStepsItem = new TemplateSigningStep(recipients);
var signingSteps = new List<TemplateSigningStep>() { signingStepsItem };
var input = new AddTemplateSigningStepsRequest(signingSteps);

var response = await client.Signplus.AddTemplateSigningStepsAsync(input, "template_id");

Console.WriteLine(response);

RenameTemplateAsync

Rename template

HTTP Method: PUT
Endpoint: /template/{template_id}/rename

Parameters

Name	Type	Required	Description
input	RenameTemplateRequest	✅	The request body.
templateId	string	✅

Return Type Template Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new RenameTemplateRequest("name");

var response = await client.Signplus.RenameTemplateAsync(input, "template_id");

Console.WriteLine(response);

SetTemplateCommentAsync

Set template comment

HTTP Method: PUT
Endpoint: /template/{template_id}/set_comment

Parameters

Name	Type	Required	Description
input	SetTemplateCommentRequest	✅	The request body.
templateId	string	✅

Return Type Template Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new SetTemplateCommentRequest("comment");

var response = await client.Signplus.SetTemplateCommentAsync(input, "template_id");

Console.WriteLine(response);

SetTemplateNotificationAsync

Set template notification

HTTP Method: PUT
Endpoint: /template/{template_id}/set_notification

Parameters

Name	Type	Required	Description
input	EnvelopeNotification	✅	The request body.
templateId	string	✅

Return Type Template Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new EnvelopeNotification("subject", "message", 10);

var response = await client.Signplus.SetTemplateNotificationAsync(input, "template_id");

Console.WriteLine(response);

GetTemplateAnnotationsAsync

Get template annotations

HTTP Method: GET
Endpoint: /template/{template_id}/annotations

Parameters

Name	Type	Required	Description
templateId	string	✅	ID of the template

Return Type ListTemplateAnnotationsResponse Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateAnnotationsAsync("template_id");

Console.WriteLine(response);

GetDocumentTemplateAnnotationsAsync

Get document template annotations

HTTP Method: GET
Endpoint: /template/{template_id}/annotations/{document_id}

Parameters

Name	Type	Required	Description
templateId	string	✅	ID of the template
documentId	string	✅	ID of document

Return Type ListTemplateDocumentAnnotationsResponse Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetDocumentTemplateAnnotationsAsync("template_id", "document_id");

Console.WriteLine(response);

AddTemplateAnnotationAsync

Add template annotation

HTTP Method: POST
Endpoint: /template/{template_id}/annotation

Parameters

Name	Type	Required	Description
input	AddAnnotationRequest	✅	The request body.
templateId	string	✅	ID of the template

Return Type Annotation Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var signature = new AnnotationSignature("id");
var initials = new AnnotationInitials("id");
var font = new AnnotationFont(AnnotationFontFamily.Unknown, false, false);
var text = new AnnotationText(5.51, 3.68, "value", "tooltip", "dynamic_field_name", font);
var font = new AnnotationFont(AnnotationFontFamily.Unknown, false, false);
var datetime = new AnnotationDateTime(3.25, font, "color", true, "timezone", 0, AnnotationDateTimeFormat.DmyNumericSlash);
var checkbox = new AnnotationCheckbox(false, AnnotationCheckboxStyle.CircleCheck);
var input = new AddAnnotationRequest("document_id", 8, 1.18, 4.42, 7.23, 7.31, AnnotationType.Text, "recipient_id", true, signature, initials, text, datetime, checkbox);

var response = await client.Signplus.AddTemplateAnnotationAsync(input, "template_id");

Console.WriteLine(response);

DeleteTemplateAnnotationAsync

Delete template annotation

HTTP Method: DELETE
Endpoint: /template/{template_id}/annotation/{annotation_id}

Parameters

Name	Type	Required	Description
templateId	string	✅	ID of the template
annotationId	string	✅	ID of the annotation to delete

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

await client.Signplus.DeleteTemplateAnnotationAsync("template_id", "annotation_id");

CreateWebhookAsync

Create webhook

HTTP Method: POST
Endpoint: /webhook

Parameters

Name	Type	Required	Description
input	CreateWebhookRequest	✅	The request body.

Return Type Webhook Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new CreateWebhookRequest(WebhookEvent.EnvelopeExpired, "target");

var response = await client.Signplus.CreateWebhookAsync(input);

Console.WriteLine(response);

ListWebhooksAsync

List webhooks

HTTP Method: POST
Endpoint: /webhooks

Parameters

Name	Type	Required	Description
input	ListWebhooksRequest	❌	The request body.

Return Type ListWebhooksResponse Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new ListWebhooksRequest("webhook_id", WebhookEvent.EnvelopeExpired);

var response = await client.Signplus.ListWebhooksAsync(input);

Console.WriteLine(response);

DeleteWebhookAsync

Delete webhook

HTTP Method: DELETE
Endpoint: /webhook/{webhook_id}

Parameters

Name	Type	Required	Description
webhookId	string	✅

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

await client.Signplus.DeleteWebhookAsync("webhook_id");

Models

Document

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the document
Name	string	❌	Name of the document
Filename	string	❌	Filename of the document
PageCount	long	❌	Number of pages in the document
Pages	List<Page>	❌	List of pages in the document

CreateEnvelopeRequest

Properties

Name	Type	Required	Description
Name	string	✅	Name of the envelope
LegalityLevel	EnvelopeLegalityLevel	✅	Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
ExpiresAt	long	❌	Unix timestamp of the expiration date
Comment	string	❌	Comment for the envelope
Sandbox	bool	❌	Whether the envelope is created in sandbox mode

ListEnvelopesRequest

Properties

Name	Type	Required	Description
Name	string	❌	Name of the envelope
Tags	List<string>	❌	List of tags
Comment	string	❌	Comment of the envelope
Ids	List<string>	❌	List of envelope IDs
Statuses	List<EnvelopeStatus>	❌	List of envelope statuses
FolderIds	List<string>	❌	List of folder IDs
OnlyRootFolder	bool	❌	Whether to only list envelopes in the root folder
DateFrom	long	❌	Unix timestamp of the start date
DateTo	long	❌	Unix timestamp of the end date
Uid	string	❌	Unique identifier of the user
First	long	❌
Last	long	❌
After	string	❌
Before	string	❌
OrderField	EnvelopeOrderField	❌	Field to order envelopes by
Ascending	bool	❌	Whether to order envelopes in ascending order
IncludeTrash	bool	❌	Whether to include envelopes in the trash

EnvelopeNotification

Properties

Name	Type	Required	Description
Subject	string	❌	Subject of the notification
Message	string	❌	Message of the notification
ReminderInterval	long	❌	Interval in days to send reminder

ListTemplatesRequest

Properties

Name	Type	Required	Description
Name	string	❌	Name of the template
Tags	List<string>	❌	List of tag templates
Ids	List<string>	❌	List of templates IDs
First	long	❌
Last	long	❌
After	string	❌
Before	string	❌
OrderField	TemplateOrderField	❌	Field to order templates by
Ascending	bool	❌	Whether to order templates in ascending order

SetTemplateCommentRequest

Properties

Name	Type	Required	Description
Comment	string	✅	Comment for the template

Template

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the template
Name	string	❌	Name of the template
Comment	string	❌	Comment for the template
Pages	long	❌	Total number of pages in the template
LegalityLevel	EnvelopeLegalityLevel	❌	Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
CreatedAt	long	❌	Unix timestamp of the creation date
UpdatedAt	long	❌	Unix timestamp of the last modification date
ExpirationDelay	long	❌	Expiration delay added to the current time when an envelope is created from this template
NumRecipients	long	❌	Number of recipients in the envelope
SigningSteps	List<TemplateSigningStep>	❌
Documents	List<Document>	❌
Notification	EnvelopeNotification	❌
DynamicFields	List<string>	❌	List of dynamic fields

RecipientVerificationType

Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered) Properties

Name	Type	Required	Description
Sms	string	✅	“SMS”
Passcode	string	✅	“PASSCODE”

AddEnvelopeSigningStepsRequest

Properties

Name	Type	Required	Description
SigningSteps	List<SigningStep>	❌	List of signing steps

AnnotationFontFamily

Font family of the text Properties

Name	Type	Required	Description
Unknown	string	✅	“UNKNOWN”
Serif	string	✅	“SERIF”
Sans	string	✅	“SANS”
Mono	string	✅	“MONO”

AddTemplateSigningStepsRequest

Properties

Name	Type	Required	Description
SigningSteps	List<TemplateSigningStep>	✅	List of signing steps

SetEnvelopeCommentRequest

Properties

Name	Type	Required	Description
Comment	string	✅	Comment for the envelope

TemplateOrderField

Field to order templates by Properties

Name	Type	Required	Description
TemplateId	string	✅	“TEMPLATE_ID”
TemplateCreationDate	string	✅	“TEMPLATE_CREATION_DATE”
TemplateModificationDate	string	✅	“TEMPLATE_MODIFICATION_DATE”
TemplateName	string	✅	“TEMPLATE_NAME”

EnvelopeOrderField

Field to order envelopes by Properties

Name	Type	Required	Description
CreationDate	string	✅	“CREATION_DATE”
ModificationDate	string	✅	“MODIFICATION_DATE”
Name	string	✅	“NAME”
Status	string	✅	“STATUS”
LastDocumentChange	string	✅	“LAST_DOCUMENT_CHANGE”

AddEnvelopeDocumentRequest

Properties

Name	Type	Required	Description
File	byte[]	❌	File to upload in binary format

ListWebhooksRequest

Properties

Name	Type	Required	Description
WebhookId	string	❌	ID of the webhook
Event_	WebhookEvent	❌	Event of the webhook

SetEnvelopeLegalityLevelRequest

Properties

Name	Type	Required	Description
LegalityLevel	EnvelopeLegalityLevel	❌	Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)

SetEnvelopeExpirationRequest

Properties

Name	Type	Required	Description
ExpiresAt	long	✅	Unix timestamp of the expiration date

AnnotationText

Text annotation (null if annotation is not a text) Properties

Name	Type	Required	Description
Size	double	❌	Font size of the text in pt
Color	double	❌	Text color in 32bit representation
Value	string	❌	Text content of the annotation
Tooltip	string	❌	Tooltip of the annotation
DynamicFieldName	string	❌	Name of the dynamic field
Font	AnnotationFont	❌

AnnotationCheckbox

Checkbox annotation (null if annotation is not a checkbox) Properties

Name	Type	Required	Description
Checked_	bool	❌	Whether the checkbox is checked
Style	AnnotationCheckboxStyle	❌	Style of the checkbox

Envelope

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the envelope
Name	string	❌	Name of the envelope
Comment	string	❌	Comment for the envelope
Pages	long	❌	Total number of pages in the envelope
FlowType	EnvelopeFlowType	❌	Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
LegalityLevel	EnvelopeLegalityLevel	❌	Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
Status	EnvelopeStatus	❌	Status of the envelope
CreatedAt	long	❌	Unix timestamp of the creation date
UpdatedAt	long	❌	Unix timestamp of the last modification date
ExpiresAt	long	❌	Unix timestamp of the expiration date
NumRecipients	long	❌	Number of recipients in the envelope
IsDuplicable	bool	❌	Whether the envelope can be duplicated
SigningSteps	List<SigningStep>	❌
Documents	List<Document>	❌
Notification	EnvelopeNotification	❌

AddTemplateDocumentRequest

Properties

Name	Type	Required	Description
File	byte[]	✅	File to upload in binary format

TemplateRecipient

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the recipient
Uid	string	❌	Unique identifier of the user associated with the recipient
Name	string	❌	Name of the recipient
Email	string	❌	Email of the recipient
Role	TemplateRecipientRole	❌	Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)

AddAnnotationRequest

Properties

Name	Type	Required	Description
DocumentId	string	✅	ID of the document
Page	long	✅	Page number where the annotation is placed
X	double	✅	X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
Y	double	✅	Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
Width	double	✅	Width of the annotation (in % of the page width from 0 to 100)
Height	double	✅	Height of the annotation (in % of the page height from 0 to 100)
Type_	AnnotationType	✅	Type of the annotation
RecipientId	string	❌	ID of the recipient
Required	bool	❌
Signature	AnnotationSignature	❌	Signature annotation (null if annotation is not a signature)
Initials	AnnotationInitials	❌	Initials annotation (null if annotation is not initials)
Text	AnnotationText	❌	Text annotation (null if annotation is not a text)
Datetime	AnnotationDateTime	❌	Date annotation (null if annotation is not a date)
Checkbox	AnnotationCheckbox	❌	Checkbox annotation (null if annotation is not a checkbox)

ListEnvelopeDocumentAnnotationsResponse

Properties

Name	Type	Required	Description
Annotations	List<Annotation>	❌

EnvelopeStatus

Status of the envelope Properties

Name	Type	Required	Description
Draft	string	✅	“DRAFT”
InProgress	string	✅	“IN_PROGRESS”
Completed	string	✅	“COMPLETED”
Expired	string	✅	“EXPIRED”
Declined	string	✅	“DECLINED”
Voided	string	✅	“VOIDED”
Pending	string	✅	“PENDING”

RecipientVerification

Properties

Name	Type	Required	Description
Type_	RecipientVerificationType	❌	Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered)
Value	string	❌

AnnotationCheckboxStyle

Style of the checkbox Properties

Name	Type	Required	Description
CircleCheck	string	✅	“CIRCLE_CHECK”
CircleFull	string	✅	“CIRCLE_FULL”
SquareCheck	string	✅	“SQUARE_CHECK”
SquareFull	string	✅	“SQUARE_FULL”
CheckMark	string	✅	“CHECK_MARK”
TimesSquare	string	✅	“TIMES_SQUARE”

SigningStep

Properties

Name	Type	Required	Description
Recipients	List<Recipient>	❌	List of recipients

AnnotationDateTime

Date annotation (null if annotation is not a date) Properties

Name	Type	Required	Description
Size	double	❌	Font size of the text in pt
Font	AnnotationFont	❌
Color	string	❌	Color of the text in hex format
AutoFill	bool	❌	Whether the date should be automatically filled
Timezone	string	❌	Timezone of the date
Timestamp	long	❌	Unix timestamp of the date
Format	AnnotationDateTimeFormat	❌	Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces)

CreateTemplateRequest

Properties

Name	Type	Required	Description
Name	string	✅

ListTemplateDocumentsResponse

Properties

Name	Type	Required	Description
Documents	List<Document>	❌

AnnotationInitials

Initials annotation (null if annotation is not initials) Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the annotation initials

AnnotationFont

Properties

Name	Type	Required	Description
Family	AnnotationFontFamily	❌	Font family of the text
Italic	bool	❌	Whether the text is italic
Bold	bool	❌	Whether the text is bold

AnnotationType

Type of the annotation Properties

Name	Type	Required	Description
Text	string	✅	“TEXT”
Signature	string	✅	“SIGNATURE”
Initials	string	✅	“INITIALS”
Checkbox	string	✅	“CHECKBOX”
Date	string	✅	“DATE”

Webhook

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the webhook
Event_	WebhookEvent	❌	Event of the webhook
Target	string	❌	Target URL of the webhook

RenameTemplateRequest

Properties

Name	Type	Required	Description
Name	string	✅	Name of the template

ListTemplatesResponse

Properties

Name	Type	Required	Description
HasNextPage	bool	❌	Whether there is a next page
HasPreviousPage	bool	❌	Whether there is a previous page
Templates	List<Template>	❌

RecipientRole

Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document) Properties

Name	Type	Required	Description
Signer	string	✅	“SIGNER”
ReceivesCopy	string	✅	“RECEIVES_COPY”
InPersonSigner	string	✅	“IN_PERSON_SIGNER”

Annotation

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the annotation
RecipientId	string	❌	ID of the recipient
DocumentId	string	❌	ID of the document
Page	long	❌	Page number where the annotation is placed
X	double	❌	X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
Y	double	❌	Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
Width	double	❌	Width of the annotation (in % of the page width from 0 to 100)
Height	double	❌	Height of the annotation (in % of the page height from 0 to 100)
Required	bool	❌	Whether the annotation is required
Type_	AnnotationType	❌	Type of the annotation
Signature	AnnotationSignature	❌	Signature annotation (null if annotation is not a signature)
Initials	AnnotationInitials	❌	Initials annotation (null if annotation is not initials)
Text	AnnotationText	❌	Text annotation (null if annotation is not a text)
Datetime	AnnotationDateTime	❌	Date annotation (null if annotation is not a date)
Checkbox	AnnotationCheckbox	❌	Checkbox annotation (null if annotation is not a checkbox)

DynamicField

Properties

Name	Type	Required	Description
Name	string	❌	Name of the dynamic field
Value	string	❌	Value of the dynamic field

AnnotationDateTimeFormat

Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces) Properties

Name	Type	Required	Description
DmyNumericSlash	string	✅	“DMY_NUMERIC_SLASH”
MdyNumericSlash	string	✅	“MDY_NUMERIC_SLASH”
YmdNumericSlash	string	✅	“YMD_NUMERIC_SLASH”
DmyNumericDashShort	string	✅	“DMY_NUMERIC_DASH_SHORT”
DmyNumericDash	string	✅	“DMY_NUMERIC_DASH”
YmdNumericDash	string	✅	“YMD_NUMERIC_DASH”
MdyTextDashShort	string	✅	“MDY_TEXT_DASH_SHORT”
MdyTextSpaceShort	string	✅	“MDY_TEXT_SPACE_SHORT”
MdyTextSpace	string	✅	“MDY_TEXT_SPACE”

EnvelopeFlowType

Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow) Properties

Name	Type	Required	Description
RequestSignature	string	✅	“REQUEST_SIGNATURE”
SignMyself	string	✅	“SIGN_MYSELF”

EnvelopeLegalityLevel

Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes) Properties

Name	Type	Required	Description
Ses	string	✅	“SES”
QesEidas	string	✅	“QES_EIDAS”
QesZertes	string	✅	“QES_ZERTES”

TemplateRecipientRole

Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document) Properties

Name	Type	Required	Description
Signer	string	✅	“SIGNER”
ReceivesCopy	string	✅	“RECEIVES_COPY”
InPersonSigner	string	✅	“IN_PERSON_SIGNER”

SetEnvelopeDynamicFieldsRequest

Properties

Name	Type	Required	Description
DynamicFields	List<DynamicField>	✅	List of dynamic fields

Page

Properties

Name	Type	Required	Description
Width	long	❌	Width of the page in pixels
Height	long	❌	Height of the page in pixels

TemplateSigningStep

Properties

Name	Type	Required	Description
Recipients	List<TemplateRecipient>	❌	List of recipients

ListEnvelopesResponse

Properties

Name	Type	Required	Description
HasNextPage	bool	❌	Whether there is a next page
HasPreviousPage	bool	❌	Whether there is a previous page
Envelopes	List<Envelope>	❌

Recipient

Properties

Name	Type	Required	Description
Name	string	✅	Name of the recipient
Email	string	✅	Email of the recipient
Role	RecipientRole	✅	Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)
Id	string	❌	Unique identifier of the recipient
Uid	string	❌	Unique identifier of the user associated with the recipient
Verification	RecipientVerification	❌

WebhookEvent

Event of the webhook Properties

Name	Type	Required	Description
EnvelopeExpired	string	✅	“ENVELOPE_EXPIRED”
EnvelopeDeclined	string	✅	“ENVELOPE_DECLINED”
EnvelopeVoided	string	✅	“ENVELOPE_VOIDED”
EnvelopeCompleted	string	✅	“ENVELOPE_COMPLETED”
EnvelopeAuditTrail	string	✅	“ENVELOPE_AUDIT_TRAIL”

CreateWebhookRequest

Properties

Name	Type	Required	Description
Event_	WebhookEvent	✅	Event of the webhook
Target	string	✅	URL of the webhook target

CreateEnvelopeFromTemplateRequest

Properties

Name	Type	Required	Description
Name	string	✅	Name of the envelope
Comment	string	❌	Comment for the envelope
Sandbox	bool	❌	Whether the envelope is created in sandbox mode

ListTemplateAnnotationsResponse

Properties

Name	Type	Required	Description
Annotations	List<Annotation>	❌

RenameEnvelopeRequest

Properties

Name	Type	Required	Description
Name	string	❌	Name of the envelope

ListTemplateDocumentAnnotationsResponse

Properties

Name	Type	Required	Description
Annotations	List<Annotation>	❌

ListEnvelopeDocumentsResponse

Properties

Name	Type	Required	Description
Documents	List<Document>	❌

ListWebhooksResponse

Properties

Name	Type	Required	Description
Webhooks	List<Webhook>	❌

AnnotationSignature

Signature annotation (null if annotation is not a signature) Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the annotation signature

Get Started

Concepts

Guides

Backend SDKs

API Reference

​CreateEnvelopeAsync

​CreateEnvelopeFromTemplateAsync

​ListEnvelopesAsync

​GetEnvelopeAsync

​DeleteEnvelopeAsync

​GetEnvelopeDocumentAsync

​GetEnvelopeDocumentsAsync

​AddEnvelopeDocumentAsync

​SetEnvelopeDynamicFieldsAsync

​AddEnvelopeSigningStepsAsync

​SendEnvelopeAsync

​DuplicateEnvelopeAsync

​VoidEnvelopeAsync

​RenameEnvelopeAsync

​SetEnvelopeCommentAsync

​SetEnvelopeNotificationAsync

​SetEnvelopeExpirationDateAsync

​SetEnvelopeLegalityLevelAsync

​GetEnvelopeAnnotationsAsync

​GetEnvelopeDocumentAnnotationsAsync

​AddEnvelopeAnnotationAsync

​DeleteEnvelopeAnnotationAsync

​CreateTemplateAsync

​ListTemplatesAsync

​GetTemplateAsync

​DeleteTemplateAsync

​DuplicateTemplateAsync

​AddTemplateDocumentAsync

​GetTemplateDocumentAsync

​GetTemplateDocumentsAsync

​AddTemplateSigningStepsAsync

​RenameTemplateAsync

​SetTemplateCommentAsync

​SetTemplateNotificationAsync

​GetTemplateAnnotationsAsync

​GetDocumentTemplateAnnotationsAsync

​AddTemplateAnnotationAsync

​DeleteTemplateAnnotationAsync

​CreateWebhookAsync

​ListWebhooksAsync

​DeleteWebhookAsync

​Models

​Document

​CreateEnvelopeRequest

​ListEnvelopesRequest

​EnvelopeNotification

​ListTemplatesRequest

​SetTemplateCommentRequest

​Template

​RecipientVerificationType

​AddEnvelopeSigningStepsRequest

​AnnotationFontFamily

​AddTemplateSigningStepsRequest

​SetEnvelopeCommentRequest

​TemplateOrderField

​EnvelopeOrderField

​AddEnvelopeDocumentRequest

​ListWebhooksRequest

​SetEnvelopeLegalityLevelRequest

​SetEnvelopeExpirationRequest

​AnnotationText

​AnnotationCheckbox

​Envelope

​AddTemplateDocumentRequest

​TemplateRecipient

​AddAnnotationRequest

​ListEnvelopeDocumentAnnotationsResponse

​EnvelopeStatus

​RecipientVerification

​AnnotationCheckboxStyle

​SigningStep

​AnnotationDateTime

​CreateTemplateRequest

​ListTemplateDocumentsResponse

​AnnotationInitials

CreateEnvelopeAsync

CreateEnvelopeFromTemplateAsync

ListEnvelopesAsync

GetEnvelopeAsync

DeleteEnvelopeAsync

GetEnvelopeDocumentAsync

GetEnvelopeDocumentsAsync

AddEnvelopeDocumentAsync

SetEnvelopeDynamicFieldsAsync

AddEnvelopeSigningStepsAsync

SendEnvelopeAsync

DuplicateEnvelopeAsync

VoidEnvelopeAsync

RenameEnvelopeAsync

SetEnvelopeCommentAsync

SetEnvelopeNotificationAsync

SetEnvelopeExpirationDateAsync

SetEnvelopeLegalityLevelAsync

GetEnvelopeAnnotationsAsync

GetEnvelopeDocumentAnnotationsAsync

AddEnvelopeAnnotationAsync

DeleteEnvelopeAnnotationAsync

CreateTemplateAsync

ListTemplatesAsync

GetTemplateAsync

DeleteTemplateAsync

DuplicateTemplateAsync

AddTemplateDocumentAsync

GetTemplateDocumentAsync

GetTemplateDocumentsAsync

AddTemplateSigningStepsAsync

RenameTemplateAsync

SetTemplateCommentAsync

SetTemplateNotificationAsync

GetTemplateAnnotationsAsync

GetDocumentTemplateAnnotationsAsync

AddTemplateAnnotationAsync

DeleteTemplateAnnotationAsync

CreateWebhookAsync

ListWebhooksAsync

DeleteWebhookAsync

Models

Document

CreateEnvelopeRequest

ListEnvelopesRequest

EnvelopeNotification

ListTemplatesRequest

SetTemplateCommentRequest

Template

RecipientVerificationType

AddEnvelopeSigningStepsRequest

AnnotationFontFamily

AddTemplateSigningStepsRequest

SetEnvelopeCommentRequest

TemplateOrderField

EnvelopeOrderField

AddEnvelopeDocumentRequest

ListWebhooksRequest

SetEnvelopeLegalityLevelRequest

SetEnvelopeExpirationRequest

AnnotationText

AnnotationCheckbox

Envelope

AddTemplateDocumentRequest

TemplateRecipient

AddAnnotationRequest

ListEnvelopeDocumentAnnotationsResponse

EnvelopeStatus

RecipientVerification

AnnotationCheckboxStyle

SigningStep

AnnotationDateTime

CreateTemplateRequest

ListTemplateDocumentsResponse

AnnotationInitials

AnnotationFont

AnnotationType

Webhook

RenameTemplateRequest

ListTemplatesResponse