Create Signature Request
Create a new signature request.skribble.signature_request.create(signature_request: SignatureRequest) -> SignatureRequestResponse
skribble.signature_request.create(signatureRequest: Types.SignatureRequest): Promise<Types.SignatureRequestResponse>
Request Object
Show SignatureRequest properties
Show SignatureRequest properties
string
required
Title of the signature request
string
Message sent to the participants
string
Base64 encoded bytes of document
string
Content type of bytes sent in content
string
Publicly accessible URL for document download
string
Document ID of an existing document on Skribble
string
Legislation of the signatures (ZERTES or EIDAS). Only important for QES signatures
string
Minimal quality of the signatures (AES, AES_MINIMAL, SES or QES)
string[]
CC email addresses
string
Callback-URL for success
string
Callback-URL for errors
string
Callback-URL for updates
string
Custom field for own/customer settings
string[]
Users with full write access
Signature[]
Response Object
Show SignatureRequestResponse properties
Show SignatureRequestResponse properties
string
required
ID of the SignatureRequest object
string
required
Given title for the signature request
string
Given message that is shown to the participants
string
required
ID of the Document object
string
Given legislation of the signatures for this signature request
string
Given quality of the signatures for this signature request
string
Deprecated. Please use the signing_url inside the user’s Signature entry
string
required
Status of the signature request
SignatureResponse[]
required
Array of signatures within this signature request
string[]
Given array of email-addresses that will be additionally notified upon completed signature request
string
required
Creator of the SignatureRequest object
string[]
Array of users with read access on the signature request
string[]
Array of users with write access on the signature request
string
Timestamp at which the signature request was created
string
Timestamp at which the signature request was last updated
AttachmentResponse[]
Array of attachments associated with this signature request
Get Signature Request
Retrieve a signature request by ID.skribble.signature_request.get(signature_request_id: str) -> SignatureRequestResponse
skribble.signature_request.get(signatureRequestId: string): Promise<Types.SignatureRequestResponse>
Response Object
Show SignatureRequestResponse properties
Show SignatureRequestResponse properties
string
required
ID of the SignatureRequest object
string
required
Given title for the signature request
string
Given message that is shown to the participants
string
required
ID of the Document object
string
Given legislation of the signatures for this signature request
string
Given quality of the signatures for this signature request
string
Deprecated. Please use the signing_url inside the user’s Signature entry
string
required
Status of the signature request
SignatureResponse[]
required
Array of signatures within this signature request
string[]
Given array of email-addresses that will be additionally notified upon completed signature request
string
required
Creator of the SignatureRequest object
string[]
Array of users with read access on the signature request
string[]
Array of users with write access on the signature request
string
Timestamp at which the signature request was created
string
Timestamp at which the signature request was last updated
AttachmentResponse[]
Array of attachments associated with this signature request
List Signature Requests
List all signature requests with optional pagination.skribble.signature_request.list(page_size: int = None) -> List[SignatureRequestResponse]
skribble.signature_request.list({ page_size?: number }): Promise<Types.SignatureRequestResponse[]>
Response Object
Show SignatureRequestResponse properties
Show SignatureRequestResponse properties
string
required
ID of the SignatureRequest object
string
required
Given title for the signature request
string
Given message that is shown to the participants
string
required
ID of the Document object
string
Given legislation of the signatures for this signature request
string
Given quality of the signatures for this signature request
string
Deprecated. Please use the signing_url inside the user’s Signature entry
string
required
Status of the signature request
SignatureResponse[]
required
Array of signatures within this signature request
string[]
Given array of email-addresses that will be additionally notified upon completed signature request
string
required
Creator of the SignatureRequest object
string[]
Array of users with read access on the signature request
string[]
Array of users with write access on the signature request
string
Timestamp at which the signature request was created
string
Timestamp at which the signature request was last updated
AttachmentResponse[]
Array of attachments associated with this signature request
Withdraw Signature Request
Withdraw a pending signature request.skribble.signature_request.withdraw(signature_request_id: str, message: str = None) -> SignatureRequestResponse
skribble.signature_request.withdraw(signatureRequestId: string, message?: string): Promise<Types.SignatureRequestResponse>
Response Object
Show SignatureRequestResponse properties
Show SignatureRequestResponse properties
string
required
ID of the SignatureRequest object
string
required
Given title for the signature request
string
Given message that is shown to the participants
string
required
ID of the Document object
string
Given legislation of the signatures for this signature request
string
Given quality of the signatures for this signature request
string
Deprecated. Please use the signing_url inside the user’s Signature entry
string
required
Status of the signature request
SignatureResponse[]
required
Array of signatures within this signature request
string[]
Given array of email-addresses that will be additionally notified upon completed signature request
string
required
Creator of the SignatureRequest object
string[]
Array of users with read access on the signature request
string[]
Array of users with write access on the signature request
string
Timestamp at which the signature request was created
string
Timestamp at which the signature request was last updated
AttachmentResponse[]
Array of attachments associated with this signature request
Delete Signature Request
Delete a signature request.skribble.signature_request.delete(signature_request_id: str) -> None
skribble.signature_request.delete(signatureRequestId: string): Promise<void>
Remind Signers
Send a reminder to signers of a signature request.skribble.signature_request.remind(signature_request_id: str) -> None
skribble.signature_request.remind(signatureRequestId: string): Promise<void>
Add Signer
Add a new signer to an existing signature request.skribble.signature_request.signer.add(signature_request_id: str, signer: SignerRequest) -> SignatureRequestResponse
skribble.signature_request.signer.add(signatureRequestId: string, signer: Types.SignerRequest): Promise<Types.SignatureRequestResponse>
Request Object
Response Object
Show SignatureRequestResponse properties
Show SignatureRequestResponse properties
string
required
ID of the SignatureRequest object
string
required
Given title for the signature request
string
Given message that is shown to the participants
string
required
ID of the Document object
string
Given legislation of the signatures for this signature request
string
Given quality of the signatures for this signature request
string
Deprecated. Please use the signing_url inside the user’s Signature entry
string
required
Status of the signature request
SignatureResponse[]
required
Array of signatures within this signature request
string[]
Given array of email-addresses that will be additionally notified upon completed signature request
string
required
Creator of the SignatureRequest object
string[]
Array of users with read access on the signature request
string[]
Array of users with write access on the signature request
string
Timestamp at which the signature request was created
string
Timestamp at which the signature request was last updated
AttachmentResponse[]
Array of attachments associated with this signature request
Remove Signer
Remove a signer from a signature request.skribble.signature_request.signer.remove(signature_request_id: str, signer_id: str) -> None
skribble.signature_request.signer.remove(signatureRequestId: string, signerId: string): Promise<void>
Replace Signers
Replace all signers in a signature request.skribble.signature_request.signer.replace(signature_request_id: str, signers: List[SignerRequest]) -> SignatureRequestResponse
skribble.signature_request.signer.replace(signatureRequestId: string, signers: Types.SignerRequest[]): Promise<Types.SignatureRequestResponse>
Request Object
Response Object
Show SignatureRequestResponse properties
Show SignatureRequestResponse properties
string
required
ID of the SignatureRequest object
string
required
Given title for the signature request
string
Given message that is shown to the participants
string
required
ID of the Document object
string
Given legislation of the signatures for this signature request
string
Given quality of the signatures for this signature request
string
Deprecated. Please use the signing_url inside the user’s Signature entry
string
required
Status of the signature request
SignatureResponse[]
required
Array of signatures within this signature request
string[]
Given array of email-addresses that will be additionally notified upon completed signature request
string
required
Creator of the SignatureRequest object
string[]
Array of users with read access on the signature request
string[]
Array of users with write access on the signature request
string
Timestamp at which the signature request was created
string
Timestamp at which the signature request was last updated
AttachmentResponse[]
Array of attachments associated with this signature request
Add Attachment
Add an attachment to a signature request.skribble.signature_request.attachment.add(signature_request_id: str, attachment: AttachmentRequest) -> List[AttachmentResponse]
skribble.signature_request.attachment.add(signatureRequestId: string, attachment: Types.AttachmentRequest): Promise<Types.AttachmentResponse[]>
Request Object
Response Object
List Attachments
List all attachments for a signature request.skribble.signature_request.attachment.list(signature_request_id: str) -> List[AttachmentResponse]
skribble.signature_request.attachment.list(signatureRequestId: string): Promise<Types.AttachmentResponse[]>
Response Object
Download Attachment
Download an attachment’s content.skribble.signature_request.attachment.download(signature_request_id: str, attachment_id: str) -> bytes
skribble.signature_request.attachment.download(signatureRequestId: string, attachmentId: string): Promise<Buffer>
Delete Attachment
Delete an attachment from a signature request.skribble.signature_request.attachment.delete(signature_request_id: str, attachment_id: str) -> None
skribble.signature_request.attachment.delete(signatureRequestId: string, attachmentId: string): Promise<void>