Types Reference

Complete reference for all types and models in the Skribble SDK

All types are provided by the SDK - you don’t need to define them yourself. Import them as follows:

Python

from skribble.models import Document, SignatureRequest, Seal, SignerIdentityData, VisualSignature

Common Types

Position

Position details for visual elements

x · number · required

y · number · required

width · number · required

height · number · required

page · string · required

rotation · number · default: "0"

Image

Image data with content type and content

content_type · string · required

content · string · required

Document Types

Document

Represents a document

id · string · required

ID of the Document object

parent_id · string

ID of the previous version of the Document object

title · string · required

Given title of the document

content_type · string · required

Content type of the document

size · number · required

Size in bytes of the document

page_count · number

Number of pages in the document

page_width · number

Width of the document pages

page_height · number

Height of the document pages

owner · string · required

Owner of the document

DocumentRequest

Request to create a new document

title · string · required

Title of the document

content_type · string

Content type of bytes sent in content

content · string

Base64 encoded bytes of document

file_url · string

Publicly accessible URL for document download

write_access · string[]

E-mail addresses with write access to the object

DocumentResponse

Response object for a document

id · string · required

ID of the Document object

parent_id · string

ID of the previous version of the Document object

title · string · required

Given title of the document

content_type · string · required

Content type of the document (always application/pdf)

size · number · required

Size in bytes of the document

page_count · number

Number of pages of the document

page_width · number

Width of the document in pixel

page_height · number

Height of the document in pixel

signature_fields · { name?: string; status?: string; position?: Position }[]

PDF AcroForm signature fields found in the document

read_access · string[] · required

Array of users with read access

write_access · string[] · required

Array of users with write access

created_at · string · required

Timestamp at which the document was created

updated_at · string

Timestamp at which the document was last updated

Signature Request Types

SignatureRequest

Represents a signature request

title · string · required

Title of the signature request

message · string

Message sent to the participants

content · string

Base64 encoded bytes of document

content_type · string

Content type of bytes sent in content

file_url · string

Publicly accessible URL for document download

document_id · string

Document ID of an existing document on Skribble

legislation · string

Legislation of the signatures (ZERTES or EIDAS). Only important for QES signatures

quality · string

Minimal quality of the signatures (AES, AES_MINIMAL, SES or QES)

cc_email_addresses · string[]

CC email addresses

callback_success_url · string

Callback-URL for success

callback_error_url · string

Callback-URL for errors

callback_update_url · string

Callback-URL for updates

custom · string

Custom field for own/customer settings

write_access · string[]

Users with full write access

signatures · Signature[]

Signature

Represents a signature in a signature request

account_email · string

Signer’s e-mail address

signer_identity_data · SignerIdentityData

visual_signature · VisualSignature

sequence · number

Define a signing sequence for signers

notify · boolean · default: "True"

Send e-mails to notify the signer

language · string

Language for communication

SignerIdentityData

Identity data for no-account signers

email_address · string · required

Email address of no-account-signer

mobile_number · string

Mobile number of no-account-signer

first_name · string

First name of no-account-signer

last_name · string

Last name of no-account-signer

language · string

Language for communication with the signer

VisualSignature

Visual signature with position and optional image

form_field · string

Name of the document’s form field in which the signature is placed. Takes precedence before positions

position · Position · required

image · Image

SignatureResponse

Response object for a signature

sid · string · required

ID of the SignatureRequest object

account_email · string

Email address of the signer

signer_identity_data · any

Contains the given first_name and last_name of the signer

sequence · number

Signing sequence for the signer

status_code · string · required

Status of the signature

notify · boolean

Given identifier, if the signer will be notified about changes on this signature request

signed_at · string

Visible only after the signature. Timestamp UTC at which the signature was executed

signed_quality · string

Visible only after the signature. Quality level with which the signature was executed

signed_legislation · string

Visible only after the signature. Legislation with which the signature was executed

last_viewed_at · string

Timestamp UTC at which the signer opened/viewed the document the last time

SignatureRequestResponse

Response object for a signature request

id · string · required

ID of the SignatureRequest object

title · string · required

Given title for the signature request

message · string

Given message that is shown to the participants

document_id · string · required

ID of the Document object

legislation · string

Given legislation of the signatures for this signature request

quality · string

Given quality of the signatures for this signature request

signing_url · string

Deprecated. Please use the signing_url inside the user’s Signature entry

status_overall · string · required

Status of the signature request

signatures · SignatureResponse[] · required

Array of signatures within this signature request

cc_email_addresses · string[]

Given array of email-addresses that will be additionally notified upon completed signature request

owner · string · required

Creator of the SignatureRequest object

read_access · string[]

Array of users with read access on the signature request

write_access · string[]

Array of users with write access on the signature request

created_at · string

Timestamp at which the signature request was created

updated_at · string

Timestamp at which the signature request was last updated

attachments · AttachmentResponse[]

Array of attachments associated with this signature request

Seal Types

Seal

Seal for a document

title · string

Title of the seal document

content · string · required

Base64 encoded bytes of document

account_name · string

Specifies the seal to use for sealing

visual_signature · VisualSignature

SealRequest

Request to seal a document

title · string · required

Title of the seal document

content · string · required

Base64 encoded bytes of document

account_name · string

Specifies the seal to use for sealing

visual_signature · VisualSignature

SealResponse

Response from seal operations

document_id · string · required

The document ID

Attachment Types

Attachment

Attachment for a document

title · string · required

Title of the attachment

content · string · required

Base64 encoded bytes of the attachment

content_type · string · required

Content type of the attachment

AttachmentRequest

Request to add an attachment to a signature request

filename · string · required

Name of the attachment file

content_type · string · required

Content type of the attachment

content · string · required

Base64 encoded content of the attachment

AttachmentResponse

Response object for an attachment

attachment_id · string · required

ID of the attachment

filename · string · required

Name of the attachment file