signplus-python 1.4.0

Integrate legally-binding electronic signature to your workflow

Signplus Python SDK 1.4.0

Welcome to the Signplus SDK documentation. This guide will help you get started with integrating and using the Signplus SDK in your project.

Versions

• API version: 2.5.0
• SDK version: 1.4.0

About the API

Integrate legally-binding electronic signature to your workflow

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • Access Token Authentication
• Setting a Custom Timeout
• Sample Usage
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install signplus-python

Authentication

Access Token Authentication

The Signplus API uses an Access Token for authentication.

This token must be provided to authenticate your requests to the API.

Setting the Access Token

When you initialize the SDK, you can set the access token as follows:

Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

If you need to set or update the access token after initializing the SDK, you can use:

sdk.set_access_token("YOUR_ACCESS_TOKEN")

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from signplus import Signplus

sdk = Signplus(timeout=10000)

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_envelope(envelope_id="envelope_id")

print(result)

Async Usage

The SDK includes an Async Client for making asynchronous API requests. This is useful for applications that need non-blocking operations, like web servers or apps with a graphical user interface.

import asyncio
from signplus import SignplusAsync

sdk = SignplusAsync(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)


async def main():
  result = await sdk.signplus.get_envelope(envelope_id="envelope_id")
  print(result)

asyncio.run(main())

Services

The SDK provides various services to interact with the API.

Below is a list of all available services:

Name
signplus

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models:

Name	Description
CreateEnvelopeRequest
Envelope
CreateEnvelopeFromTemplateRequest
ListEnvelopesRequest
ListEnvelopesResponse
Document
ListEnvelopeDocumentsResponse
AddEnvelopeDocumentRequest
SetEnvelopeDynamicFieldsRequest
AddEnvelopeSigningStepsRequest
SetEnvelopeAttachmentsSettingsRequest
EnvelopeAttachments
SetEnvelopeAttachmentsPlaceholdersRequest
RenameEnvelopeRequest
SetEnvelopeCommentRequest
EnvelopeNotification
SetEnvelopeExpirationRequest
SetEnvelopeLegalityLevelRequest
Annotation
ListEnvelopeDocumentAnnotationsResponse
AddAnnotationRequest
CreateTemplateRequest
Template
ListTemplatesRequest
ListTemplatesResponse
AddTemplateDocumentRequest
ListTemplateDocumentsResponse
AddTemplateSigningStepsRequest
RenameTemplateRequest
SetTemplateCommentRequest
ListTemplateAnnotationsResponse
ListTemplateDocumentAnnotationsResponse
CreateWebhookRequest
Webhook
ListWebhooksRequest
ListWebhooksResponse
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)
EnvelopeFlowType	Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
EnvelopeStatus	Status of the envelope
SigningStep
Recipient
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)
RecipientVerification
RecipientVerificationType	Type of verification the recipient must complete before accessing the envelope. - PASSCODE: requires a code to be entered. - SMS: sends a code via SMS. - ID_VERIFICATION: prompts the recipient to complete an automated ID and selfie check.
Page
AttachmentSettings
AttachmentPlaceholdersPerRecipient
AttachmentPlaceholder
AttachmentPlaceholderFile
EnvelopeOrderField	Field to order envelopes by
DynamicField
AttachmentPlaceholderRequest
AnnotationType	Type of the annotation
AnnotationSignature	Signature annotation (null if annotation is not a signature)
AnnotationInitials	Initials annotation (null if annotation is not initials)
AnnotationText	Text annotation (null if annotation is not a text)
AnnotationDateTime	Date annotation (null if annotation is not a date)
AnnotationCheckbox	Checkbox annotation (null if annotation is not a checkbox)
AnnotationFont
AnnotationFontFamily	Font family of the text
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)
AnnotationCheckboxStyle	Style of the checkbox
TemplateSigningStep
TemplateRecipient
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)
TemplateOrderField	Field to order templates by
WebhookEvent	Event of the webhook

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.