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 |
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 |
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 |
create_webhook | Create webhook |
list_webhooks | List webhooks |
delete_webhook | Delete webhook |
POST
/envelope
Name | Type | Required | Description |
---|---|---|---|
input | Models\CreateEnvelopeRequest | ✅ | Create new envelope |
Models\Envelope
Example Usage Code Snippet
POST
/envelope/from_template/{template_id}
Name | Type | Required | Description |
---|---|---|---|
input | Models\CreateEnvelopeFromTemplateRequest | ✅ | Create new envelope from template |
$templateId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
POST
/envelopes
Name | Type | Required | Description |
---|---|---|---|
input | Models\ListEnvelopesRequest | ❌ | List envelopes |
Models\ListEnvelopesResponse
Example Usage Code Snippet
GET
/envelope/{envelope_id}
Name | Type | Required | Description |
---|---|---|---|
$envelopeId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
DELETE
/envelope/{envelope_id}
Name | Type | Required | Description |
---|---|---|---|
$envelopeId | string | ✅ |
mixed
Example Usage Code Snippet
GET
/envelope/{envelope_id}/document/{document_id}
Name | Type | Required | Description |
---|---|---|---|
$envelopeId | string | ✅ | |
$documentId | string | ✅ |
Models\Document
Example Usage Code Snippet
GET
/envelope/{envelope_id}/documents
Name | Type | Required | Description |
---|---|---|---|
$envelopeId | string | ✅ |
Models\ListEnvelopeDocumentsResponse
Example Usage Code Snippet
POST
/envelope/{envelope_id}/document
Name | Type | Required | Description |
---|---|---|---|
input | Models\AddEnvelopeDocumentRequest | ✅ | Add envelope document |
$envelopeId | string | ✅ |
Models\Document
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/dynamic_fields
Name | Type | Required | Description |
---|---|---|---|
input | Models\SetEnvelopeDynamicFieldsRequest | ✅ | Set envelope dynamic fields |
$envelopeId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
POST
/envelope/{envelope_id}/signing_steps
Name | Type | Required | Description |
---|---|---|---|
input | Models\AddEnvelopeSigningStepsRequest | ✅ | Add envelope signing steps |
$envelopeId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
POST
/envelope/{envelope_id}/send
Name | Type | Required | Description |
---|---|---|---|
$envelopeId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
POST
/envelope/{envelope_id}/duplicate
Name | Type | Required | Description |
---|---|---|---|
$envelopeId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/void
Name | Type | Required | Description |
---|---|---|---|
$envelopeId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/rename
Name | Type | Required | Description |
---|---|---|---|
input | Models\RenameEnvelopeRequest | ✅ | Rename envelope |
$envelopeId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/set_comment
Name | Type | Required | Description |
---|---|---|---|
input | Models\SetEnvelopeCommentRequest | ✅ | Set envelope comment |
$envelopeId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/set_notification
Name | Type | Required | Description |
---|---|---|---|
input | Models\EnvelopeNotification | ✅ | Set envelope notification |
$envelopeId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/set_expiration_date
Name | Type | Required | Description |
---|---|---|---|
input | Models\SetEnvelopeExpirationRequest | ✅ | Set envelope expiration date |
$envelopeId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/set_legality_level
Name | Type | Required | Description |
---|---|---|---|
input | Models\SetEnvelopeLegalityLevelRequest | ✅ | Set envelope legality level |
$envelopeId | string | ✅ |
Models\Envelope
Example Usage Code Snippet
GET
/envelope/{envelope_id}/annotations
Name | Type | Required | Description |
---|---|---|---|
$envelopeId | string | ✅ | ID of the envelope |
array
Example Usage Code Snippet
GET
/envelope/{envelope_id}/annotations/{document_id}
Name | Type | Required | Description |
---|---|---|---|
$envelopeId | string | ✅ | ID of the envelope |
$documentId | string | ✅ | ID of document |
Models\ListEnvelopeDocumentAnnotationsResponse
Example Usage Code Snippet
POST
/envelope/{envelope_id}/annotation
Name | Type | Required | Description |
---|---|---|---|
input | Models\AddAnnotationRequest | ✅ | Add envelope annotation |
$envelopeId | string | ✅ | ID of the envelope |
Models\Annotation
Example Usage Code Snippet
DELETE
/envelope/{envelope_id}/annotation/{annotation_id}
Name | Type | Required | Description |
---|---|---|---|
$envelopeId | string | ✅ | ID of the envelope |
$annotationId | string | ✅ | ID of the annotation to delete |
mixed
Example Usage Code Snippet
POST
/template
Name | Type | Required | Description |
---|---|---|---|
input | Models\CreateTemplateRequest | ✅ | Create new template |
Models\Template
Example Usage Code Snippet
POST
/templates
Name | Type | Required | Description |
---|---|---|---|
input | Models\ListTemplatesRequest | ❌ | List templates |
Models\ListTemplatesResponse
Example Usage Code Snippet
GET
/template/{template_id}
Name | Type | Required | Description |
---|---|---|---|
$templateId | string | ✅ |
Models\Template
Example Usage Code Snippet
DELETE
/template/{template_id}
Name | Type | Required | Description |
---|---|---|---|
$templateId | string | ✅ |
mixed
Example Usage Code Snippet
POST
/template/{template_id}/duplicate
Name | Type | Required | Description |
---|---|---|---|
$templateId | string | ✅ |
Models\Template
Example Usage Code Snippet
POST
/template/{template_id}/document
Name | Type | Required | Description |
---|---|---|---|
input | Models\AddTemplateDocumentRequest | ✅ | Add template document |
$templateId | string | ✅ |
Models\Document
Example Usage Code Snippet
GET
/template/{template_id}/document/{document_id}
Name | Type | Required | Description |
---|---|---|---|
$templateId | string | ✅ | |
$documentId | string | ✅ |
Models\Document
Example Usage Code Snippet
GET
/template/{template_id}/documents
Name | Type | Required | Description |
---|---|---|---|
$templateId | string | ✅ |
Models\ListTemplateDocumentsResponse
Example Usage Code Snippet
POST
/template/{template_id}/signing_steps
Name | Type | Required | Description |
---|---|---|---|
input | Models\AddTemplateSigningStepsRequest | ✅ | Add template signing steps |
$templateId | string | ✅ |
Models\Template
Example Usage Code Snippet
PUT
/template/{template_id}/rename
Name | Type | Required | Description |
---|---|---|---|
input | Models\RenameTemplateRequest | ✅ | Rename template |
$templateId | string | ✅ |
Models\Template
Example Usage Code Snippet
PUT
/template/{template_id}/set_comment
Name | Type | Required | Description |
---|---|---|---|
input | Models\SetTemplateCommentRequest | ✅ | Set template comment |
$templateId | string | ✅ |
Models\Template
Example Usage Code Snippet
PUT
/template/{template_id}/set_notification
Name | Type | Required | Description |
---|---|---|---|
input | Models\EnvelopeNotification | ✅ | Set template notification |
$templateId | string | ✅ |
Models\Template
Example Usage Code Snippet
GET
/template/{template_id}/annotations
Name | Type | Required | Description |
---|---|---|---|
$templateId | string | ✅ | ID of the template |
Models\ListTemplateAnnotationsResponse
Example Usage Code Snippet
GET
/template/{template_id}/annotations/{document_id}
Name | Type | Required | Description |
---|---|---|---|
$templateId | string | ✅ | ID of the template |
$documentId | string | ✅ | ID of document |
Models\ListTemplateDocumentAnnotationsResponse
Example Usage Code Snippet
POST
/template/{template_id}/annotation
Name | Type | Required | Description |
---|---|---|---|
input | Models\AddAnnotationRequest | ✅ | Add template annotation |
$templateId | string | ✅ | ID of the template |
Models\Annotation
Example Usage Code Snippet
DELETE
/template/{template_id}/annotation/{annotation_id}
Name | Type | Required | Description |
---|---|---|---|
$templateId | string | ✅ | ID of the template |
$annotationId | string | ✅ | ID of the annotation to delete |
mixed
Example Usage Code Snippet
POST
/webhook
Name | Type | Required | Description |
---|---|---|---|
input | Models\CreateWebhookRequest | ✅ | Create webhook |
Models\Webhook
Example Usage Code Snippet
POST
/webhooks
Name | Type | Required | Description |
---|---|---|---|
input | Models\ListWebhooksRequest | ❌ | List webhooks |
Models\ListWebhooksResponse
Example Usage Code Snippet
DELETE
/webhook/{webhook_id}
Name | Type | Required | Description |
---|---|---|---|
$webhookId | string | ✅ |
mixed
Example Usage Code Snippet
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 |
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 |
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 |
Name | Type | Required | Description |
---|---|---|---|
subject | string | ❌ | Subject of the notification |
message | string | ❌ | Message of the notification |
reminderInterval | integer | ❌ | Interval in days to send reminder |
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 |
Name | Type | Required | Description |
---|---|---|---|
comment | string | ✅ | Comment for the template |
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 |
Name | Type | Required | Description |
---|---|---|---|
Sms | string | SMS | |
Passcode | string | PASSCODE |
Name | Type | Required | Description |
---|---|---|---|
signingSteps | array | ❌ | List of signing steps |
Name | Type | Required | Description |
---|---|---|---|
Unknown | string | UNKNOWN | |
Serif | string | SERIF | |
Sans | string | SANS | |
Mono | string | MONO |
Name | Type | Required | Description |
---|---|---|---|
signingSteps | array | ✅ | List of signing steps |
Name | Type | Required | Description |
---|---|---|---|
comment | string | ✅ | Comment for the envelope |
Name | Type | Required | Description |
---|---|---|---|
TemplateId | string | TEMPLATE_ID | |
TemplateCreationDate | string | TEMPLATE_CREATION_DATE | |
TemplateModificationDate | string | TEMPLATE_MODIFICATION_DATE | |
TemplateName | string | TEMPLATE_NAME |
Name | Type | Required | Description |
---|---|---|---|
CreationDate | string | CREATION_DATE | |
ModificationDate | string | MODIFICATION_DATE | |
Name | string | NAME | |
Status | string | STATUS | |
LastDocumentChange | string | LAST_DOCUMENT_CHANGE |
Name | Type | Required | Description |
---|---|---|---|
file | binary | ❌ | File to upload in binary format |
Name | Type | Required | Description |
---|---|---|---|
webhookId | string | ❌ | ID of the webhook |
event | model | ❌ | Event of the webhook |
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) |
Name | Type | Required | Description |
---|---|---|---|
expiresAt | integer | ✅ | Unix timestamp of the expiration date |
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 | ❌ |
Name | Type | Required | Description |
---|---|---|---|
checked | boolean | ❌ | Whether the checkbox is checked |
style | model | ❌ | Style of the checkbox |
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 | ❌ |
Name | Type | Required | Description |
---|---|---|---|
file | binary | ✅ | File to upload in binary format |
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 |
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) |
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) |
Name | Type | Required | Description |
---|---|---|---|
annotations | array | ❌ |
Name | Type | Required | Description |
---|---|---|---|
Draft | string | DRAFT | |
InProgress | string | IN_PROGRESS | |
Completed | string | COMPLETED | |
Expired | string | EXPIRED | |
Declined | string | DECLINED | |
Voided | string | VOIDED | |
Pending | string | PENDING |
Name | Type | Required | Description |
---|---|---|---|
type | model | ❌ | Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered) |
value | string | ❌ |
Name | Type | Required | Description |
---|---|---|---|
CircleCheck | string | CIRCLE_CHECK | |
CircleFull | string | CIRCLE_FULL | |
SquareCheck | string | SQUARE_CHECK | |
SquareFull | string | SQUARE_FULL | |
CheckMark | string | CHECK_MARK | |
TimesSquare | string | TIMES_SQUARE |
Name | Type | Required | Description |
---|---|---|---|
recipients | array | ❌ | List of recipients |
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) |
Name | Type | Required | Description |
---|---|---|---|
name | string | ✅ |
Name | Type | Required | Description |
---|---|---|---|
documents | array | ❌ |
Name | Type | Required | Description |
---|---|---|---|
id | string | ❌ | Unique identifier of the annotation initials |
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 |
Name | Type | Required | Description |
---|---|---|---|
Text | string | TEXT | |
Signature | string | SIGNATURE | |
Initials | string | INITIALS | |
Checkbox | string | CHECKBOX | |
Date | string | DATE |
Name | Type | Required | Description |
---|---|---|---|
id | string | ❌ | Unique identifier of the webhook |
event | model | ❌ | Event of the webhook |
target | string | ❌ | Target URL of the webhook |
Name | Type | Required | Description |
---|---|---|---|
name | string | ✅ | Name of the template |
Name | Type | Required | Description |
---|---|---|---|
hasNextPage | boolean | ❌ | Whether there is a next page |
hasPreviousPage | boolean | ❌ | Whether there is a previous page |
templates | array | ❌ |
Name | Type | Required | Description |
---|---|---|---|
Signer | string | SIGNER | |
ReceivesCopy | string | RECEIVES_COPY | |
InPersonSigner | string | IN_PERSON_SIGNER |
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) |
Name | Type | Required | Description |
---|---|---|---|
name | string | ❌ | Name of the dynamic field |
value | string | ❌ | Value of the dynamic field |
Name | Type | Required | Description |
---|---|---|---|
DmyNumericSlash | string | DMY_NUMERIC_SLASH | |
MdyNumericSlash | string | MDY_NUMERIC_SLASH | |
YmdNumericSlash | string | YMD_NUMERIC_SLASH | |
DmyNumericDashShort | string | DMY_NUMERIC_DASH_SHORT | |
DmyNumericDash | string | DMY_NUMERIC_DASH | |
YmdNumericDash | string | YMD_NUMERIC_DASH | |
MdyTextDashShort | string | MDY_TEXT_DASH_SHORT | |
MdyTextSpaceShort | string | MDY_TEXT_SPACE_SHORT | |
MdyTextSpace | string | MDY_TEXT_SPACE |
Name | Type | Required | Description |
---|---|---|---|
RequestSignature | string | REQUEST_SIGNATURE | |
SignMyself | string | SIGN_MYSELF |
Name | Type | Required | Description |
---|---|---|---|
Ses | string | SES | |
QesEidas | string | QES_EIDAS | |
QesZertes | string | QES_ZERTES |
Name | Type | Required | Description |
---|---|---|---|
Signer | string | SIGNER | |
ReceivesCopy | string | RECEIVES_COPY | |
InPersonSigner | string | IN_PERSON_SIGNER |
Name | Type | Required | Description |
---|---|---|---|
dynamicFields | array | ✅ | List of dynamic fields |
Name | Type | Required | Description |
---|---|---|---|
width | integer | ❌ | Width of the page in pixels |
height | integer | ❌ | Height of the page in pixels |
Name | Type | Required | Description |
---|---|---|---|
recipients | array | ❌ | List of recipients |
Name | Type | Required | Description |
---|---|---|---|
hasNextPage | boolean | ❌ | Whether there is a next page |
hasPreviousPage | boolean | ❌ | Whether there is a previous page |
envelopes | array | ❌ |
Name | Type | Required | Description |
---|---|---|---|
name | string | ✅ | Name of the recipient |
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 | ❌ |
Name | Type | Required | Description |
---|---|---|---|
EnvelopeExpired | string | ENVELOPE_EXPIRED | |
EnvelopeDeclined | string | ENVELOPE_DECLINED | |
EnvelopeVoided | string | ENVELOPE_VOIDED | |
EnvelopeCompleted | string | ENVELOPE_COMPLETED | |
EnvelopeAuditTrail | string | ENVELOPE_AUDIT_TRAIL |
Name | Type | Required | Description |
---|---|---|---|
event | model | ✅ | Event of the webhook |
target | string | ✅ | URL of the webhook target |
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 |
Name | Type | Required | Description |
---|---|---|---|
annotations | array | ❌ |
Name | Type | Required | Description |
---|---|---|---|
name | string | ❌ | Name of the envelope |
Name | Type | Required | Description |
---|---|---|---|
annotations | array | ❌ |
Name | Type | Required | Description |
---|---|---|---|
documents | array | ❌ |
Name | Type | Required | Description |
---|---|---|---|
webhooks | array | ❌ |
Name | Type | Required | Description |
---|---|---|---|
id | string | ❌ | Unique identifier of the annotation signature |