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

Methods	Description
create_envelope	Create new envelope
create_envelope_from_template	Create new envelope from template
list_envelopes	List envelopes
get_envelope	Get envelope
delete_envelope	Delete envelope
download_envelope_signed_documents	Download signed documents for an envelope
download_envelope_certificate	Download certificate of completion for an envelope
get_envelope_document	Get envelope document
get_envelope_documents	Get envelope documents
add_envelope_document	Add envelope document
set_envelope_dynamic_fields	Set envelope dynamic fields
add_envelope_signing_steps	Add envelope signing steps
set_envelope_attachments_settings	Set envelope attachment settings
set_envelope_attachments_placeholders	Placeholders to be set, completely replacing the existing ones.
get_attachment_file	Get envelope attachment file
send_envelope	Send envelope for signature
duplicate_envelope	Duplicate envelope
void_envelope	Void envelope
rename_envelope	Rename envelope
set_envelope_comment	Set envelope comment
set_envelope_notification	Set envelope notification
set_envelope_expiration_date	Set envelope expiration date
set_envelope_legality_level	Set envelope legality level
get_envelope_annotations	Get envelope annotations
get_envelope_document_annotations	Get envelope document annotations
add_envelope_annotation	Add envelope annotation
delete_envelope_annotation	Delete envelope annotation
create_template	Create new template
list_templates	List templates
get_template	Get template
delete_template	Delete template
duplicate_template	Duplicate template
add_template_document	Add template document
get_template_document	Get template document
get_template_documents	Get template documents
add_template_signing_steps	Add template signing steps
rename_template	Rename template
set_template_comment	Set template comment
set_template_notification	Set template notification
get_template_annotations	Get template annotations
get_document_template_annotations	Get document template annotations
add_template_annotation	Add template annotation
delete_template_annotation	Delete template annotation
set_template_attachments_settings	Set template attachment settings
set_template_attachments_placeholders	Placeholders to be set, completely replacing the existing ones.
create_webhook	Create webhook
list_webhooks	List webhooks
delete_webhook	Delete webhook

create_envelope

Create new envelope

HTTP Method: POST
Endpoint: /envelope

Parameters

Name	Type	Required	Description
input	Models\CreateEnvelopeRequest	✅	Create new envelope

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\EnvelopeLegalityLevel;
use Signplus\Models\CreateEnvelopeRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$envelopeLegalityLevel = Models\EnvelopeLegalityLevel::Ses;

$input = new Models\CreateEnvelopeRequest(
  name: "name",
  legalityLevel: $envelopeLegalityLevel,
  expiresAt: 6,
  comment: "comment",
  sandbox: true
);

$response = $sdk->signplus->createEnvelope(
  input: $input
);

print_r($response);

create_envelope_from_template

Create new envelope from template

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

Parameters

Name	Type	Required	Description
input	Models\CreateEnvelopeFromTemplateRequest	✅	Create new envelope from template
$templateId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\CreateEnvelopeFromTemplateRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\CreateEnvelopeFromTemplateRequest(
  name: "name",
  comment: "comment",
  sandbox: true
);

$response = $sdk->signplus->createEnvelopeFromTemplate(
  input: $input,
  templateId: "template_id"
);

print_r($response);

list_envelopes

List envelopes

HTTP Method: POST
Endpoint: /envelopes

Parameters

Name	Type	Required	Description
input	Models\ListEnvelopesRequest	❌	List envelopes

Return Type Models\ListEnvelopesResponse Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\EnvelopeStatus;
use Signplus\Models\EnvelopeOrderField;
use Signplus\Models\ListEnvelopesRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\ListEnvelopesRequest(
  name: "name",
  tags: [],
  comment: "comment",
  ids: [],
  statuses: [],
  folderIds: [],
  onlyRootFolder: true,
  dateFrom: 123,
  dateTo: 5,
  uid: "uid",
  first: 7,
  last: 3,
  after: "after",
  before: "before",
  orderField: $envelopeOrderField,
  ascending: true,
  includeTrash: true
);

$response = $sdk->signplus->listEnvelopes(
  input: $input
);

print_r($response);

get_envelope

Get envelope

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

Parameters

Name	Type	Required	Description
$envelopeId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->getEnvelope(
  envelopeId: "envelope_id"
);

print_r($response);

delete_envelope

Delete envelope

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

Parameters

Name	Type	Required	Description
$envelopeId	string	✅

Return Type mixed Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->deleteEnvelope(
  envelopeId: "envelope_id"
);

print_r($response);

download_envelope_signed_documents

Download signed documents for an envelope

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

Parameters

Name	Type	Required	Description
$envelopeId	string	✅	ID of the envelope
$certificateOfCompletion	bool	❌	Whether to include the certificate of completion in the downloaded file

Return Type mixed Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->downloadEnvelopeSignedDocuments(
  certificateOfCompletion: true,
  envelopeId: "envelope_id"
);

print_r($response);

download_envelope_certificate

Download certificate of completion for an envelope

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

Parameters

Name	Type	Required	Description
$envelopeId	string	✅	ID of the envelope

Return Type mixed Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->downloadEnvelopeCertificate(
  envelopeId: "envelope_id"
);

print_r($response);

get_envelope_document

Get envelope document

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

Parameters

Name	Type	Required	Description
$envelopeId	string	✅
$documentId	string	✅

Return Type Models\Document Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->getEnvelopeDocument(
  envelopeId: "envelope_id",
  documentId: "document_id"
);

print_r($response);

get_envelope_documents

Get envelope documents

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

Parameters

Name	Type	Required	Description
$envelopeId	string	✅

Return Type Models\ListEnvelopeDocumentsResponse Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->getEnvelopeDocuments(
  envelopeId: "envelope_id"
);

print_r($response);

add_envelope_document

Add envelope document

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

Parameters

Name	Type	Required	Description
input	Models\AddEnvelopeDocumentRequest	✅	Add envelope document
$envelopeId	string	✅

Return Type Models\Document Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\AddEnvelopeDocumentRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\AddEnvelopeDocumentRequest(
  file: file
);

$response = $sdk->signplus->addEnvelopeDocument(
  input: $input,
  envelopeId: "envelope_id"
);

print_r($response);

set_envelope_dynamic_fields

Set envelope dynamic fields

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

Parameters

Name	Type	Required	Description
input	Models\SetEnvelopeDynamicFieldsRequest	✅	Set envelope dynamic fields
$envelopeId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\DynamicField;
use Signplus\Models\SetEnvelopeDynamicFieldsRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$dynamicField = new Models\DynamicField(
  name: "name",
  value: "value"
);

$input = new Models\SetEnvelopeDynamicFieldsRequest(
  dynamicFields: []
);

$response = $sdk->signplus->setEnvelopeDynamicFields(
  input: $input,
  envelopeId: "envelope_id"
);

print_r($response);

add_envelope_signing_steps

Add envelope signing steps

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

Parameters

Name	Type	Required	Description
input	Models\AddEnvelopeSigningStepsRequest	✅	Add envelope signing steps
$envelopeId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\SigningStep;
use Signplus\Models\AddEnvelopeSigningStepsRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\AddEnvelopeSigningStepsRequest(
  signingSteps: []
);

$response = $sdk->signplus->addEnvelopeSigningSteps(
  input: $input,
  envelopeId: "envelope_id"
);

print_r($response);

set_envelope_attachments_settings

Set envelope attachment settings

HTTP Method: PUT
Endpoint: /envelope/{envelope_id}/attachments/settings

Parameters

Name	Type	Required	Description
input	Models\SetEnvelopeAttachmentsSettingsRequest	✅	Set envelope attachment settings
$envelopeId	string	✅

Return Type Models\EnvelopeAttachments Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\AttachmentSettings;
use Signplus\Models\SetEnvelopeAttachmentsSettingsRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$attachmentSettings = new Models\AttachmentSettings(
  visibleToRecipients: true
);

$input = new Models\SetEnvelopeAttachmentsSettingsRequest(
  settings: $attachmentSettings
);

$response = $sdk->signplus->setEnvelopeAttachmentsSettings(
  input: $input,
  envelopeId: "envelope_id"
);

print_r($response);

set_envelope_attachments_placeholders

Placeholders to be set, completely replacing the existing ones.

HTTP Method: PUT
Endpoint: /envelope/{envelope_id}/attachments/placeholders

Parameters

Name	Type	Required	Description
input	Models\SetEnvelopeAttachmentsPlaceholdersRequest	✅	Placeholders to be set, completely replacing the existing ones.
$envelopeId	string	✅

Return Type Models\EnvelopeAttachments Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\AttachmentPlaceholderRequest;
use Signplus\Models\SetEnvelopeAttachmentsPlaceholdersRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$attachmentPlaceholderRequest = new Models\AttachmentPlaceholderRequest(
  recipientId: "recipient_id",
  id: "id",
  name: "name",
  hint: "hint",
  required: true,
  multiple: true
);

$input = new Models\SetEnvelopeAttachmentsPlaceholdersRequest(
  placeholders: []
);

$response = $sdk->signplus->setEnvelopeAttachmentsPlaceholders(
  input: $input,
  envelopeId: "envelope_id"
);

print_r($response);

get_attachment_file

Get envelope attachment file

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

Parameters

Name	Type	Required	Description
$envelopeId	string	✅
$fileId	string	✅

Return Type mixed Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->getAttachmentFile(
  envelopeId: "envelope_id",
  fileId: "file_id"
);

print_r($response);

send_envelope

Send envelope for signature

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

Parameters

Name	Type	Required	Description
$envelopeId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->sendEnvelope(
  envelopeId: "envelope_id"
);

print_r($response);

duplicate_envelope

Duplicate envelope

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

Parameters

Name	Type	Required	Description
$envelopeId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->duplicateEnvelope(
  envelopeId: "envelope_id"
);

print_r($response);

void_envelope

Void envelope

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

Parameters

Name	Type	Required	Description
$envelopeId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->voidEnvelope(
  envelopeId: "envelope_id"
);

print_r($response);

rename_envelope

Rename envelope

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

Parameters

Name	Type	Required	Description
input	Models\RenameEnvelopeRequest	✅	Rename envelope
$envelopeId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\RenameEnvelopeRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\RenameEnvelopeRequest(
  name: "name"
);

$response = $sdk->signplus->renameEnvelope(
  input: $input,
  envelopeId: "envelope_id"
);

print_r($response);

set_envelope_comment

Set envelope comment

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

Parameters

Name	Type	Required	Description
input	Models\SetEnvelopeCommentRequest	✅	Set envelope comment
$envelopeId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\SetEnvelopeCommentRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\SetEnvelopeCommentRequest(
  comment: "comment"
);

$response = $sdk->signplus->setEnvelopeComment(
  input: $input,
  envelopeId: "envelope_id"
);

print_r($response);

set_envelope_notification

Set envelope notification

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

Parameters

Name	Type	Required	Description
input	Models\EnvelopeNotification	✅	Set envelope notification
$envelopeId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\EnvelopeNotification;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\EnvelopeNotification(
  subject: "subject",
  message: "message",
  reminderInterval: 123
);

$response = $sdk->signplus->setEnvelopeNotification(
  input: $input,
  envelopeId: "envelope_id"
);

print_r($response);

set_envelope_expiration_date

Set envelope expiration date

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

Parameters

Name	Type	Required	Description
input	Models\SetEnvelopeExpirationRequest	✅	Set envelope expiration date
$envelopeId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\SetEnvelopeExpirationRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\SetEnvelopeExpirationRequest(
  expiresAt: 1
);

$response = $sdk->signplus->setEnvelopeExpirationDate(
  input: $input,
  envelopeId: "envelope_id"
);

print_r($response);

set_envelope_legality_level

Set envelope legality level

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

Parameters

Name	Type	Required	Description
input	Models\SetEnvelopeLegalityLevelRequest	✅	Set envelope legality level
$envelopeId	string	✅

Return Type Models\Envelope Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\EnvelopeLegalityLevel;
use Signplus\Models\SetEnvelopeLegalityLevelRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\SetEnvelopeLegalityLevelRequest(
  legalityLevel: $envelopeLegalityLevel
);

$response = $sdk->signplus->setEnvelopeLegalityLevel(
  input: $input,
  envelopeId: "envelope_id"
);

print_r($response);

get_envelope_annotations

Get envelope annotations

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

Parameters

Name	Type	Required	Description
$envelopeId	string	✅	ID of the envelope

Return Type array Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->getEnvelopeAnnotations(
  envelopeId: "envelope_id"
);

print_r($response);

get_envelope_document_annotations

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 Models\ListEnvelopeDocumentAnnotationsResponse Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->getEnvelopeDocumentAnnotations(
  envelopeId: "envelope_id",
  documentId: "document_id"
);

print_r($response);

add_envelope_annotation

Add envelope annotation

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

Parameters

Name	Type	Required	Description
input	Models\AddAnnotationRequest	✅	Add envelope annotation
$envelopeId	string	✅	ID of the envelope

Return Type Models\Annotation Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\AnnotationType;
use Signplus\Models\AnnotationSignature;
use Signplus\Models\AnnotationInitials;
use Signplus\Models\AnnotationText;
use Signplus\Models\AnnotationDateTime;
use Signplus\Models\AnnotationCheckbox;
use Signplus\Models\AddAnnotationRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$annotationType = Models\AnnotationType::Text;

$input = new Models\AddAnnotationRequest(
  recipientId: "recipient_id",
  documentId: "document_id",
  page: 2,
  x: 6.59,
  y: 2.19,
  width: 4.48,
  height: 7.11,
  required: true,
  type: $annotationType,
  signature: $annotationSignature,
  initials: $annotationInitials,
  text: $annotationText,
  datetime: $annotationDateTime,
  checkbox: $annotationCheckbox
);

$response = $sdk->signplus->addEnvelopeAnnotation(
  input: $input,
  envelopeId: "envelope_id"
);

print_r($response);

delete_envelope_annotation

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

Return Type mixed Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->deleteEnvelopeAnnotation(
  envelopeId: "envelope_id",
  annotationId: "annotation_id"
);

print_r($response);

create_template

Create new template

HTTP Method: POST
Endpoint: /template

Parameters

Name	Type	Required	Description
input	Models\CreateTemplateRequest	✅	Create new template

Return Type Models\Template Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\CreateTemplateRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\CreateTemplateRequest(
  name: "name"
);

$response = $sdk->signplus->createTemplate(
  input: $input
);

print_r($response);

list_templates

List templates

HTTP Method: POST
Endpoint: /templates

Parameters

Name	Type	Required	Description
input	Models\ListTemplatesRequest	❌	List templates

Return Type Models\ListTemplatesResponse Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\TemplateOrderField;
use Signplus\Models\ListTemplatesRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\ListTemplatesRequest(
  name: "name",
  tags: [],
  ids: [],
  first: 8,
  last: 10,
  after: "after",
  before: "before",
  orderField: $templateOrderField,
  ascending: true
);

$response = $sdk->signplus->listTemplates(
  input: $input
);

print_r($response);

get_template

Get template

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

Parameters

Name	Type	Required	Description
$templateId	string	✅

Return Type Models\Template Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->getTemplate(
  templateId: "template_id"
);

print_r($response);

delete_template

Delete template

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

Parameters

Name	Type	Required	Description
$templateId	string	✅

Return Type mixed Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->deleteTemplate(
  templateId: "template_id"
);

print_r($response);

duplicate_template

Duplicate template

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

Parameters

Name	Type	Required	Description
$templateId	string	✅

Return Type Models\Template Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->duplicateTemplate(
  templateId: "template_id"
);

print_r($response);

add_template_document

Add template document

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

Parameters

Name	Type	Required	Description
input	Models\AddTemplateDocumentRequest	✅	Add template document
$templateId	string	✅

Return Type Models\Document Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\AddTemplateDocumentRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\AddTemplateDocumentRequest(
  file: file
);

$response = $sdk->signplus->addTemplateDocument(
  input: $input,
  templateId: "template_id"
);

print_r($response);

get_template_document

Get template document

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

Parameters

Name	Type	Required	Description
$templateId	string	✅
$documentId	string	✅

Return Type Models\Document Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->getTemplateDocument(
  templateId: "template_id",
  documentId: "document_id"
);

print_r($response);

get_template_documents

Get template documents

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

Parameters

Name	Type	Required	Description
$templateId	string	✅

Return Type Models\ListTemplateDocumentsResponse Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->getTemplateDocuments(
  templateId: "template_id"
);

print_r($response);

add_template_signing_steps

Add template signing steps

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

Parameters

Name	Type	Required	Description
input	Models\AddTemplateSigningStepsRequest	✅	Add template signing steps
$templateId	string	✅

Return Type Models\Template Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\TemplateSigningStep;
use Signplus\Models\AddTemplateSigningStepsRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$templateSigningStep = new Models\TemplateSigningStep(
  recipients: []
);

$input = new Models\AddTemplateSigningStepsRequest(
  signingSteps: []
);

$response = $sdk->signplus->addTemplateSigningSteps(
  input: $input,
  templateId: "template_id"
);

print_r($response);

rename_template

Rename template

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

Parameters

Name	Type	Required	Description
input	Models\RenameTemplateRequest	✅	Rename template
$templateId	string	✅

Return Type Models\Template Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\RenameTemplateRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\RenameTemplateRequest(
  name: "name"
);

$response = $sdk->signplus->renameTemplate(
  input: $input,
  templateId: "template_id"
);

print_r($response);

set_template_comment

Set template comment

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

Parameters

Name	Type	Required	Description
input	Models\SetTemplateCommentRequest	✅	Set template comment
$templateId	string	✅

Return Type Models\Template Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\SetTemplateCommentRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\SetTemplateCommentRequest(
  comment: "comment"
);

$response = $sdk->signplus->setTemplateComment(
  input: $input,
  templateId: "template_id"
);

print_r($response);

set_template_notification

Set template notification

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

Parameters

Name	Type	Required	Description
input	Models\EnvelopeNotification	✅	Set template notification
$templateId	string	✅

Return Type Models\Template Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\EnvelopeNotification;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\EnvelopeNotification(
  subject: "subject",
  message: "message",
  reminderInterval: 123
);

$response = $sdk->signplus->setTemplateNotification(
  input: $input,
  templateId: "template_id"
);

print_r($response);

get_template_annotations

Get template annotations

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

Parameters

Name	Type	Required	Description
$templateId	string	✅	ID of the template

Return Type Models\ListTemplateAnnotationsResponse Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->getTemplateAnnotations(
  templateId: "template_id"
);

print_r($response);

get_document_template_annotations

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 Models\ListTemplateDocumentAnnotationsResponse Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->getDocumentTemplateAnnotations(
  templateId: "template_id",
  documentId: "document_id"
);

print_r($response);

add_template_annotation

Add template annotation

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

Parameters

Name	Type	Required	Description
input	Models\AddAnnotationRequest	✅	Add template annotation
$templateId	string	✅	ID of the template

Return Type Models\Annotation Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\AnnotationType;
use Signplus\Models\AnnotationSignature;
use Signplus\Models\AnnotationInitials;
use Signplus\Models\AnnotationText;
use Signplus\Models\AnnotationDateTime;
use Signplus\Models\AnnotationCheckbox;
use Signplus\Models\AddAnnotationRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$annotationType = Models\AnnotationType::Text;

$input = new Models\AddAnnotationRequest(
  recipientId: "recipient_id",
  documentId: "document_id",
  page: 2,
  x: 6.59,
  y: 2.19,
  width: 4.48,
  height: 7.11,
  required: true,
  type: $annotationType,
  signature: $annotationSignature,
  initials: $annotationInitials,
  text: $annotationText,
  datetime: $annotationDateTime,
  checkbox: $annotationCheckbox
);

$response = $sdk->signplus->addTemplateAnnotation(
  input: $input,
  templateId: "template_id"
);

print_r($response);

delete_template_annotation

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

Return Type mixed Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->deleteTemplateAnnotation(
  templateId: "template_id",
  annotationId: "annotation_id"
);

print_r($response);

set_template_attachments_settings

Set template attachment settings

HTTP Method: PUT
Endpoint: /template/{template_id}/attachments/settings

Parameters

Name	Type	Required	Description
input	Models\SetEnvelopeAttachmentsSettingsRequest	✅	Set template attachment settings
$templateId	string	✅

Return Type Models\EnvelopeAttachments Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\AttachmentSettings;
use Signplus\Models\SetEnvelopeAttachmentsSettingsRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$attachmentSettings = new Models\AttachmentSettings(
  visibleToRecipients: true
);

$input = new Models\SetEnvelopeAttachmentsSettingsRequest(
  settings: $attachmentSettings
);

$response = $sdk->signplus->setTemplateAttachmentsSettings(
  input: $input,
  templateId: "template_id"
);

print_r($response);

set_template_attachments_placeholders

Placeholders to be set, completely replacing the existing ones.

HTTP Method: PUT
Endpoint: /template/{template_id}/attachments/placeholders

Parameters

Name	Type	Required	Description
input	Models\SetEnvelopeAttachmentsPlaceholdersRequest	✅	Placeholders to be set, completely replacing the existing ones.
$templateId	string	✅

Return Type Models\EnvelopeAttachments Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\AttachmentPlaceholderRequest;
use Signplus\Models\SetEnvelopeAttachmentsPlaceholdersRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$attachmentPlaceholderRequest = new Models\AttachmentPlaceholderRequest(
  recipientId: "recipient_id",
  id: "id",
  name: "name",
  hint: "hint",
  required: true,
  multiple: true
);

$input = new Models\SetEnvelopeAttachmentsPlaceholdersRequest(
  placeholders: []
);

$response = $sdk->signplus->setTemplateAttachmentsPlaceholders(
  input: $input,
  templateId: "template_id"
);

print_r($response);

create_webhook

Create webhook

HTTP Method: POST
Endpoint: /webhook

Parameters

Name	Type	Required	Description
input	Models\CreateWebhookRequest	✅	Create webhook

Return Type Models\Webhook Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\WebhookEvent;
use Signplus\Models\CreateWebhookRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$webhookEvent = Models\WebhookEvent::EnvelopeExpired;

$input = new Models\CreateWebhookRequest(
  event: $webhookEvent,
  target: "target"
);

$response = $sdk->signplus->createWebhook(
  input: $input
);

print_r($response);

list_webhooks

List webhooks

HTTP Method: POST
Endpoint: /webhooks

Parameters

Name	Type	Required	Description
input	Models\ListWebhooksRequest	❌	List webhooks

Return Type Models\ListWebhooksResponse Example Usage Code Snippet

<?php

use Signplus\Client;
use Signplus\Models\WebhookEvent;
use Signplus\Models\ListWebhooksRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\ListWebhooksRequest(
  webhookId: "webhook_id",
  event: $webhookEvent
);

$response = $sdk->signplus->listWebhooks(
  input: $input
);

print_r($response);

delete_webhook

Delete webhook

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

Parameters

Name	Type	Required	Description
$webhookId	string	✅

Return Type mixed Example Usage Code Snippet

<?php

use Signplus\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->signplus->deleteWebhook(
  webhookId: "webhook_id"
);

print_r($response);

Models

SetEnvelopeAttachmentsPlaceholdersRequest

Properties

Name	Type	Required	Description
placeholders	array	✅

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	integer	❌	Number of pages in the document
pages	array	❌	List of pages in the document

CreateEnvelopeRequest

Properties

Name	Type	Required	Description
name	string	✅	Name of the envelope
legalityLevel	model	✅	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	integer	❌	Unix timestamp of the expiration date
comment	string	❌	Comment for the envelope
sandbox	boolean	❌	Whether the envelope is created in sandbox mode

ListEnvelopesRequest

Properties

Name	Type	Required	Description
name	string	❌	Name of the envelope
tags	array	❌	List of tags
comment	string	❌	Comment of the envelope
ids	array	❌	List of envelope IDs
statuses	array	❌	List of envelope statuses
folderIds	array	❌	List of folder IDs
onlyRootFolder	boolean	❌	Whether to only list envelopes in the root folder
dateFrom	integer	❌	Unix timestamp of the start date
dateTo	integer	❌	Unix timestamp of the end date
uid	string	❌	Unique identifier of the user
first	integer	❌
last	integer	❌
after	string	❌
before	string	❌
orderField	model	❌	Field to order envelopes by
ascending	boolean	❌	Whether to order envelopes in ascending order
includeTrash	boolean	❌	Whether to include envelopes in the trash

AttachmentPlaceholder

Properties

Name	Type	Required	Description
recipientId	string	❌	ID of the recipient
id	string	❌	ID of the attachment placeholder
name	string	❌	Name of the attachment placeholder
hint	string	❌	Hint of the attachment placeholder
required	boolean	❌	Whether the attachment placeholder is required
multiple	boolean	❌	Whether the attachment placeholder can have multiple files
files	array	❌

SetEnvelopeAttachmentsSettingsRequest

Properties

Name	Type	Required	Description
settings	model	✅

EnvelopeNotification

Properties

Name	Type	Required	Description
subject	string	❌	Subject of the notification
message	string	❌	Message of the notification
reminderInterval	integer	❌	Interval in days to send reminder

ListTemplatesRequest

Properties

Name	Type	Required	Description
name	string	❌	Name of the template
tags	array	❌	List of tag templates
ids	array	❌	List of templates IDs
first	integer	❌
last	integer	❌
after	string	❌
before	string	❌
orderField	model	❌	Field to order templates by
ascending	boolean	❌	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	integer	❌	Total number of pages in the template
legalityLevel	model	❌	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	integer	❌	Unix timestamp of the creation date
updatedAt	integer	❌	Unix timestamp of the last modification date
expirationDelay	integer	❌	Expiration delay added to the current time when an envelope is created from this template
numRecipients	integer	❌	Number of recipients in the envelope
signingSteps	array	❌
documents	array	❌
notification	model	❌
dynamicFields	array	❌	List of dynamic fields
attachments	model	❌

RecipientVerificationType

Type of verification the recipient must complete before accessing the envelope. - PASSCODE: requires a code to be entered. - SMS: sends a code via SMS. - ID_VERIFICATION: prompts the recipient to complete an automated ID and selfie check. Properties

Name	Type	Description
Sms	string	SMS
Passcode	string	PASSCODE
IdVerification	string	ID_VERIFICATION

AddEnvelopeSigningStepsRequest

Properties

Name	Type	Required	Description
signingSteps	array	❌	List of signing steps

AnnotationFontFamily

Font family of the text Properties

Name	Type	Description
Unknown	string	UNKNOWN
Serif	string	SERIF
Sans	string	SANS
Mono	string	MONO

AddTemplateSigningStepsRequest

Properties

Name	Type	Required	Description
signingSteps	array	✅	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	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	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	binary	❌	File to upload in binary format

ListWebhooksRequest

Properties

Name	Type	Required	Description
webhookId	string	❌	ID of the webhook
event	model	❌	Event of the webhook

SetEnvelopeLegalityLevelRequest

Properties

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

AttachmentPlaceholderFile

Properties

Name	Type	Required	Description
id	string	❌	ID of the file
name	string	❌	Name of the file
size	integer	❌	Size of the file in bytes
mimetype	string	❌	MIME type of the file

SetEnvelopeExpirationRequest

Properties

Name	Type	Required	Description
expiresAt	integer	✅	Unix timestamp of the expiration date

AnnotationText

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

Name	Type	Required	Description
size	number	❌	Font size of the text in pt
color	number	❌	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	model	❌

AnnotationCheckbox

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

Name	Type	Required	Description
checked	boolean	❌	Whether the checkbox is checked
style	model	❌	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	integer	❌	Total number of pages in the envelope
flowType	model	❌	Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
legalityLevel	model	❌	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	model	❌	Status of the envelope
createdAt	integer	❌	Unix timestamp of the creation date
updatedAt	integer	❌	Unix timestamp of the last modification date
expiresAt	integer	❌	Unix timestamp of the expiration date
numRecipients	integer	❌	Number of recipients in the envelope
isDuplicable	boolean	❌	Whether the envelope can be duplicated
signingSteps	array	❌
documents	array	❌
notification	model	❌
attachments	model	❌

AddTemplateDocumentRequest

Properties

Name	Type	Required	Description
file	binary	✅	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	model	❌	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	integer	✅	Page number where the annotation is placed
x	number	✅	X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
y	number	✅	Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
width	number	✅	Width of the annotation (in % of the page width from 0 to 100)
height	number	✅	Height of the annotation (in % of the page height from 0 to 100)
type	model	✅	Type of the annotation
recipientId	string	❌	ID of the recipient
required	boolean	❌
signature	model	❌	Signature annotation (null if annotation is not a signature)
initials	model	❌	Initials annotation (null if annotation is not initials)
text	model	❌	Text annotation (null if annotation is not a text)
datetime	model	❌	Date annotation (null if annotation is not a date)
checkbox	model	❌	Checkbox annotation (null if annotation is not a checkbox)

ListEnvelopeDocumentAnnotationsResponse

Properties

Name	Type	Required	Description
annotations	array	❌

EnvelopeStatus

Status of the envelope Properties

Name	Type	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	model	❌	Type of verification the recipient must complete before accessing the envelope. - `PASSCODE`: requires a code to be entered. - `SMS`: sends a code via SMS. - `ID_VERIFICATION`: prompts the recipient to complete an automated ID and selfie check.
value	string	❌	Required for `PASSCODE` and `SMS` verification. - `PASSCODE`: code required by the recipient to sign the document. - `SMS`: recipient’s phone number. - `ID_VERIFICATION`: leave empty.

AnnotationCheckboxStyle

Style of the checkbox Properties

Name	Type	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	array	❌	List of recipients

AnnotationDateTime

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

Name	Type	Required	Description
size	number	❌	Font size of the text in pt
font	model	❌
color	string	❌	Color of the text in hex format
autoFill	boolean	❌	Whether the date should be automatically filled
timezone	string	❌	Timezone of the date
timestamp	integer	❌	Unix timestamp of the date
format	model	❌	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)

AttachmentSettings

Properties

Name	Type	Required	Description
visibleToRecipients	boolean	❌	Whether the attachment is visible to the recipients

CreateTemplateRequest

Properties

Name	Type	Required	Description
name	string	✅

ListTemplateDocumentsResponse

Properties

Name	Type	Required	Description
documents	array	❌

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	model	❌	Font family of the text
italic	boolean	❌	Whether the text is italic
bold	boolean	❌	Whether the text is bold

AnnotationType

Type of the annotation Properties

Name	Type	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	model	❌	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	boolean	❌	Whether there is a next page
hasPreviousPage	boolean	❌	Whether there is a previous page
templates	array	❌

EnvelopeAttachments

Properties

Name	Type	Required	Description
settings	model	❌
recipients	array	❌

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	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	integer	❌	Page number where the annotation is placed
x	number	❌	X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
y	number	❌	Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
width	number	❌	Width of the annotation (in % of the page width from 0 to 100)
height	number	❌	Height of the annotation (in % of the page height from 0 to 100)
required	boolean	❌	Whether the annotation is required
type	model	❌	Type of the annotation
signature	model	❌	Signature annotation (null if annotation is not a signature)
initials	model	❌	Initials annotation (null if annotation is not initials)
text	model	❌	Text annotation (null if annotation is not a text)
datetime	model	❌	Date annotation (null if annotation is not a date)
checkbox	model	❌	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	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	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	Description
Signer	string	SIGNER
ReceivesCopy	string	RECEIVES_COPY
InPersonSigner	string	IN_PERSON_SIGNER
Sender	string	SENDER

AttachmentPlaceholderRequest

Properties

Name	Type	Required	Description
recipientId	string	✅	ID of the recipient
name	string	✅
required	boolean	✅	Whether the attachment placeholder is required
multiple	boolean	✅
id	string	❌	ID of the attachment placeholder
hint	string	❌	Hint of the attachment placeholder

SetEnvelopeDynamicFieldsRequest

Properties

Name	Type	Required	Description
dynamicFields	array	✅	List of dynamic fields

Page

Properties

Name	Type	Required	Description
width	integer	❌	Width of the page in pixels
height	integer	❌	Height of the page in pixels

TemplateSigningStep

Properties

Name	Type	Required	Description
recipients	array	❌	List of recipients

AttachmentPlaceholdersPerRecipient

Properties

Name	Type	Required	Description
recipientId	string	❌	ID of the recipient
recipientName	string	❌	Name of the recipient
placeholders	array	❌

ListEnvelopesResponse

Properties

Name	Type	Required	Description
hasNextPage	boolean	❌	Whether there is a next page
hasPreviousPage	boolean	❌	Whether there is a previous page
envelopes	array	❌

Recipient

Properties

Name	Type	Required	Description
name	string	✅	Name of the recipient
email	string	✅	Email of the recipient
role	model	✅	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	model	❌

WebhookEvent

Event of the webhook Properties

Name	Type	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	model	✅	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	boolean	❌	Whether the envelope is created in sandbox mode

ListTemplateAnnotationsResponse

Properties

Name	Type	Required	Description
annotations	array	❌

RenameEnvelopeRequest

Properties

Name	Type	Required	Description
name	string	❌	Name of the envelope

ListTemplateDocumentAnnotationsResponse

Properties

Name	Type	Required	Description
annotations	array	❌

ListEnvelopeDocumentsResponse

Properties

Name	Type	Required	Description
documents	array	❌

ListWebhooksResponse

Properties

Name	Type	Required	Description
webhooks	array	❌

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

​create_envelope

​create_envelope_from_template

​list_envelopes

​get_envelope

​delete_envelope

​download_envelope_signed_documents

​download_envelope_certificate

​get_envelope_document

​get_envelope_documents

​add_envelope_document

​set_envelope_dynamic_fields

​add_envelope_signing_steps

​set_envelope_attachments_settings

​set_envelope_attachments_placeholders

​get_attachment_file

​send_envelope

​duplicate_envelope

​void_envelope

​rename_envelope

​set_envelope_comment

​set_envelope_notification

​set_envelope_expiration_date

​set_envelope_legality_level

​get_envelope_annotations

​get_envelope_document_annotations

​add_envelope_annotation

​delete_envelope_annotation

​create_template

​list_templates

​get_template

​delete_template

​duplicate_template

​add_template_document

​get_template_document

​get_template_documents

​add_template_signing_steps

​rename_template

​set_template_comment

​set_template_notification

​get_template_annotations

​get_document_template_annotations

​add_template_annotation

​delete_template_annotation

​set_template_attachments_settings

​set_template_attachments_placeholders

​create_webhook

​list_webhooks

​delete_webhook

​Models

​SetEnvelopeAttachmentsPlaceholdersRequest

​Document

​CreateEnvelopeRequest

​ListEnvelopesRequest

​AttachmentPlaceholder

​SetEnvelopeAttachmentsSettingsRequest

​EnvelopeNotification

​ListTemplatesRequest

​SetTemplateCommentRequest

​Template

​RecipientVerificationType

​AddEnvelopeSigningStepsRequest

​AnnotationFontFamily

​AddTemplateSigningStepsRequest

​SetEnvelopeCommentRequest

​TemplateOrderField

​EnvelopeOrderField

​AddEnvelopeDocumentRequest

​ListWebhooksRequest

​SetEnvelopeLegalityLevelRequest

​AttachmentPlaceholderFile

​SetEnvelopeExpirationRequest

​AnnotationText

​AnnotationCheckbox

​Envelope

​AddTemplateDocumentRequest

create_envelope

create_envelope_from_template

list_envelopes

get_envelope

delete_envelope

download_envelope_signed_documents

download_envelope_certificate

get_envelope_document

get_envelope_documents

add_envelope_document

set_envelope_dynamic_fields

add_envelope_signing_steps

set_envelope_attachments_settings

set_envelope_attachments_placeholders

get_attachment_file

send_envelope

duplicate_envelope

void_envelope

rename_envelope

set_envelope_comment

set_envelope_notification

set_envelope_expiration_date

set_envelope_legality_level

get_envelope_annotations

get_envelope_document_annotations

add_envelope_annotation

delete_envelope_annotation

create_template

list_templates

get_template

delete_template

duplicate_template

add_template_document

get_template_document

get_template_documents

add_template_signing_steps

rename_template

set_template_comment

set_template_notification

get_template_annotations

get_document_template_annotations

add_template_annotation

delete_template_annotation

set_template_attachments_settings

set_template_attachments_placeholders

create_webhook

list_webhooks

delete_webhook

Models

SetEnvelopeAttachmentsPlaceholdersRequest

Document

CreateEnvelopeRequest

ListEnvelopesRequest

AttachmentPlaceholder

SetEnvelopeAttachmentsSettingsRequest

EnvelopeNotification

ListTemplatesRequest

SetTemplateCommentRequest

Template

RecipientVerificationType

AddEnvelopeSigningStepsRequest

AnnotationFontFamily

AddTemplateSigningStepsRequest

SetEnvelopeCommentRequest

TemplateOrderField

EnvelopeOrderField

AddEnvelopeDocumentRequest

ListWebhooksRequest

SetEnvelopeLegalityLevelRequest

AttachmentPlaceholderFile

SetEnvelopeExpirationRequest

AnnotationText

AnnotationCheckbox

Envelope

AddTemplateDocumentRequest

TemplateRecipient

AddAnnotationRequest

ListEnvelopeDocumentAnnotationsResponse

EnvelopeStatus

RecipientVerification