SDK Reference
A list of all methods in the 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 |
create_envelope
Create new envelope
- HTTP Method:
POST
- Endpoint:
/envelope
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | CreateEnvelopeRequest | The request body. |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import CreateEnvelopeRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = CreateEnvelopeRequest(
name="name",
flow_type="REQUEST_SIGNATURE",
legality_level="SES",
expires_at=4,
comment="comment",
sandbox=True
)
result = sdk.signplus.create_envelope(request_body=request_body)
print(result)
create_envelope_from_template
Create new envelope from template
- HTTP Method:
POST
- Endpoint:
/envelope/from_template/{template_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | CreateEnvelopeFromTemplateRequest | The request body. | |
template_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import CreateEnvelopeFromTemplateRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = CreateEnvelopeFromTemplateRequest(
name="name",
comment="comment",
sandbox=False
)
result = sdk.signplus.create_envelope_from_template(
request_body=request_body,
template_id="template_id"
)
print(result)
list_envelopes
List envelopes
- HTTP Method:
POST
- Endpoint:
/envelopes
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | ListEnvelopesRequest | The request body. |
Return Type
ListEnvelopesResponse
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import ListEnvelopesRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = ListEnvelopesRequest(
name="name",
tags=[
"tags"
],
comment="comment",
ids=[
"ids"
],
statuses=[
"DRAFT"
],
folder_ids=[
"folder_ids"
],
only_root_folder=False,
date_from=2,
date_to=5,
uid="uid",
first=4,
last=9,
after="after",
before="before",
order_field="CREATION_DATE",
ascending=True,
include_trash=True
)
result = sdk.signplus.list_envelopes(request_body=request_body)
print(result)
get_envelope
Get envelope
- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.get_envelope(envelope_id="envelope_id")
print(result)
delete_envelope
Delete envelope
- HTTP Method:
DELETE
- Endpoint:
/envelope/{envelope_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str |
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.delete_envelope(envelope_id="envelope_id")
print(result)
get_envelope_document
Get envelope document
- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}/document/{document_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ||
document_id | str |
Return Type
Document
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.get_envelope_document(
envelope_id="envelope_id",
document_id="document_id"
)
print(result)
get_envelope_documents
Get envelope documents
- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}/documents
Parameters
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str |
Return Type
ListEnvelopeDocumentsResponse
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.get_envelope_documents(envelope_id="envelope_id")
print(result)
add_envelope_document
Add envelope document
- HTTP Method:
POST
- Endpoint:
/envelope/{envelope_id}/document
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | AddEnvelopeDocumentRequest | The request body. | |
envelope_id | str |
Return Type
Document
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import AddEnvelopeDocumentRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = AddEnvelopeDocumentRequest(
file="file"
)
result = sdk.signplus.add_envelope_document(
request_body=request_body,
envelope_id="envelope_id"
)
print(result)
set_envelope_dynamic_fields
Set envelope dynamic fields
- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/dynamic_fields
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | SetEnvelopeDynamicFieldsRequest | The request body. | |
envelope_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import SetEnvelopeDynamicFieldsRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = SetEnvelopeDynamicFieldsRequest(
dynamic_fields=[
{
"name": "name",
"value": "value"
}
]
)
result = sdk.signplus.set_envelope_dynamic_fields(
request_body=request_body,
envelope_id="envelope_id"
)
print(result)
add_envelope_signing_steps
Add envelope signing steps
- HTTP Method:
POST
- Endpoint:
/envelope/{envelope_id}/signing_steps
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | AddEnvelopeSigningStepsRequest | The request body. | |
envelope_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import AddEnvelopeSigningStepsRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = AddEnvelopeSigningStepsRequest(
signing_steps=[
{
"recipients": [
{
"id_": "id",
"uid": "uid",
"name": "name",
"email": "email",
"role": "SIGNER",
"verification": {
"type_": "SMS",
"value": "value"
}
}
]
}
]
)
result = sdk.signplus.add_envelope_signing_steps(
request_body=request_body,
envelope_id="envelope_id"
)
print(result)
send_envelope
Send envelope for signature
- HTTP Method:
POST
- Endpoint:
/envelope/{envelope_id}/send
Parameters
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.send_envelope(envelope_id="envelope_id")
print(result)
duplicate_envelope
Duplicate envelope
- HTTP Method:
POST
- Endpoint:
/envelope/{envelope_id}/duplicate
Parameters
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.duplicate_envelope(envelope_id="envelope_id")
print(result)
void_envelope
Void envelope
- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/void
Parameters
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.void_envelope(envelope_id="envelope_id")
print(result)
rename_envelope
Rename envelope
- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/rename
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | RenameEnvelopeRequest | The request body. | |
envelope_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import RenameEnvelopeRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = RenameEnvelopeRequest(
name="name"
)
result = sdk.signplus.rename_envelope(
request_body=request_body,
envelope_id="envelope_id"
)
print(result)
set_envelope_comment
Set envelope comment
- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/set_comment
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | SetEnvelopeCommentRequest | The request body. | |
envelope_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import SetEnvelopeCommentRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = SetEnvelopeCommentRequest(
comment="comment"
)
result = sdk.signplus.set_envelope_comment(
request_body=request_body,
envelope_id="envelope_id"
)
print(result)
set_envelope_notification
Set envelope notification
- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/set_notification
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | EnvelopeNotification | The request body. | |
envelope_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import EnvelopeNotification
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = EnvelopeNotification(
subject="subject",
message="message",
reminder_interval=5
)
result = sdk.signplus.set_envelope_notification(
request_body=request_body,
envelope_id="envelope_id"
)
print(result)
set_envelope_expiration_date
Set envelope expiration date
- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/set_expiration_date
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | SetEnvelopeExpirationRequest | The request body. | |
envelope_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import SetEnvelopeExpirationRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = SetEnvelopeExpirationRequest(
expires_at=2
)
result = sdk.signplus.set_envelope_expiration_date(
request_body=request_body,
envelope_id="envelope_id"
)
print(result)
set_envelope_legality_level
Set envelope legality level
- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/set_legality_level
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | SetEnvelopeLegalityLevelRequest | The request body. | |
envelope_id | str |
Return Type
Envelope
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import SetEnvelopeLegalityLevelRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = SetEnvelopeLegalityLevelRequest(
legality_level="SES"
)
result = sdk.signplus.set_envelope_legality_level(
request_body=request_body,
envelope_id="envelope_id"
)
print(result)
get_envelope_annotations
Get envelope annotations
- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}/annotations
Parameters
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ID of the envelope |
Return Type
List[Annotation]
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.get_envelope_annotations(envelope_id="envelope_id")
print(result)
get_envelope_document_annotations
Get envelope document annotations
- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}/annotations/{document_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ID of the envelope | |
document_id | str | ID of document |
Return Type
ListEnvelopeDocumentAnnotationsResponse
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.get_envelope_document_annotations(
envelope_id="envelope_id",
document_id="document_id"
)
print(result)
add_envelope_annotation
Add envelope annotation
- HTTP Method:
POST
- Endpoint:
/envelope/{envelope_id}/annotation
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | AddAnnotationRequest | The request body. | |
envelope_id | str | ID of the envelope |
Return Type
Annotation
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import AddAnnotationRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = AddAnnotationRequest(
recipient_id="recipient_id",
document_id="document_id",
page=7,
x=4.46,
y=7.18,
width=7.26,
height=1.77,
required=False,
type_="TEXT",
signature={
"id_": "id"
},
initials={
"id_": "id"
},
text={
"size": 8.13,
"color": 7.22,
"value": "value",
"tooltip": "tooltip",
"dynamic_field_name": "dynamic_field_name",
"font": {
"family": "UNKNOWN",
"italic": True,
"bold": False
}
},
datetime_={
"size": 0.86,
"font": {
"family": "UNKNOWN",
"italic": True,
"bold": False
},
"color": "color",
"auto_fill": False,
"timezone": "timezone",
"timestamp": 8,
"format": "DMY_NUMERIC_SLASH"
},
checkbox={
"checked": False,
"style": "CIRCLE_CHECK"
}
)
result = sdk.signplus.add_envelope_annotation(
request_body=request_body,
envelope_id="envelope_id"
)
print(result)
delete_envelope_annotation
Delete envelope annotation
- HTTP Method:
DELETE
- Endpoint:
/envelope/{envelope_id}/annotation/{annotation_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
envelope_id | str | ID of the envelope | |
annotation_id | str | ID of the annotation to delete |
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.delete_envelope_annotation(
envelope_id="envelope_id",
annotation_id="annotation_id"
)
print(result)
create_template
Create new template
- HTTP Method:
POST
- Endpoint:
/template
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | CreateTemplateRequest | The request body. |
Return Type
Template
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import CreateTemplateRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = CreateTemplateRequest(
name="name"
)
result = sdk.signplus.create_template(request_body=request_body)
print(result)
list_templates
List templates
- HTTP Method:
POST
- Endpoint:
/templates
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | ListTemplatesRequest | The request body. |
Return Type
ListTemplatesResponse
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import ListTemplatesRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = ListTemplatesRequest(
name="name",
tags=[
"tags"
],
ids=[
"ids"
],
first=8,
last=7,
after="after",
before="before",
order_field="TEMPLATE_ID",
ascending=True
)
result = sdk.signplus.list_templates(request_body=request_body)
print(result)
get_template
Get template
- HTTP Method:
GET
- Endpoint:
/template/{template_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
template_id | str |
Return Type
Template
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.get_template(template_id="template_id")
print(result)
delete_template
Delete template
- HTTP Method:
DELETE
- Endpoint:
/template/{template_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
template_id | str |
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.delete_template(template_id="template_id")
print(result)
duplicate_template
Duplicate template
- HTTP Method:
POST
- Endpoint:
/template/{template_id}/duplicate
Parameters
Name | Type | Required | Description |
---|---|---|---|
template_id | str |
Return Type
Template
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.duplicate_template(template_id="template_id")
print(result)
add_template_document
Add template document
- HTTP Method:
POST
- Endpoint:
/template/{template_id}/document
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | AddTemplateDocumentRequest | The request body. | |
template_id | str |
Return Type
Document
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import AddTemplateDocumentRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = AddTemplateDocumentRequest(
file="file"
)
result = sdk.signplus.add_template_document(
request_body=request_body,
template_id="template_id"
)
print(result)
get_template_document
Get template document
- HTTP Method:
GET
- Endpoint:
/template/{template_id}/document/{document_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ||
document_id | str |
Return Type
Document
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.get_template_document(
template_id="template_id",
document_id="document_id"
)
print(result)
get_template_documents
Get template documents
- HTTP Method:
GET
- Endpoint:
/template/{template_id}/documents
Parameters
Name | Type | Required | Description |
---|---|---|---|
template_id | str |
Return Type
ListTemplateDocumentsResponse
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.get_template_documents(template_id="template_id")
print(result)
add_template_signing_steps
Add template signing steps
- HTTP Method:
POST
- Endpoint:
/template/{template_id}/signing_steps
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | AddTemplateSigningStepsRequest | The request body. | |
template_id | str |
Return Type
Template
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import AddTemplateSigningStepsRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = AddTemplateSigningStepsRequest(
signing_steps=[
{
"recipients": [
{
"id_": "id",
"uid": "uid",
"name": "name",
"email": "email",
"role": "SIGNER"
}
]
}
]
)
result = sdk.signplus.add_template_signing_steps(
request_body=request_body,
template_id="template_id"
)
print(result)
rename_template
Rename template
- HTTP Method:
PUT
- Endpoint:
/template/{template_id}/rename
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | RenameTemplateRequest | The request body. | |
template_id | str |
Return Type
Template
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import RenameTemplateRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = RenameTemplateRequest(
name="name"
)
result = sdk.signplus.rename_template(
request_body=request_body,
template_id="template_id"
)
print(result)
set_template_comment
Set template comment
- HTTP Method:
PUT
- Endpoint:
/template/{template_id}/set_comment
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | SetTemplateCommentRequest | The request body. | |
template_id | str |
Return Type
Template
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import SetTemplateCommentRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = SetTemplateCommentRequest(
comment="comment"
)
result = sdk.signplus.set_template_comment(
request_body=request_body,
template_id="template_id"
)
print(result)
set_template_notification
Set template notification
- HTTP Method:
PUT
- Endpoint:
/template/{template_id}/set_notification
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | EnvelopeNotification | The request body. | |
template_id | str |
Return Type
Template
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import EnvelopeNotification
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = EnvelopeNotification(
subject="subject",
message="message",
reminder_interval=5
)
result = sdk.signplus.set_template_notification(
request_body=request_body,
template_id="template_id"
)
print(result)
get_template_annotations
Get template annotations
- HTTP Method:
GET
- Endpoint:
/template/{template_id}/annotations
Parameters
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ID of the template |
Return Type
ListTemplateAnnotationsResponse
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.get_template_annotations(template_id="template_id")
print(result)
get_document_template_annotations
Get document template annotations
- HTTP Method:
GET
- Endpoint:
/template/{template_id}/annotations/{document_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ID of the template | |
document_id | str | ID of document |
Return Type
ListTemplateDocumentAnnotationsResponse
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.get_document_template_annotations(
template_id="template_id",
document_id="document_id"
)
print(result)
add_template_annotation
Add template annotation
- HTTP Method:
POST
- Endpoint:
/template/{template_id}/annotation
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | AddAnnotationRequest | The request body. | |
template_id | str | ID of the template |
Return Type
Annotation
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import AddAnnotationRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = AddAnnotationRequest(
recipient_id="recipient_id",
document_id="document_id",
page=7,
x=4.46,
y=7.18,
width=7.26,
height=1.77,
required=False,
type_="TEXT",
signature={
"id_": "id"
},
initials={
"id_": "id"
},
text={
"size": 8.13,
"color": 7.22,
"value": "value",
"tooltip": "tooltip",
"dynamic_field_name": "dynamic_field_name",
"font": {
"family": "UNKNOWN",
"italic": True,
"bold": False
}
},
datetime_={
"size": 0.86,
"font": {
"family": "UNKNOWN",
"italic": True,
"bold": False
},
"color": "color",
"auto_fill": False,
"timezone": "timezone",
"timestamp": 8,
"format": "DMY_NUMERIC_SLASH"
},
checkbox={
"checked": False,
"style": "CIRCLE_CHECK"
}
)
result = sdk.signplus.add_template_annotation(
request_body=request_body,
template_id="template_id"
)
print(result)
delete_template_annotation
Delete template annotation
- HTTP Method:
DELETE
- Endpoint:
/template/{template_id}/annotation/{annotation_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
template_id | str | ID of the template | |
annotation_id | str | ID of the annotation to delete |
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.delete_template_annotation(
template_id="template_id",
annotation_id="annotation_id"
)
print(result)
create_webhook
Create webhook
- HTTP Method:
POST
- Endpoint:
/webhook
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | CreateWebhookRequest | The request body. |
Return Type
Webhook
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import CreateWebhookRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = CreateWebhookRequest(
event="ENVELOPE_EXPIRED",
target="target"
)
result = sdk.signplus.create_webhook(request_body=request_body)
print(result)
list_webhooks
List webhooks
- HTTP Method:
POST
- Endpoint:
/webhooks
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | ListWebhooksRequest | The request body. |
Return Type
ListWebhooksResponse
Example Usage Code Snippet
from signplus import Signplus, Environment
from signplus.models import ListWebhooksRequest
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = ListWebhooksRequest(
webhook_id="webhook_id",
event="ENVELOPE_EXPIRED"
)
result = sdk.signplus.list_webhooks(request_body=request_body)
print(result)
delete_webhook
Delete webhook
- HTTP Method:
DELETE
- Endpoint:
/webhook/{webhook_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
webhook_id | str |
Example Usage Code Snippet
from signplus import Signplus, Environment
sdk = Signplus(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.signplus.delete_webhook(webhook_id="webhook_id")
print(result)
Models
Document
Properties
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 |
Models
CreateEnvelopeRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
name | str | Name of 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) | |
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 |
Models
ListEnvelopesRequest
Properties
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 |
Models
EnvelopeNotification
Properties
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 |
Models
ListTemplatesRequest
Properties
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 |
Models
SetTemplateCommentRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
comment | str | Comment for the template |
Models
Template
Properties
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 |
Models
RecipientVerificationType
Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered)
Properties
Name | Type | Required | Description |
---|---|---|---|
SMS | str | “SMS” | |
PASSCODE | str | “PASSCODE” |
Models
AddEnvelopeSigningStepsRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
signing_steps | List[SigningStep] | List of signing steps |
Models
AnnotationFontFamily
Font family of the text
Properties
Name | Type | Required | Description |
---|---|---|---|
UNKNOWN | str | “UNKNOWN” | |
SERIF | str | “SERIF” | |
SANS | str | “SANS” | |
MONO | str | “MONO” |
Models
AddTemplateSigningStepsRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
signing_steps | List[TemplateSigningStep] | List of signing steps |
Models
SetEnvelopeCommentRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
comment | str | Comment for the envelope |
Models
TemplateOrderField
Field to order templates by
Properties
Name | Type | Required | Description |
---|---|---|---|
TEMPLATE_ID | str | “TEMPLATE_ID” | |
TEMPLATE_CREATION_DATE | str | “TEMPLATE_CREATION_DATE” | |
TEMPLATE_MODIFICATION_DATE | str | “TEMPLATE_MODIFICATION_DATE” | |
TEMPLATE_NAME | str | “TEMPLATE_NAME” |
Models
EnvelopeOrderField
Field to order envelopes by
Properties
Name | Type | Required | Description |
---|---|---|---|
CREATION_DATE | str | “CREATION_DATE” | |
MODIFICATION_DATE | str | “MODIFICATION_DATE” | |
NAME | str | “NAME” | |
STATUS | str | “STATUS” | |
LAST_DOCUMENT_CHANGE | str | “LAST_DOCUMENT_CHANGE” |
Models
AddEnvelopeDocumentRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
file | bytes | File to upload in binary format |
Models
ListWebhooksRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
webhook_id | str | ID of the webhook | |
event | WebhookEvent | Event of the webhook |
Models
SetEnvelopeLegalityLevelRequest
Properties
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) |
Models
SetEnvelopeExpirationRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
expires_at | int | Unix timestamp of the expiration date |
Models
AnnotationText
Text annotation (null if annotation is not a text)
Properties
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 |
Models
AnnotationCheckbox
Checkbox annotation (null if annotation is not a checkbox)
Properties
Name | Type | Required | Description |
---|---|---|---|
checked | bool | Whether the checkbox is checked | |
style | AnnotationCheckboxStyle | Style of the checkbox |
Models
Envelope
Properties
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 |
Models
AddTemplateDocumentRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
file | bytes | File to upload in binary format |
Models
TemplateRecipient
Properties
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) |
Models
AddAnnotationRequest
Properties
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) |
Models
ListEnvelopeDocumentAnnotationsResponse
Properties
Name | Type | Required | Description |
---|---|---|---|
annotations | List[Annotation] |
Models
EnvelopeStatus
Status of the envelope
Properties
Name | Type | Required | Description |
---|---|---|---|
DRAFT | str | “DRAFT” | |
IN_PROGRESS | str | “IN_PROGRESS” | |
COMPLETED | str | “COMPLETED” | |
EXPIRED | str | “EXPIRED” | |
DECLINED | str | “DECLINED” | |
VOIDED | str | “VOIDED” | |
PENDING | str | “PENDING” |
Models
RecipientVerification
Properties
Name | Type | Required | Description |
---|---|---|---|
type_ | RecipientVerificationType | Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered) | |
value | str |
Models
AnnotationCheckboxStyle
Style of the checkbox
Properties
Name | Type | Required | Description |
---|---|---|---|
CIRCLE_CHECK | str | “CIRCLE_CHECK” | |
CIRCLE_FULL | str | “CIRCLE_FULL” | |
SQUARE_CHECK | str | “SQUARE_CHECK” | |
SQUARE_FULL | str | “SQUARE_FULL” | |
CHECK_MARK | str | “CHECK_MARK” | |
TIMES_SQUARE | str | “TIMES_SQUARE” |
Models
SigningStep
Properties
Name | Type | Required | Description |
---|---|---|---|
recipients | List[Recipient] | List of recipients |
Models
AnnotationDateTime
Date annotation (null if annotation is not a date)
Properties
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) |
Models
CreateTemplateRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
name | str |
Models
ListTemplateDocumentsResponse
Properties
Name | Type | Required | Description |
---|---|---|---|
documents | List[Document] |
Models
AnnotationInitials
Initials annotation (null if annotation is not initials)
Properties
Name | Type | Required | Description |
---|---|---|---|
id_ | str | Unique identifier of the annotation initials |
Models
AnnotationFont
Properties
Name | Type | Required | Description |
---|---|---|---|
family | AnnotationFontFamily | Font family of the text | |
italic | bool | Whether the text is italic | |
bold | bool | Whether the text is bold |
Models
AnnotationType
Type of the annotation
Properties
Name | Type | Required | Description |
---|---|---|---|
TEXT | str | “TEXT” | |
SIGNATURE | str | “SIGNATURE” | |
INITIALS | str | “INITIALS” | |
CHECKBOX | str | “CHECKBOX” | |
DATE | str | “DATE” |
Models
Webhook
Properties
Name | Type | Required | Description |
---|---|---|---|
id_ | str | Unique identifier of the webhook | |
event | WebhookEvent | Event of the webhook | |
target | str | Target URL of the webhook |
Models
RenameTemplateRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
name | str | Name of the template |
Models
ListTemplatesResponse
Properties
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] |
Models
RecipientRole
Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)
Properties
Name | Type | Required | Description |
---|---|---|---|
SIGNER | str | “SIGNER” | |
RECEIVES_COPY | str | “RECEIVES_COPY” | |
IN_PERSON_SIGNER | str | “IN_PERSON_SIGNER” |
Models
Annotation
Properties
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) |
Models
DynamicField
Properties
Name | Type | Required | Description |
---|---|---|---|
name | str | Name of the dynamic field | |
value | str | Value of the dynamic field |
Models
AnnotationDateTimeFormat
Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces)
Properties
Name | Type | Required | Description |
---|---|---|---|
DMY_NUMERIC_SLASH | str | “DMY_NUMERIC_SLASH” | |
MDY_NUMERIC_SLASH | str | “MDY_NUMERIC_SLASH” | |
YMD_NUMERIC_SLASH | str | “YMD_NUMERIC_SLASH” | |
DMY_NUMERIC_DASH_SHORT | str | “DMY_NUMERIC_DASH_SHORT” | |
DMY_NUMERIC_DASH | str | “DMY_NUMERIC_DASH” | |
YMD_NUMERIC_DASH | str | “YMD_NUMERIC_DASH” | |
MDY_TEXT_DASH_SHORT | str | “MDY_TEXT_DASH_SHORT” | |
MDY_TEXT_SPACE_SHORT | str | “MDY_TEXT_SPACE_SHORT” | |
MDY_TEXT_SPACE | str | “MDY_TEXT_SPACE” |
Models
EnvelopeFlowType
Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
Properties
Name | Type | Required | Description |
---|---|---|---|
REQUEST_SIGNATURE | str | “REQUEST_SIGNATURE” | |
SIGN_MYSELF | str | “SIGN_MYSELF” |
Models
EnvelopeLegalityLevel
Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
Properties
Name | Type | Required | Description |
---|---|---|---|
SES | str | “SES” | |
QES_EIDAS | str | “QES_EIDAS” | |
QES_ZERTES | str | “QES_ZERTES” |
Models
TemplateRecipientRole
Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)
Properties
Name | Type | Required | Description |
---|---|---|---|
SIGNER | str | “SIGNER” | |
RECEIVES_COPY | str | “RECEIVES_COPY” | |
IN_PERSON_SIGNER | str | “IN_PERSON_SIGNER” |
Models
SetEnvelopeDynamicFieldsRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
dynamic_fields | List[DynamicField] | List of dynamic fields |
Models
Page
Properties
Name | Type | Required | Description |
---|---|---|---|
width | int | Width of the page in pixels | |
height | int | Height of the page in pixels |
Models
TemplateSigningStep
Properties
Name | Type | Required | Description |
---|---|---|---|
recipients | List[TemplateRecipient] | List of recipients |
Models
ListEnvelopesResponse
Properties
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] |
Models
Recipient
Properties
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 |
Models
WebhookEvent
Event of the webhook
Properties
Name | Type | Required | Description |
---|---|---|---|
ENVELOPE_EXPIRED | str | “ENVELOPE_EXPIRED” | |
ENVELOPE_DECLINED | str | “ENVELOPE_DECLINED” | |
ENVELOPE_VOIDED | str | “ENVELOPE_VOIDED” | |
ENVELOPE_COMPLETED | str | “ENVELOPE_COMPLETED” |
Models
CreateWebhookRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
event | WebhookEvent | Event of the webhook | |
target | str | URL of the webhook target |
Models
CreateEnvelopeFromTemplateRequest
Properties
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 |
Models
ListTemplateAnnotationsResponse
Properties
Name | Type | Required | Description |
---|---|---|---|
annotations | List[Annotation] |
Models
RenameEnvelopeRequest
Properties
Name | Type | Required | Description |
---|---|---|---|
name | str | Name of the envelope |
Models
ListTemplateDocumentAnnotationsResponse
Properties
Name | Type | Required | Description |
---|---|---|---|
annotations | List[Annotation] |
Models
ListEnvelopeDocumentsResponse
Properties
Name | Type | Required | Description |
---|---|---|---|
documents | List[Document] |
Models
ListWebhooksResponse
Properties
Name | Type | Required | Description |
---|---|---|---|
webhooks | List[Webhook] |
Models
AnnotationSignature
Signature annotation (null if annotation is not a signature)
Properties
Name | Type | Required | Description |
---|---|---|---|
id_ | str | Unique identifier of the annotation signature |