SignplusService
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 |
---|---|---|---|
request_body | CreateEnvelopeRequest | ✅ | The request body. |
Envelope
Example Usage Code Snippet
POST
/envelope/from_template/{template_id}
Name | Type | Required | Description |
---|---|---|---|
request_body | CreateEnvelopeFromTemplateRequest | ✅ | The request body. |
template_id | str | ✅ |
Envelope
Example Usage Code Snippet
POST
/envelopes
Name | Type | Required | Description |
---|---|---|---|
request_body | ListEnvelopesRequest | ❌ | The request body. |
ListEnvelopesResponse
Example Usage Code Snippet
GET
/envelope/{envelope_id}
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ✅ |
Envelope
Example Usage Code Snippet
DELETE
/envelope/{envelope_id}
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ✅ |
GET
/envelope/{envelope_id}/document/{document_id}
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ✅ | |
document_id | str | ✅ |
Document
Example Usage Code Snippet
GET
/envelope/{envelope_id}/documents
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ✅ |
ListEnvelopeDocumentsResponse
Example Usage Code Snippet
POST
/envelope/{envelope_id}/document
Name | Type | Required | Description |
---|---|---|---|
request_body | AddEnvelopeDocumentRequest | ✅ | The request body. |
envelope_id | str | ✅ |
Document
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/dynamic_fields
Name | Type | Required | Description |
---|---|---|---|
request_body | SetEnvelopeDynamicFieldsRequest | ✅ | The request body. |
envelope_id | str | ✅ |
Envelope
Example Usage Code Snippet
POST
/envelope/{envelope_id}/signing_steps
Name | Type | Required | Description |
---|---|---|---|
request_body | AddEnvelopeSigningStepsRequest | ✅ | The request body. |
envelope_id | str | ✅ |
Envelope
Example Usage Code Snippet
POST
/envelope/{envelope_id}/send
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ✅ |
Envelope
Example Usage Code Snippet
POST
/envelope/{envelope_id}/duplicate
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ✅ |
Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/void
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ✅ |
Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/rename
Name | Type | Required | Description |
---|---|---|---|
request_body | RenameEnvelopeRequest | ✅ | The request body. |
envelope_id | str | ✅ |
Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/set_comment
Name | Type | Required | Description |
---|---|---|---|
request_body | SetEnvelopeCommentRequest | ✅ | The request body. |
envelope_id | str | ✅ |
Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/set_notification
Name | Type | Required | Description |
---|---|---|---|
request_body | EnvelopeNotification | ✅ | The request body. |
envelope_id | str | ✅ |
Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/set_expiration_date
Name | Type | Required | Description |
---|---|---|---|
request_body | SetEnvelopeExpirationRequest | ✅ | The request body. |
envelope_id | str | ✅ |
Envelope
Example Usage Code Snippet
PUT
/envelope/{envelope_id}/set_legality_level
Name | Type | Required | Description |
---|---|---|---|
request_body | SetEnvelopeLegalityLevelRequest | ✅ | The request body. |
envelope_id | str | ✅ |
Envelope
Example Usage Code Snippet
GET
/envelope/{envelope_id}/annotations
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ✅ | ID of the envelope |
List[Annotation]
Example Usage Code Snippet
GET
/envelope/{envelope_id}/annotations/{document_id}
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ✅ | ID of the envelope |
document_id | str | ✅ | ID of document |
ListEnvelopeDocumentAnnotationsResponse
Example Usage Code Snippet
POST
/envelope/{envelope_id}/annotation
Name | Type | Required | Description |
---|---|---|---|
request_body | AddAnnotationRequest | ✅ | The request body. |
envelope_id | str | ✅ | ID of the envelope |
Annotation
Example Usage Code Snippet
DELETE
/envelope/{envelope_id}/annotation/{annotation_id}
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ✅ | ID of the envelope |
annotation_id | str | ✅ | ID of the annotation to delete |
POST
/template
Name | Type | Required | Description |
---|---|---|---|
request_body | CreateTemplateRequest | ✅ | The request body. |
Template
Example Usage Code Snippet
POST
/templates
Name | Type | Required | Description |
---|---|---|---|
request_body | ListTemplatesRequest | ❌ | The request body. |
ListTemplatesResponse
Example Usage Code Snippet
GET
/template/{template_id}
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ✅ |
Template
Example Usage Code Snippet
DELETE
/template/{template_id}
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ✅ |
POST
/template/{template_id}/duplicate
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ✅ |
Template
Example Usage Code Snippet
POST
/template/{template_id}/document
Name | Type | Required | Description |
---|---|---|---|
request_body | AddTemplateDocumentRequest | ✅ | The request body. |
template_id | str | ✅ |
Document
Example Usage Code Snippet
GET
/template/{template_id}/document/{document_id}
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ✅ | |
document_id | str | ✅ |
Document
Example Usage Code Snippet
GET
/template/{template_id}/documents
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ✅ |
ListTemplateDocumentsResponse
Example Usage Code Snippet
POST
/template/{template_id}/signing_steps
Name | Type | Required | Description |
---|---|---|---|
request_body | AddTemplateSigningStepsRequest | ✅ | The request body. |
template_id | str | ✅ |
Template
Example Usage Code Snippet
PUT
/template/{template_id}/rename
Name | Type | Required | Description |
---|---|---|---|
request_body | RenameTemplateRequest | ✅ | The request body. |
template_id | str | ✅ |
Template
Example Usage Code Snippet
PUT
/template/{template_id}/set_comment
Name | Type | Required | Description |
---|---|---|---|
request_body | SetTemplateCommentRequest | ✅ | The request body. |
template_id | str | ✅ |
Template
Example Usage Code Snippet
PUT
/template/{template_id}/set_notification
Name | Type | Required | Description |
---|---|---|---|
request_body | EnvelopeNotification | ✅ | The request body. |
template_id | str | ✅ |
Template
Example Usage Code Snippet
GET
/template/{template_id}/annotations
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ✅ | ID of the template |
ListTemplateAnnotationsResponse
Example Usage Code Snippet
GET
/template/{template_id}/annotations/{document_id}
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ✅ | ID of the template |
document_id | str | ✅ | ID of document |
ListTemplateDocumentAnnotationsResponse
Example Usage Code Snippet
POST
/template/{template_id}/annotation
Name | Type | Required | Description |
---|---|---|---|
request_body | AddAnnotationRequest | ✅ | The request body. |
template_id | str | ✅ | ID of the template |
Annotation
Example Usage Code Snippet
DELETE
/template/{template_id}/annotation/{annotation_id}
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ✅ | ID of the template |
annotation_id | str | ✅ | ID of the annotation to delete |
POST
/webhook
Name | Type | Required | Description |
---|---|---|---|
request_body | CreateWebhookRequest | ✅ | The request body. |
Webhook
Example Usage Code Snippet
POST
/webhooks
Name | Type | Required | Description |
---|---|---|---|
request_body | ListWebhooksRequest | ❌ | The request body. |
ListWebhooksResponse
Example Usage Code Snippet
DELETE
/webhook/{webhook_id}
Name | Type | Required | Description |
---|---|---|---|
webhook_id | str | ✅ |
Name | Type | Required | Description |
---|---|---|---|
id_ | str | ❌ | Unique identifier of the document |
name | str | ❌ | Name of the document |
filename | str | ❌ | Filename of the document |
page_count | int | ❌ | Number of pages in the document |
pages | List[Page] | ❌ | List of pages in the document |
Name | Type | Required | Description |
---|---|---|---|
name | str | ✅ | Name of the envelope |
legality_level | 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) |
expires_at | int | ❌ | Unix timestamp of the expiration date |
comment | str | ❌ | Comment for the envelope |
sandbox | bool | ❌ | Whether the envelope is created in sandbox mode |
Name | Type | Required | Description |
---|---|---|---|
name | str | ❌ | Name of the envelope |
tags | List[str] | ❌ | List of tags |
comment | str | ❌ | Comment of the envelope |
ids | List[str] | ❌ | List of envelope IDs |
statuses | List[EnvelopeStatus] | ❌ | List of envelope statuses |
folder_ids | List[str] | ❌ | List of folder IDs |
only_root_folder | bool | ❌ | Whether to only list envelopes in the root folder |
date_from | int | ❌ | Unix timestamp of the start date |
date_to | int | ❌ | Unix timestamp of the end date |
uid | str | ❌ | Unique identifier of the user |
first | int | ❌ | |
last | int | ❌ | |
after | str | ❌ | |
before | str | ❌ | |
order_field | EnvelopeOrderField | ❌ | Field to order envelopes by |
ascending | bool | ❌ | Whether to order envelopes in ascending order |
include_trash | bool | ❌ | Whether to include envelopes in the trash |
Name | Type | Required | Description |
---|---|---|---|
subject | str | ❌ | Subject of the notification |
message | str | ❌ | Message of the notification |
reminder_interval | int | ❌ | Interval in days to send reminder |
Name | Type | Required | Description |
---|---|---|---|
name | str | ❌ | Name of the template |
tags | List[str] | ❌ | List of tag templates |
ids | List[str] | ❌ | List of templates IDs |
first | int | ❌ | |
last | int | ❌ | |
after | str | ❌ | |
before | str | ❌ | |
order_field | TemplateOrderField | ❌ | Field to order templates by |
ascending | bool | ❌ | Whether to order templates in ascending order |
Name | Type | Required | Description |
---|---|---|---|
comment | str | ✅ | Comment for the template |
Name | Type | Required | Description |
---|---|---|---|
id_ | str | ❌ | Unique identifier of the template |
name | str | ❌ | Name of the template |
comment | str | ❌ | Comment for the template |
pages | int | ❌ | Total number of pages in the template |
legality_level | 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) |
created_at | int | ❌ | Unix timestamp of the creation date |
updated_at | int | ❌ | Unix timestamp of the last modification date |
expiration_delay | int | ❌ | Expiration delay added to the current time when an envelope is created from this template |
num_recipients | int | ❌ | Number of recipients in the envelope |
signing_steps | List[TemplateSigningStep] | ❌ | |
documents | List[Document] | ❌ | |
notification | EnvelopeNotification | ❌ | |
dynamic_fields | List[str] | ❌ | List of dynamic fields |
Name | Type | Required | Description |
---|---|---|---|
SMS | str | ✅ | “SMS” |
PASSCODE | str | ✅ | “PASSCODE” |
Name | Type | Required | Description |
---|---|---|---|
signing_steps | List[SigningStep] | ❌ | List of signing steps |
Name | Type | Required | Description |
---|---|---|---|
UNKNOWN | str | ✅ | “UNKNOWN” |
SERIF | str | ✅ | “SERIF” |
SANS | str | ✅ | “SANS” |
MONO | str | ✅ | “MONO” |
Name | Type | Required | Description |
---|---|---|---|
signing_steps | List[TemplateSigningStep] | ✅ | List of signing steps |
Name | Type | Required | Description |
---|---|---|---|
comment | str | ✅ | Comment for the envelope |
Name | Type | Required | Description |
---|---|---|---|
TEMPLATEID | str | ✅ | “TEMPLATE_ID” |
TEMPLATECREATIONDATE | str | ✅ | “TEMPLATE_CREATION_DATE” |
TEMPLATEMODIFICATIONDATE | str | ✅ | “TEMPLATE_MODIFICATION_DATE” |
TEMPLATENAME | str | ✅ | “TEMPLATE_NAME” |
Name | Type | Required | Description |
---|---|---|---|
CREATIONDATE | str | ✅ | “CREATION_DATE” |
MODIFICATIONDATE | str | ✅ | “MODIFICATION_DATE” |
NAME | str | ✅ | “NAME” |
STATUS | str | ✅ | “STATUS” |
LASTDOCUMENTCHANGE | str | ✅ | “LAST_DOCUMENT_CHANGE” |
Name | Type | Required | Description |
---|---|---|---|
file | bytes | ❌ | File to upload in binary format |
Name | Type | Required | Description |
---|---|---|---|
webhook_id | str | ❌ | ID of the webhook |
event | WebhookEvent | ❌ | Event of the webhook |
Name | Type | Required | Description |
---|---|---|---|
legality_level | 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) |
Name | Type | Required | Description |
---|---|---|---|
expires_at | int | ✅ | Unix timestamp of the expiration date |
Name | Type | Required | Description |
---|---|---|---|
size | float | ❌ | Font size of the text in pt |
color | float | ❌ | Text color in 32bit representation |
value | str | ❌ | Text content of the annotation |
tooltip | str | ❌ | Tooltip of the annotation |
dynamic_field_name | str | ❌ | Name of the dynamic field |
font | AnnotationFont | ❌ |
Name | Type | Required | Description |
---|---|---|---|
checked | bool | ❌ | Whether the checkbox is checked |
style | AnnotationCheckboxStyle | ❌ | Style of the checkbox |
Name | Type | Required | Description |
---|---|---|---|
id_ | str | ❌ | Unique identifier of the envelope |
name | str | ❌ | Name of the envelope |
comment | str | ❌ | Comment for the envelope |
pages | int | ❌ | Total number of pages in the envelope |
flow_type | EnvelopeFlowType | ❌ | Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow) |
legality_level | EnvelopeLegalityLevel | ❌ | Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes) |
status | EnvelopeStatus | ❌ | Status of the envelope |
created_at | int | ❌ | Unix timestamp of the creation date |
updated_at | int | ❌ | Unix timestamp of the last modification date |
expires_at | int | ❌ | Unix timestamp of the expiration date |
num_recipients | int | ❌ | Number of recipients in the envelope |
is_duplicable | bool | ❌ | Whether the envelope can be duplicated |
signing_steps | List[SigningStep] | ❌ | |
documents | List[Document] | ❌ | |
notification | EnvelopeNotification | ❌ |
Name | Type | Required | Description |
---|---|---|---|
file | bytes | ✅ | File to upload in binary format |
Name | Type | Required | Description |
---|---|---|---|
id_ | str | ❌ | Unique identifier of the recipient |
uid | str | ❌ | Unique identifier of the user associated with the recipient |
name | str | ❌ | Name of the recipient |
str | ❌ | Email of the recipient | |
role | TemplateRecipientRole | ❌ | Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document) |
Name | Type | Required | Description |
---|---|---|---|
document_id | str | ✅ | ID of the document |
page | int | ✅ | Page number where the annotation is placed |
x | float | ✅ | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner |
y | float | ✅ | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner |
width | float | ✅ | Width of the annotation (in % of the page width from 0 to 100) |
height | float | ✅ | Height of the annotation (in % of the page height from 0 to 100) |
type_ | AnnotationType | ✅ | Type of the annotation |
recipient_id | str | ❌ | ID of the recipient |
required | bool | ❌ | |
signature | AnnotationSignature | ❌ | Signature annotation (null if annotation is not a signature) |
initials | AnnotationInitials | ❌ | Initials annotation (null if annotation is not initials) |
text | AnnotationText | ❌ | Text annotation (null if annotation is not a text) |
datetime_ | AnnotationDateTime | ❌ | Date annotation (null if annotation is not a date) |
checkbox | AnnotationCheckbox | ❌ | Checkbox annotation (null if annotation is not a checkbox) |
Name | Type | Required | Description |
---|---|---|---|
annotations | List[Annotation] | ❌ |
Name | Type | Required | Description |
---|---|---|---|
DRAFT | str | ✅ | “DRAFT” |
INPROGRESS | str | ✅ | “IN_PROGRESS” |
COMPLETED | str | ✅ | “COMPLETED” |
EXPIRED | str | ✅ | “EXPIRED” |
DECLINED | str | ✅ | “DECLINED” |
VOIDED | str | ✅ | “VOIDED” |
PENDING | str | ✅ | “PENDING” |
Name | Type | Required | Description |
---|---|---|---|
type_ | RecipientVerificationType | ❌ | Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered) |
value | str | ❌ |
Name | Type | Required | Description |
---|---|---|---|
CIRCLECHECK | str | ✅ | “CIRCLE_CHECK” |
CIRCLEFULL | str | ✅ | “CIRCLE_FULL” |
SQUARECHECK | str | ✅ | “SQUARE_CHECK” |
SQUAREFULL | str | ✅ | “SQUARE_FULL” |
CHECKMARK | str | ✅ | “CHECK_MARK” |
TIMESSQUARE | str | ✅ | “TIMES_SQUARE” |
Name | Type | Required | Description |
---|---|---|---|
recipients | List[Recipient] | ❌ | List of recipients |
Name | Type | Required | Description |
---|---|---|---|
size | float | ❌ | Font size of the text in pt |
font | AnnotationFont | ❌ | |
color | str | ❌ | Color of the text in hex format |
auto_fill | bool | ❌ | Whether the date should be automatically filled |
timezone | str | ❌ | Timezone of the date |
timestamp | int | ❌ | Unix timestamp of the date |
format | AnnotationDateTimeFormat | ❌ | Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces) |
Name | Type | Required | Description |
---|---|---|---|
name | str | ✅ |
Name | Type | Required | Description |
---|---|---|---|
documents | List[Document] | ❌ |
Name | Type | Required | Description |
---|---|---|---|
id_ | str | ❌ | Unique identifier of the annotation initials |
Name | Type | Required | Description |
---|---|---|---|
family | AnnotationFontFamily | ❌ | Font family of the text |
italic | bool | ❌ | Whether the text is italic |
bold | bool | ❌ | Whether the text is bold |
Name | Type | Required | Description |
---|---|---|---|
TEXT | str | ✅ | “TEXT” |
SIGNATURE | str | ✅ | “SIGNATURE” |
INITIALS | str | ✅ | “INITIALS” |
CHECKBOX | str | ✅ | “CHECKBOX” |
DATE | str | ✅ | “DATE” |
Name | Type | Required | Description |
---|---|---|---|
id_ | str | ❌ | Unique identifier of the webhook |
event | WebhookEvent | ❌ | Event of the webhook |
target | str | ❌ | Target URL of the webhook |
Name | Type | Required | Description |
---|---|---|---|
name | str | ✅ | Name of the template |
Name | Type | Required | Description |
---|---|---|---|
has_next_page | bool | ❌ | Whether there is a next page |
has_previous_page | bool | ❌ | Whether there is a previous page |
templates | List[Template] | ❌ |
Name | Type | Required | Description |
---|---|---|---|
SIGNER | str | ✅ | “SIGNER” |
RECEIVESCOPY | str | ✅ | “RECEIVES_COPY” |
INPERSONSIGNER | str | ✅ | “IN_PERSON_SIGNER” |
Name | Type | Required | Description |
---|---|---|---|
id_ | str | ❌ | Unique identifier of the annotation |
recipient_id | str | ❌ | ID of the recipient |
document_id | str | ❌ | ID of the document |
page | int | ❌ | Page number where the annotation is placed |
x | float | ❌ | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner |
y | float | ❌ | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner |
width | float | ❌ | Width of the annotation (in % of the page width from 0 to 100) |
height | float | ❌ | Height of the annotation (in % of the page height from 0 to 100) |
required | bool | ❌ | Whether the annotation is required |
type_ | AnnotationType | ❌ | Type of the annotation |
signature | AnnotationSignature | ❌ | Signature annotation (null if annotation is not a signature) |
initials | AnnotationInitials | ❌ | Initials annotation (null if annotation is not initials) |
text | AnnotationText | ❌ | Text annotation (null if annotation is not a text) |
datetime_ | AnnotationDateTime | ❌ | Date annotation (null if annotation is not a date) |
checkbox | AnnotationCheckbox | ❌ | Checkbox annotation (null if annotation is not a checkbox) |
Name | Type | Required | Description |
---|---|---|---|
name | str | ❌ | Name of the dynamic field |
value | str | ❌ | Value of the dynamic field |
Name | Type | Required | Description |
---|---|---|---|
DMYNUMERICSLASH | str | ✅ | “DMY_NUMERIC_SLASH” |
MDYNUMERICSLASH | str | ✅ | “MDY_NUMERIC_SLASH” |
YMDNUMERICSLASH | str | ✅ | “YMD_NUMERIC_SLASH” |
DMYNUMERICDASHSHORT | str | ✅ | “DMY_NUMERIC_DASH_SHORT” |
DMYNUMERICDASH | str | ✅ | “DMY_NUMERIC_DASH” |
YMDNUMERICDASH | str | ✅ | “YMD_NUMERIC_DASH” |
MDYTEXTDASHSHORT | str | ✅ | “MDY_TEXT_DASH_SHORT” |
MDYTEXTSPACESHORT | str | ✅ | “MDY_TEXT_SPACE_SHORT” |
MDYTEXTSPACE | str | ✅ | “MDY_TEXT_SPACE” |
Name | Type | Required | Description |
---|---|---|---|
REQUESTSIGNATURE | str | ✅ | “REQUEST_SIGNATURE” |
SIGNMYSELF | str | ✅ | “SIGN_MYSELF” |
Name | Type | Required | Description |
---|---|---|---|
SES | str | ✅ | “SES” |
QESEIDAS | str | ✅ | “QES_EIDAS” |
QESZERTES | str | ✅ | “QES_ZERTES” |
Name | Type | Required | Description |
---|---|---|---|
SIGNER | str | ✅ | “SIGNER” |
RECEIVESCOPY | str | ✅ | “RECEIVES_COPY” |
INPERSONSIGNER | str | ✅ | “IN_PERSON_SIGNER” |
Name | Type | Required | Description |
---|---|---|---|
dynamic_fields | List[DynamicField] | ✅ | List of dynamic fields |
Name | Type | Required | Description |
---|---|---|---|
width | int | ❌ | Width of the page in pixels |
height | int | ❌ | Height of the page in pixels |
Name | Type | Required | Description |
---|---|---|---|
recipients | List[TemplateRecipient] | ❌ | List of recipients |
Name | Type | Required | Description |
---|---|---|---|
has_next_page | bool | ❌ | Whether there is a next page |
has_previous_page | bool | ❌ | Whether there is a previous page |
envelopes | List[Envelope] | ❌ |
Name | Type | Required | Description |
---|---|---|---|
name | str | ✅ | Name of the recipient |
str | ✅ | Email of the recipient | |
role | RecipientRole | ✅ | Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document) |
id_ | str | ❌ | Unique identifier of the recipient |
uid | str | ❌ | Unique identifier of the user associated with the recipient |
verification | RecipientVerification | ❌ |
Name | Type | Required | Description |
---|---|---|---|
ENVELOPEEXPIRED | str | ✅ | “ENVELOPE_EXPIRED” |
ENVELOPEDECLINED | str | ✅ | “ENVELOPE_DECLINED” |
ENVELOPEVOIDED | str | ✅ | “ENVELOPE_VOIDED” |
ENVELOPECOMPLETED | str | ✅ | “ENVELOPE_COMPLETED” |
ENVELOPEAUDITTRAIL | str | ✅ | “ENVELOPE_AUDIT_TRAIL” |
Name | Type | Required | Description |
---|---|---|---|
event | WebhookEvent | ✅ | Event of the webhook |
target | str | ✅ | URL of the webhook target |
Name | Type | Required | Description |
---|---|---|---|
name | str | ✅ | Name of the envelope |
comment | str | ❌ | Comment for the envelope |
sandbox | bool | ❌ | Whether the envelope is created in sandbox mode |
Name | Type | Required | Description |
---|---|---|---|
annotations | List[Annotation] | ❌ |
Name | Type | Required | Description |
---|---|---|---|
name | str | ❌ | Name of the envelope |
Name | Type | Required | Description |
---|---|---|---|
annotations | List[Annotation] | ❌ |
Name | Type | Required | Description |
---|---|---|---|
documents | List[Document] | ❌ |
Name | Type | Required | Description |
---|---|---|---|
webhooks | List[Webhook] | ❌ |
Name | Type | Required | Description |
---|---|---|---|
id_ | str | ❌ | Unique identifier of the annotation signature |