Signature Attachment

Server

Endpoints for managing attachments on a signature request.

Add an attachment to a signature request

POST

https://api.skribble.com/v3

/signature-requests/{SR_ID}/attachments

Use this endpoint to provide supplementary documents (for example, Terms & Conditions or appendices) to participants of a SignatureRequest.

Attachments are delivered to participants together with the SignatureRequest.

Content type limits: The Skribble API accepts PDF files, image files, Microsoft Office files, and plain text files.

Allowed content types:

application/pdf
application/x-tika-msoffice
application/x-tika-ooxml
application/msword
application/vnd.openxmlformats-officedocument.wordprocessingml.document
application/vnd.ms-word.document.macroEnabled.12
application/vnd.ms-excel
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.ms-excel.sheet.macroenabled.12
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.ms-powerpoint.presentation.macroEnabled.12
image/gif
image/jpeg
image/png
text/plain

Content size limits: The maximum size of a single attachment is approximately 40 MB. The maximum request size is 60 MB.

Amount limits: There is currently no limit on the number of attachments per SignatureRequest. Abuse of this service may result in enforced limits.

Add an attachment to a signature request › path Parameters

SR_ID

string · uuid · required

Unique ID received when creating the Signature Request object

Add an attachment to a signature request › Request Body

CreateSignatureAttachmentRequest

filename

string · required

File name of the attachment.

content_type

string · required

Content type of the attachment. Supported types: application/pdf, application/x-tika-msoffice, application/x-tika-ooxml, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.ms-word.document.macroEnabled.12, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel.sheet.macroenabled.12, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.ms-powerpoint.presentation.macroEnabled.12, image/gif, image/jpeg, image/png, text/plain

content

string · byte · required

Base64 encoded bytes of the attachment.

Add an attachment to a signature request › Responses

SignatureResponse

id

string · uuid

title

string

message

string

document_id

string · uuid

legislation

SignatureLegislation · enum

Legislation under which the signatures are created. Required when quality is QES or AES_MINIMAL.

Legislation	Description
ZERTES	QES according to Swiss law. This is the default.
EIDAS	QES according to EU law.

Enum values:

ZERTES

EIDAS

quality

SignatureQuality · enum

Minimal quality of the signatures for this signature request.

Quality	Description
QES	Every signer must use QES. This is the default quality. Requires a `legislation` parameter.
AES	Signers will use AES if available, otherwise fall back to QES.
AES_MINIMAL	Signers will use QES if available, otherwise AES. At least AES is guaranteed. Requires a `legislation` parameter.
SES	Every signer uses SES.
DEMO	Every signer uses a DEMO signature with no legal binding. API demo users (`api_demo_example_*`) get this quality by default.
PART11	Signers use a signature compliant with 21 CFR Part 11 regulations.

Enum values:

SES

AES

AES_MINIMAL

QES

DEMO

PART11

signing_url

string · uri

The URL for the SignatureRequest owner to view and manage the request in the Skribble web application. This URL is not intended for signers — each signer has their own dedicated signing_url within the signatures array.

status_overall

SignatureStatusOverall · enum

Overall signing status of the document.

Possible values:

OPEN At least one user has not signed or declined their signature yet.
DECLINED At least one user declined to sign. The signature request failed.
WITHDRAWN The owner has withdrawn the signature request.
SIGNED All users signed the document. The signature request was successfully completed.
EXPIRED The owner-set expires_at date has passed before all signers signed. Terminal status.
ERROR A technical error occurred. The signature request cannot be completed.

Enum values:

OPEN

DECLINED

WITHDRAWN

SIGNED

EXPIRED

ERROR

business

string

SignatureRecipientResponse[]

cc_email_addresses

string[]

auto_delete_at

string · date

Server-managed date on which this signature request and its related documents are automatically deleted in line with the owning business's retention policy. Not directly settable by API clients. May be absent or null when no retention policy applies.

expires_at

string · date

Owner-set expiry date for this signature request. When this date passes, the request transitions to status_overall=EXPIRED. Set via expires_at at create time. Absent or null when no owner-set expiry has been configured.

SignatureAttachment[]

attach_on_success

string[]

When a SignatureRequest has been signed by all signers, all signers and all observers are notified by email. Skribble provides the option to attach two types of attachments automatically to this email:

the signed document and
the signature protocol.

This can be configured via the business settings, which can be used to define that these documents should generally be attached for all SignatureRequests created by business members.

Alternatively it is possible to define the attachments on demand per SignatureRequest by using this field.

Enum values:

SIGNED_DOCUMENT

SIGNATURE_PROTOCOL

custom

string

Custom field for storing application-specific data related to this signature request.

owner

string

read_access

string[]

Users or API keys with read access to this signature request.

write_access

string[]

Users or API keys with write access to this signature request.

created_at

string · date-time

updated_at

string · date-time

callback_success_url

string · uri

Callback URL called on overall success. See the request schema for supported placeholders and retry behaviour.

callback_error_url

string · uri

Callback URL called when a signer declines or the request is withdrawn. See the request schema for supported placeholders and retry behaviour.

callback_update_url

string · uri

Callback URL called on any update (e.g. one signer signed). See the request schema for supported placeholders and retry behaviour.

callback_start_sign_url

string · uri

Callback URL called when a signer starts the signature process (only for xQES). See the request schema for supported placeholders and retry behaviour.

callback_ident_pending_url

string · uri

Callback URL called when the identification of a signer requires manual review. See the request schema for supported placeholders and retry behaviour.

callback_ident_error_url

string · uri

Callback URL called when the identification of a signer ends in an error. See the request schema for supported placeholders and retry behaviour.

POST/signature-requests/{SR_ID}/attachments

curl https://api.skribble.com/v3/signature-requests/:SR_ID/attachments \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "filename": "Attachment-1.pdf",
  "content_type": "application/pdf",
  "content": "SGVsbG8gd29ybGQh"
}'

Example Request Body

{
  "filename": "Attachment-1.pdf",
  "content_type": "application/pdf",
  "content": "SGVsbG8gd29ybGQh"
}

json

application/json

Example Responses

{
  "id": "4f43614a-de50-bfe1-2df3-4c881fc7840e",
  "title": "Sample document",
  "message": "Please sign this document.",
  "document_id": "1ff0cf91-6b54-f3bd-bffb-8fcd5e799764",
  "attachments": [
    {
      "attachment_id": "8ed33046-3798-8c54-0b13-0820d0d6e121",
      "filename": "Attachment.pdf"
    }
  ]
}

json

application/json

Get Signature Attachment content

GET

https://api.skribble.com/v3

/signature-requests/{SR_ID}/attachments/{ATTACHMENT_ID}/content

Downloads the content of the attachment identified by ATTACHMENT_ID for the SignatureRequest with the ID SR_ID.

Get Signature Attachment content › path Parameters

SR_ID

string · uuid · required

Unique ID received when creating the Signature Request object

ATTACHMENT_ID

string · uuid · required

Unique ID returned when the Signature Attachment is created.

Get Signature Attachment content › Responses

Binary attachment content.

string · binary

Remove an attachment from a signature request

DELETE

https://api.skribble.com/v3

/signature-requests/{SR_ID}/attachments/{ATTACHMENT_ID}

Deletes the attachment identified by ATTACHMENT_ID from the SignatureRequest with the ID SR_ID.

Remove an attachment from a signature request › path Parameters

SR_ID

string · uuid · required

Unique ID received when creating the Signature Request object

ATTACHMENT_ID

string · uuid · required

Unique ID returned when the Signature Attachment is created.

Remove an attachment from a signature request › Responses

No data returned

Signature Observer Signature Handling

Add an attachment to a signature request

POST

https://api.skribble.com/v3

/signature-requests/{SR_ID}/attachments

Use this endpoint to provide supplementary documents (for example, Terms & Conditions or appendices) to participants of a SignatureRequest.

Attachments are delivered to participants together with the SignatureRequest.

Content type limits: The Skribble API accepts PDF files, image files, Microsoft Office files, and plain text files.

Allowed content types:

application/pdf
application/x-tika-msoffice
application/x-tika-ooxml
application/msword
application/vnd.openxmlformats-officedocument.wordprocessingml.document
application/vnd.ms-word.document.macroEnabled.12
application/vnd.ms-excel
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.ms-excel.sheet.macroenabled.12
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.ms-powerpoint.presentation.macroEnabled.12
image/gif
image/jpeg
image/png
text/plain

Content size limits: The maximum size of a single attachment is approximately 40 MB. The maximum request size is 60 MB.

Amount limits: There is currently no limit on the number of attachments per SignatureRequest. Abuse of this service may result in enforced limits.

Add an attachment to a signature request › path Parameters

SR_ID

string · uuid · required

Unique ID received when creating the Signature Request object

Add an attachment to a signature request › Request Body

CreateSignatureAttachmentRequest

filename

string · required

File name of the attachment.

content_type

string · required

content

string · byte · required

Base64 encoded bytes of the attachment.

Add an attachment to a signature request › Responses

SignatureResponse

id

string · uuid

title

string

message

string

document_id

string · uuid

legislation

SignatureLegislation · enum

Legislation under which the signatures are created. Required when quality is QES or AES_MINIMAL.

Legislation	Description
ZERTES	QES according to Swiss law. This is the default.
EIDAS	QES according to EU law.

Enum values:

ZERTES

EIDAS

quality

SignatureQuality · enum

Minimal quality of the signatures for this signature request.

Quality	Description
QES	Every signer must use QES. This is the default quality. Requires a `legislation` parameter.
AES	Signers will use AES if available, otherwise fall back to QES.
AES_MINIMAL	Signers will use QES if available, otherwise AES. At least AES is guaranteed. Requires a `legislation` parameter.
SES	Every signer uses SES.
DEMO	Every signer uses a DEMO signature with no legal binding. API demo users (`api_demo_example_*`) get this quality by default.
PART11	Signers use a signature compliant with 21 CFR Part 11 regulations.

Enum values:

SES

AES

AES_MINIMAL

QES

DEMO

PART11

signing_url

string · uri

status_overall

SignatureStatusOverall · enum

Overall signing status of the document.

Possible values:

OPEN At least one user has not signed or declined their signature yet.
DECLINED At least one user declined to sign. The signature request failed.
WITHDRAWN The owner has withdrawn the signature request.
SIGNED All users signed the document. The signature request was successfully completed.
EXPIRED The owner-set expires_at date has passed before all signers signed. Terminal status.
ERROR A technical error occurred. The signature request cannot be completed.

Enum values:

OPEN

DECLINED

WITHDRAWN

SIGNED

EXPIRED

ERROR

business

string

SignatureRecipientResponse[]

cc_email_addresses

string[]

auto_delete_at

string · date

expires_at

string · date

SignatureAttachment[]

attach_on_success

string[]

the signed document and
the signature protocol.

This can be configured via the business settings, which can be used to define that these documents should generally be attached for all SignatureRequests created by business members.

Alternatively it is possible to define the attachments on demand per SignatureRequest by using this field.

Enum values:

SIGNED_DOCUMENT

SIGNATURE_PROTOCOL

custom

string

Custom field for storing application-specific data related to this signature request.

owner

string

read_access

string[]

Users or API keys with read access to this signature request.

write_access

string[]

Users or API keys with write access to this signature request.

created_at

string · date-time

updated_at

string · date-time

callback_success_url

string · uri

Callback URL called on overall success. See the request schema for supported placeholders and retry behaviour.

callback_error_url

string · uri

Callback URL called when a signer declines or the request is withdrawn. See the request schema for supported placeholders and retry behaviour.

callback_update_url

string · uri

Callback URL called on any update (e.g. one signer signed). See the request schema for supported placeholders and retry behaviour.

callback_start_sign_url

string · uri

Callback URL called when a signer starts the signature process (only for xQES). See the request schema for supported placeholders and retry behaviour.

callback_ident_pending_url

string · uri

Callback URL called when the identification of a signer requires manual review. See the request schema for supported placeholders and retry behaviour.

callback_ident_error_url

string · uri

Callback URL called when the identification of a signer ends in an error. See the request schema for supported placeholders and retry behaviour.

Get Signature Attachment content

GET

https://api.skribble.com/v3

/signature-requests/{SR_ID}/attachments/{ATTACHMENT_ID}/content

Downloads the content of the attachment identified by ATTACHMENT_ID for the SignatureRequest with the ID SR_ID.

Get Signature Attachment content › path Parameters

SR_ID

string · uuid · required

Unique ID received when creating the Signature Request object

ATTACHMENT_ID

string · uuid · required

Unique ID returned when the Signature Attachment is created.

Get Signature Attachment content › Responses

Binary attachment content.

string · binary

Remove an attachment from a signature request

DELETE

https://api.skribble.com/v3

/signature-requests/{SR_ID}/attachments/{ATTACHMENT_ID}

Deletes the attachment identified by ATTACHMENT_ID from the SignatureRequest with the ID SR_ID.

Remove an attachment from a signature request › path Parameters

SR_ID

string · uuid · required

Unique ID received when creating the Signature Request object

ATTACHMENT_ID

string · uuid · required

Unique ID returned when the Signature Attachment is created.

Remove an attachment from a signature request › Responses

No data returned