A list of all methods in the Signplus service. Click on the method name to view detailed information about that method.
MethodsDescription
create_envelopeCreate new envelope
create_envelope_from_templateCreate new envelope from template
list_envelopesList envelopes
get_envelopeGet envelope
delete_envelopeDelete envelope
get_envelope_documentGet envelope document
get_envelope_documentsGet envelope documents
add_envelope_documentAdd envelope document
set_envelope_dynamic_fieldsSet envelope dynamic fields
add_envelope_signing_stepsAdd envelope signing steps
send_envelopeSend envelope for signature
duplicate_envelopeDuplicate envelope
void_envelopeVoid envelope
rename_envelopeRename envelope
set_envelope_commentSet envelope comment
set_envelope_notificationSet envelope notification
set_envelope_expiration_dateSet envelope expiration date
set_envelope_legality_levelSet envelope legality level
get_envelope_annotationsGet envelope annotations
get_envelope_document_annotationsGet envelope document annotations
add_envelope_annotationAdd envelope annotation
delete_envelope_annotationDelete envelope annotation
create_templateCreate new template
list_templatesList templates
get_templateGet template
delete_templateDelete template
duplicate_templateDuplicate template
add_template_documentAdd template document
get_template_documentGet template document
get_template_documentsGet template documents
add_template_signing_stepsAdd template signing steps
rename_templateRename template
set_template_commentSet template comment
set_template_notificationSet template notification
get_template_annotationsGet template annotations
get_document_template_annotationsGet document template annotations
add_template_annotationAdd template annotation
delete_template_annotationDelete template annotation
create_webhookCreate webhook
list_webhooksList webhooks
delete_webhookDelete webhook

create_envelope

Create new envelope
  • HTTP Method: POST
  • Endpoint: /envelope
Parameters
NameTypeRequiredDescription
inputModels\CreateEnvelopeRequestCreate 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: 4,
  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
NameTypeRequiredDescription
inputModels\CreateEnvelopeFromTemplateRequestCreate new envelope from template
$templateIdstring
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
NameTypeRequiredDescription
inputModels\ListEnvelopesRequestList 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: 3,
  dateTo: 8,
  uid: "uid",
  first: 6,
  last: 9,
  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
NameTypeRequiredDescription
$envelopeIdstring
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
NameTypeRequiredDescription
$envelopeIdstring
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);

get_envelope_document

Get envelope document
  • HTTP Method: GET
  • Endpoint: /envelope/{envelope_id}/document/{document_id}
Parameters
NameTypeRequiredDescription
$envelopeIdstring
$documentIdstring
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
NameTypeRequiredDescription
$envelopeIdstring
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
NameTypeRequiredDescription
inputModels\AddEnvelopeDocumentRequestAdd envelope document
$envelopeIdstring
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
NameTypeRequiredDescription
inputModels\SetEnvelopeDynamicFieldsRequestSet envelope dynamic fields
$envelopeIdstring
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
NameTypeRequiredDescription
inputModels\AddEnvelopeSigningStepsRequestAdd envelope signing steps
$envelopeIdstring
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);

send_envelope

Send envelope for signature
  • HTTP Method: POST
  • Endpoint: /envelope/{envelope_id}/send
Parameters
NameTypeRequiredDescription
$envelopeIdstring
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
NameTypeRequiredDescription
$envelopeIdstring
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
NameTypeRequiredDescription
$envelopeIdstring
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
NameTypeRequiredDescription
inputModels\RenameEnvelopeRequestRename envelope
$envelopeIdstring
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
NameTypeRequiredDescription
inputModels\SetEnvelopeCommentRequestSet envelope comment
$envelopeIdstring
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
NameTypeRequiredDescription
inputModels\EnvelopeNotificationSet envelope notification
$envelopeIdstring
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: 1
);

$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
NameTypeRequiredDescription
inputModels\SetEnvelopeExpirationRequestSet envelope expiration date
$envelopeIdstring
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: 3
);

$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
NameTypeRequiredDescription
inputModels\SetEnvelopeLegalityLevelRequestSet envelope legality level
$envelopeIdstring
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
NameTypeRequiredDescription
$envelopeIdstringID 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
NameTypeRequiredDescription
$envelopeIdstringID of the envelope
$documentIdstringID 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
NameTypeRequiredDescription
inputModels\AddAnnotationRequestAdd envelope annotation
$envelopeIdstringID 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: 8,
  x: 7.12,
  y: 3.31,
  width: 0.84,
  height: 3.51,
  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
NameTypeRequiredDescription
$envelopeIdstringID of the envelope
$annotationIdstringID 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
NameTypeRequiredDescription
inputModels\CreateTemplateRequestCreate 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
NameTypeRequiredDescription
inputModels\ListTemplatesRequestList 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: 4,
  last: 123,
  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
NameTypeRequiredDescription
$templateIdstring
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
NameTypeRequiredDescription
$templateIdstring
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
NameTypeRequiredDescription
$templateIdstring
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
NameTypeRequiredDescription
inputModels\AddTemplateDocumentRequestAdd template document
$templateIdstring
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
NameTypeRequiredDescription
$templateIdstring
$documentIdstring
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
NameTypeRequiredDescription
$templateIdstring
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
NameTypeRequiredDescription
inputModels\AddTemplateSigningStepsRequestAdd template signing steps
$templateIdstring
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
NameTypeRequiredDescription
inputModels\RenameTemplateRequestRename template
$templateIdstring
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
NameTypeRequiredDescription
inputModels\SetTemplateCommentRequestSet template comment
$templateIdstring
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
NameTypeRequiredDescription
inputModels\EnvelopeNotificationSet template notification
$templateIdstring
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: 1
);

$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
NameTypeRequiredDescription
$templateIdstringID 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
NameTypeRequiredDescription
$templateIdstringID of the template
$documentIdstringID 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
NameTypeRequiredDescription
inputModels\AddAnnotationRequestAdd template annotation
$templateIdstringID 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: 8,
  x: 7.12,
  y: 3.31,
  width: 0.84,
  height: 3.51,
  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
NameTypeRequiredDescription
$templateIdstringID of the template
$annotationIdstringID 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);

create_webhook

Create webhook
  • HTTP Method: POST
  • Endpoint: /webhook
Parameters
NameTypeRequiredDescription
inputModels\CreateWebhookRequestCreate 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
NameTypeRequiredDescription
inputModels\ListWebhooksRequestList 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
NameTypeRequiredDescription
$webhookIdstring
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

Document

Properties
NameTypeRequiredDescription
idstringUnique identifier of the document
namestringName of the document
filenamestringFilename of the document
pageCountintegerNumber of pages in the document
pagesarrayList of pages in the document

CreateEnvelopeRequest

Properties
NameTypeRequiredDescription
namestringName of the envelope
legalityLevelmodelLegal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
expiresAtintegerUnix timestamp of the expiration date
commentstringComment for the envelope
sandboxbooleanWhether the envelope is created in sandbox mode

ListEnvelopesRequest

Properties
NameTypeRequiredDescription
namestringName of the envelope
tagsarrayList of tags
commentstringComment of the envelope
idsarrayList of envelope IDs
statusesarrayList of envelope statuses
folderIdsarrayList of folder IDs
onlyRootFolderbooleanWhether to only list envelopes in the root folder
dateFromintegerUnix timestamp of the start date
dateTointegerUnix timestamp of the end date
uidstringUnique identifier of the user
firstinteger
lastinteger
afterstring
beforestring
orderFieldmodelField to order envelopes by
ascendingbooleanWhether to order envelopes in ascending order
includeTrashbooleanWhether to include envelopes in the trash

EnvelopeNotification

Properties
NameTypeRequiredDescription
subjectstringSubject of the notification
messagestringMessage of the notification
reminderIntervalintegerInterval in days to send reminder

ListTemplatesRequest

Properties
NameTypeRequiredDescription
namestringName of the template
tagsarrayList of tag templates
idsarrayList of templates IDs
firstinteger
lastinteger
afterstring
beforestring
orderFieldmodelField to order templates by
ascendingbooleanWhether to order templates in ascending order

SetTemplateCommentRequest

Properties
NameTypeRequiredDescription
commentstringComment for the template

Template

Properties
NameTypeRequiredDescription
idstringUnique identifier of the template
namestringName of the template
commentstringComment for the template
pagesintegerTotal number of pages in the template
legalityLevelmodelLegal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
createdAtintegerUnix timestamp of the creation date
updatedAtintegerUnix timestamp of the last modification date
expirationDelayintegerExpiration delay added to the current time when an envelope is created from this template
numRecipientsintegerNumber of recipients in the envelope
signingStepsarray
documentsarray
notificationmodel
dynamicFieldsarrayList of dynamic fields

RecipientVerificationType

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

AddEnvelopeSigningStepsRequest

Properties
NameTypeRequiredDescription
signingStepsarrayList of signing steps

AnnotationFontFamily

Font family of the text Properties
NameTypeRequiredDescription
UnknownstringUNKNOWN
SerifstringSERIF
SansstringSANS
MonostringMONO

AddTemplateSigningStepsRequest

Properties
NameTypeRequiredDescription
signingStepsarrayList of signing steps

SetEnvelopeCommentRequest

Properties
NameTypeRequiredDescription
commentstringComment for the envelope

TemplateOrderField

Field to order templates by Properties
NameTypeRequiredDescription
TemplateIdstringTEMPLATE_ID
TemplateCreationDatestringTEMPLATE_CREATION_DATE
TemplateModificationDatestringTEMPLATE_MODIFICATION_DATE
TemplateNamestringTEMPLATE_NAME

EnvelopeOrderField

Field to order envelopes by Properties
NameTypeRequiredDescription
CreationDatestringCREATION_DATE
ModificationDatestringMODIFICATION_DATE
NamestringNAME
StatusstringSTATUS
LastDocumentChangestringLAST_DOCUMENT_CHANGE

AddEnvelopeDocumentRequest

Properties
NameTypeRequiredDescription
filebinaryFile to upload in binary format

ListWebhooksRequest

Properties
NameTypeRequiredDescription
webhookIdstringID of the webhook
eventmodelEvent of the webhook

SetEnvelopeLegalityLevelRequest

Properties
NameTypeRequiredDescription
legalityLevelmodelLegal 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
NameTypeRequiredDescription
expiresAtintegerUnix timestamp of the expiration date

AnnotationText

Text annotation (null if annotation is not a text) Properties
NameTypeRequiredDescription
sizenumberFont size of the text in pt
colornumberText color in 32bit representation
valuestringText content of the annotation
tooltipstringTooltip of the annotation
dynamicFieldNamestringName of the dynamic field
fontmodel

AnnotationCheckbox

Checkbox annotation (null if annotation is not a checkbox) Properties
NameTypeRequiredDescription
checkedbooleanWhether the checkbox is checked
stylemodelStyle of the checkbox

Envelope

Properties
NameTypeRequiredDescription
idstringUnique identifier of the envelope
namestringName of the envelope
commentstringComment for the envelope
pagesintegerTotal number of pages in the envelope
flowTypemodelFlow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
legalityLevelmodelLegal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
statusmodelStatus of the envelope
createdAtintegerUnix timestamp of the creation date
updatedAtintegerUnix timestamp of the last modification date
expiresAtintegerUnix timestamp of the expiration date
numRecipientsintegerNumber of recipients in the envelope
isDuplicablebooleanWhether the envelope can be duplicated
signingStepsarray
documentsarray
notificationmodel

AddTemplateDocumentRequest

Properties
NameTypeRequiredDescription
filebinaryFile to upload in binary format

TemplateRecipient

Properties
NameTypeRequiredDescription
idstringUnique identifier of the recipient
uidstringUnique identifier of the user associated with the recipient
namestringName of the recipient
emailstringEmail of the recipient
rolemodelRole 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
NameTypeRequiredDescription
documentIdstringID of the document
pageintegerPage number where the annotation is placed
xnumberX coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
ynumberY coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
widthnumberWidth of the annotation (in % of the page width from 0 to 100)
heightnumberHeight of the annotation (in % of the page height from 0 to 100)
typemodelType of the annotation
recipientIdstringID of the recipient
requiredboolean
signaturemodelSignature annotation (null if annotation is not a signature)
initialsmodelInitials annotation (null if annotation is not initials)
textmodelText annotation (null if annotation is not a text)
datetimemodelDate annotation (null if annotation is not a date)
checkboxmodelCheckbox annotation (null if annotation is not a checkbox)

ListEnvelopeDocumentAnnotationsResponse

Properties
NameTypeRequiredDescription
annotationsarray

EnvelopeStatus

Status of the envelope Properties
NameTypeRequiredDescription
DraftstringDRAFT
InProgressstringIN_PROGRESS
CompletedstringCOMPLETED
ExpiredstringEXPIRED
DeclinedstringDECLINED
VoidedstringVOIDED
PendingstringPENDING

RecipientVerification

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

AnnotationCheckboxStyle

Style of the checkbox Properties
NameTypeRequiredDescription
CircleCheckstringCIRCLE_CHECK
CircleFullstringCIRCLE_FULL
SquareCheckstringSQUARE_CHECK
SquareFullstringSQUARE_FULL
CheckMarkstringCHECK_MARK
TimesSquarestringTIMES_SQUARE

SigningStep

Properties
NameTypeRequiredDescription
recipientsarrayList of recipients

AnnotationDateTime

Date annotation (null if annotation is not a date) Properties
NameTypeRequiredDescription
sizenumberFont size of the text in pt
fontmodel
colorstringColor of the text in hex format
autoFillbooleanWhether the date should be automatically filled
timezonestringTimezone of the date
timestampintegerUnix timestamp of the date
formatmodelFormat 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
NameTypeRequiredDescription
namestring

ListTemplateDocumentsResponse

Properties
NameTypeRequiredDescription
documentsarray

AnnotationInitials

Initials annotation (null if annotation is not initials) Properties
NameTypeRequiredDescription
idstringUnique identifier of the annotation initials

AnnotationFont

Properties
NameTypeRequiredDescription
familymodelFont family of the text
italicbooleanWhether the text is italic
boldbooleanWhether the text is bold

AnnotationType

Type of the annotation Properties
NameTypeRequiredDescription
TextstringTEXT
SignaturestringSIGNATURE
InitialsstringINITIALS
CheckboxstringCHECKBOX
DatestringDATE

Webhook

Properties
NameTypeRequiredDescription
idstringUnique identifier of the webhook
eventmodelEvent of the webhook
targetstringTarget URL of the webhook

RenameTemplateRequest

Properties
NameTypeRequiredDescription
namestringName of the template

ListTemplatesResponse

Properties
NameTypeRequiredDescription
hasNextPagebooleanWhether there is a next page
hasPreviousPagebooleanWhether there is a previous page
templatesarray

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
NameTypeRequiredDescription
SignerstringSIGNER
ReceivesCopystringRECEIVES_COPY
InPersonSignerstringIN_PERSON_SIGNER

Annotation

Properties
NameTypeRequiredDescription
idstringUnique identifier of the annotation
recipientIdstringID of the recipient
documentIdstringID of the document
pageintegerPage number where the annotation is placed
xnumberX coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
ynumberY coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
widthnumberWidth of the annotation (in % of the page width from 0 to 100)
heightnumberHeight of the annotation (in % of the page height from 0 to 100)
requiredbooleanWhether the annotation is required
typemodelType of the annotation
signaturemodelSignature annotation (null if annotation is not a signature)
initialsmodelInitials annotation (null if annotation is not initials)
textmodelText annotation (null if annotation is not a text)
datetimemodelDate annotation (null if annotation is not a date)
checkboxmodelCheckbox annotation (null if annotation is not a checkbox)

DynamicField

Properties
NameTypeRequiredDescription
namestringName of the dynamic field
valuestringValue 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
NameTypeRequiredDescription
DmyNumericSlashstringDMY_NUMERIC_SLASH
MdyNumericSlashstringMDY_NUMERIC_SLASH
YmdNumericSlashstringYMD_NUMERIC_SLASH
DmyNumericDashShortstringDMY_NUMERIC_DASH_SHORT
DmyNumericDashstringDMY_NUMERIC_DASH
YmdNumericDashstringYMD_NUMERIC_DASH
MdyTextDashShortstringMDY_TEXT_DASH_SHORT
MdyTextSpaceShortstringMDY_TEXT_SPACE_SHORT
MdyTextSpacestringMDY_TEXT_SPACE

EnvelopeFlowType

Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow) Properties
NameTypeRequiredDescription
RequestSignaturestringREQUEST_SIGNATURE
SignMyselfstringSIGN_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
NameTypeRequiredDescription
SesstringSES
QesEidasstringQES_EIDAS
QesZertesstringQES_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
NameTypeRequiredDescription
SignerstringSIGNER
ReceivesCopystringRECEIVES_COPY
InPersonSignerstringIN_PERSON_SIGNER

SetEnvelopeDynamicFieldsRequest

Properties
NameTypeRequiredDescription
dynamicFieldsarrayList of dynamic fields

Page

Properties
NameTypeRequiredDescription
widthintegerWidth of the page in pixels
heightintegerHeight of the page in pixels

TemplateSigningStep

Properties
NameTypeRequiredDescription
recipientsarrayList of recipients

ListEnvelopesResponse

Properties
NameTypeRequiredDescription
hasNextPagebooleanWhether there is a next page
hasPreviousPagebooleanWhether there is a previous page
envelopesarray

Recipient

Properties
NameTypeRequiredDescription
namestringName of the recipient
emailstringEmail of the recipient
rolemodelRole 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)
idstringUnique identifier of the recipient
uidstringUnique identifier of the user associated with the recipient
verificationmodel

WebhookEvent

Event of the webhook Properties
NameTypeRequiredDescription
EnvelopeExpiredstringENVELOPE_EXPIRED
EnvelopeDeclinedstringENVELOPE_DECLINED
EnvelopeVoidedstringENVELOPE_VOIDED
EnvelopeCompletedstringENVELOPE_COMPLETED
EnvelopeAuditTrailstringENVELOPE_AUDIT_TRAIL

CreateWebhookRequest

Properties
NameTypeRequiredDescription
eventmodelEvent of the webhook
targetstringURL of the webhook target

CreateEnvelopeFromTemplateRequest

Properties
NameTypeRequiredDescription
namestringName of the envelope
commentstringComment for the envelope
sandboxbooleanWhether the envelope is created in sandbox mode

ListTemplateAnnotationsResponse

Properties
NameTypeRequiredDescription
annotationsarray

RenameEnvelopeRequest

Properties
NameTypeRequiredDescription
namestringName of the envelope

ListTemplateDocumentAnnotationsResponse

Properties
NameTypeRequiredDescription
annotationsarray

ListEnvelopeDocumentsResponse

Properties
NameTypeRequiredDescription
documentsarray

ListWebhooksResponse

Properties
NameTypeRequiredDescription
webhooksarray

AnnotationSignature

Signature annotation (null if annotation is not a signature) Properties
NameTypeRequiredDescription
idstringUnique identifier of the annotation signature