> ## Documentation Index > Fetch the complete documentation index at: https://skribblesdk.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Signature Requests > API reference for signature request operations ## Create Signature Request Create a new signature request. ```python Python theme={null} skribble.signature_request.create(signature_request: SignatureRequest) -> SignatureRequestResponse ``` ```typescript TypeScript theme={null} skribble.signature_request.create(signatureRequest: Types.SignatureRequest): Promise ``` Title of the signature request Message sent to the participants Base64 encoded bytes of document Content type of bytes sent in content Publicly accessible URL for document download Document ID of an existing document on Skribble Legislation of the signatures (ZERTES or EIDAS). Only important for QES signatures Minimal quality of the signatures (AES, AES\_MINIMAL, SES or QES) CC email addresses Callback-URL for success Callback-URL for errors Callback-URL for updates Custom field for own/customer settings Users with full write access ID of the SignatureRequest object Given title for the signature request Given message that is shown to the participants ID of the Document object Given legislation of the signatures for this signature request Given quality of the signatures for this signature request Deprecated. Please use the signing\_url inside the user's Signature entry Status of the signature request Array of signatures within this signature request Given array of email-addresses that will be additionally notified upon completed signature request Creator of the SignatureRequest object Array of users with read access on the signature request Array of users with write access on the signature request Timestamp at which the signature request was created Timestamp at which the signature request was last updated Array of attachments associated with this signature request ## Get Signature Request Retrieve a signature request by ID. ```python Python theme={null} skribble.signature_request.get(signature_request_id: str) -> SignatureRequestResponse ``` ```typescript TypeScript theme={null} skribble.signature_request.get(signatureRequestId: string): Promise ``` ID of the SignatureRequest object Given title for the signature request Given message that is shown to the participants ID of the Document object Given legislation of the signatures for this signature request Given quality of the signatures for this signature request Deprecated. Please use the signing\_url inside the user's Signature entry Status of the signature request Array of signatures within this signature request Given array of email-addresses that will be additionally notified upon completed signature request Creator of the SignatureRequest object Array of users with read access on the signature request Array of users with write access on the signature request Timestamp at which the signature request was created Timestamp at which the signature request was last updated Array of attachments associated with this signature request ## List Signature Requests List all signature requests with optional pagination. ```python Python theme={null} skribble.signature_request.list(page_size: int = None) -> List[SignatureRequestResponse] ``` ```typescript TypeScript theme={null} skribble.signature_request.list({ page_size?: number }): Promise ``` ID of the SignatureRequest object Given title for the signature request Given message that is shown to the participants ID of the Document object Given legislation of the signatures for this signature request Given quality of the signatures for this signature request Deprecated. Please use the signing\_url inside the user's Signature entry Status of the signature request Array of signatures within this signature request Given array of email-addresses that will be additionally notified upon completed signature request Creator of the SignatureRequest object Array of users with read access on the signature request Array of users with write access on the signature request Timestamp at which the signature request was created Timestamp at which the signature request was last updated Array of attachments associated with this signature request ## Withdraw Signature Request Withdraw a pending signature request. ```python Python theme={null} skribble.signature_request.withdraw(signature_request_id: str, message: str = None) -> SignatureRequestResponse ``` ```typescript TypeScript theme={null} skribble.signature_request.withdraw(signatureRequestId: string, message?: string): Promise ``` ID of the SignatureRequest object Given title for the signature request Given message that is shown to the participants ID of the Document object Given legislation of the signatures for this signature request Given quality of the signatures for this signature request Deprecated. Please use the signing\_url inside the user's Signature entry Status of the signature request Array of signatures within this signature request Given array of email-addresses that will be additionally notified upon completed signature request Creator of the SignatureRequest object Array of users with read access on the signature request Array of users with write access on the signature request Timestamp at which the signature request was created Timestamp at which the signature request was last updated Array of attachments associated with this signature request ## Delete Signature Request Delete a signature request. ```python Python theme={null} skribble.signature_request.delete(signature_request_id: str) -> None ``` ```typescript TypeScript theme={null} skribble.signature_request.delete(signatureRequestId: string): Promise ``` ## Remind Signers Send a reminder to signers of a signature request. ```python Python theme={null} skribble.signature_request.remind(signature_request_id: str) -> None ``` ```typescript TypeScript theme={null} skribble.signature_request.remind(signatureRequestId: string): Promise ``` ## Add Signer Add a new signer to an existing signature request. ```python Python theme={null} skribble.signature_request.signer.add(signature_request_id: str, signer: SignerRequest) -> SignatureRequestResponse ``` ```typescript TypeScript theme={null} skribble.signature_request.signer.add(signatureRequestId: string, signer: Types.SignerRequest): Promise ``` Signer's e-mail address ID of the SignatureRequest object Given title for the signature request Given message that is shown to the participants ID of the Document object Given legislation of the signatures for this signature request Given quality of the signatures for this signature request Deprecated. Please use the signing\_url inside the user's Signature entry Status of the signature request Array of signatures within this signature request Given array of email-addresses that will be additionally notified upon completed signature request Creator of the SignatureRequest object Array of users with read access on the signature request Array of users with write access on the signature request Timestamp at which the signature request was created Timestamp at which the signature request was last updated Array of attachments associated with this signature request ## Remove Signer Remove a signer from a signature request. ```python Python theme={null} skribble.signature_request.signer.remove(signature_request_id: str, signer_id: str) -> None ``` ```typescript TypeScript theme={null} skribble.signature_request.signer.remove(signatureRequestId: string, signerId: string): Promise ``` ## Replace Signers Replace all signers in a signature request. ```python Python theme={null} skribble.signature_request.signer.replace(signature_request_id: str, signers: List[SignerRequest]) -> SignatureRequestResponse ``` ```typescript TypeScript theme={null} skribble.signature_request.signer.replace(signatureRequestId: string, signers: Types.SignerRequest[]): Promise ``` Signer's e-mail address ID of the SignatureRequest object Given title for the signature request Given message that is shown to the participants ID of the Document object Given legislation of the signatures for this signature request Given quality of the signatures for this signature request Deprecated. Please use the signing\_url inside the user's Signature entry Status of the signature request Array of signatures within this signature request Given array of email-addresses that will be additionally notified upon completed signature request Creator of the SignatureRequest object Array of users with read access on the signature request Array of users with write access on the signature request Timestamp at which the signature request was created Timestamp at which the signature request was last updated Array of attachments associated with this signature request ## Add Attachment Add an attachment to a signature request. ```python Python theme={null} skribble.signature_request.attachment.add(signature_request_id: str, attachment: AttachmentRequest) -> List[AttachmentResponse] ``` ```typescript TypeScript theme={null} skribble.signature_request.attachment.add(signatureRequestId: string, attachment: Types.AttachmentRequest): Promise ``` Name of the attachment file Content type of the attachment Base64 encoded content of the attachment ID of the attachment Name of the attachment file ## List Attachments List all attachments for a signature request. ```python Python theme={null} skribble.signature_request.attachment.list(signature_request_id: str) -> List[AttachmentResponse] ``` ```typescript TypeScript theme={null} skribble.signature_request.attachment.list(signatureRequestId: string): Promise ``` ID of the attachment Name of the attachment file ## Download Attachment Download an attachment's content. ```python Python theme={null} skribble.signature_request.attachment.download(signature_request_id: str, attachment_id: str) -> bytes ``` ```typescript TypeScript theme={null} skribble.signature_request.attachment.download(signatureRequestId: string, attachmentId: string): Promise ``` ## Delete Attachment Delete an attachment from a signature request. ```python Python theme={null} skribble.signature_request.attachment.delete(signature_request_id: str, attachment_id: str) -> None ``` ```typescript TypeScript theme={null} skribble.signature_request.attachment.delete(signatureRequestId: string, attachmentId: string): Promise ```