sproof Sign (Preview)

Use sproof Sign to automate safe electronic signature workflows for PDF and DOCX documents. Organizations can create or prepare single or multi-document signature requests, assign recipients and signing roles, list and track documents, download completed PDFs, and delete documents. A sproof Sign account, a plan that supports the selected actions and signature types, and a valid API token are required.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name API Support
URL https://sproof.com
Email support@sproof.com
Connector Metadata
Publisher sproof GmbH
Website https://www.sproof.com/en/sign/
Privacy policy https://www.sproof.com/en/privacy-policy-app/
Categories Productivity;Content and Files

sproof Sign

Overview

sproof Sign enables organizations to automate electronic signature workflows for PDF and DOCX documents. The connector can create or prepare single-document signature requests or multi-document envelopes, assign recipients and signing roles, list documents, retrieve request status, download completed documents, and delete documents.

Updates in this version

  • Added Prepare signature request to create a draft without inviting recipients.
  • Added Get documents to list, filter, sort, and search documents.
  • No breaking changes to existing connector actions.

Prerequisites

To use the connector, you need:

  • A sproof Sign account.
  • A sproof Sign plan with API access and support for the required actions and signature types.
  • A valid sproof Sign API token.

Authentication

The connector uses API-token authentication. Create a connection by entering a valid sproof Sign API token associated with your account. Keep the token secure and replace it if it gets revoked or regenerated.

Supported actions

  • Create signature request — Creates a request for one document or an envelope containing multiple documents. Recipients, signing roles, signing order, signature positions, and other invitation settings can be configured.
  • Create signature request using placeholders — Creates a request using placeholders stored in an uploaded document. Recipient information and signature positions are extracted from those placeholders.
  • Prepare signature request — Creates a draft signature request without inviting recipients. The returned member ID can be used to open and prepare the document in the sproof Sign editor.
  • Get documents — Lists documents available to the connected sproof Sign account. Pagination, filtering, sorting, and search options can be used to narrow the result.
  • Get request status — Retrieves the current state and signing status of a signature request using its member ID.
  • Get document — Downloads a document as a binary PDF or as a Base64-encoded PDF.
  • Delete document — Deletes a document or removes a member’s access, depending on the supplied member ID, the member’s role, and whether the document belongs to an envelope.

Known limitations and requirements

  • Input documents must be supplied as Base64-encoded PDF or DOCX content.
  • An envelope can contain a maximum of 25 documents.
  • An envelope name is required when more than one document is submitted.
  • Placeholder-based requests require correctly formatted placeholders in the uploaded document.
  • For placeholder-based requests, recipients and signature positions are obtained from the document rather than entered manually.
  • Available actions, signature types, and providers depend on the connected sproof Sign account and plan.
  • Document deletion behavior depends on whether the supplied member ID belongs to the sender or a recipient and whether the document is part of an envelope.

Support

For connector or API support, contact support@sproof.com.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
token securestring "token" für diese API True

Actions

Create signature request

This is the new create signature request. In addition to creating a single document invitation, it now supports creating envelopes and uploading multiple documents at once when sending invitations.
Create signature request using placeholders

Creates a signature request using placeholders stored in the uploaded document. Recipients and signature positions are extracted from the document.
Delete document

Deletes a document or removes a member's access to it, depending on whether the provided memberId belongs to the sender or a recipient, and whether the document is part of an envelope.

Documents in an envelope

The query parameter all has no effect for documents in an envelope.

With the sender memberId:

  • A single document is deleted for the sender and all recipients.
  • The document is removed from the envelope.

With the recipient memberId:

  • All documents in the envelope are removed for the recipient.
  • The recipient is marked as declined on all documents that were deleted for the recipient.
  • The documents remain available for all other members on the document.

Single documents

With the sender memberId and all=true:

  • The document is deleted for the sender and all recipients.

With the sender memberId and all=false:

  • The document is deleted only for the sender.
  • The document remains available for the other recipients on the document.

With the recipient memberId:

  • The recipient is marked as declined on the document.
  • The document remains available for all other members on the document.
Get document

Get signed document as binary or Base64-encoded string.
Get documents

Returns documents created by the API token holder (authenticated user), regardless of whether those documents were created through the UI or via the API.

Documents created by other members of the same plan are not included. When role management is enabled for your plan, each user can have their own API token.
Get request status

Get the status of a signature request. Returns a document JSON object or an error. The parameter is returned by the post request on document and is associated with the senders email.
Prepare signature request

Creates a draft signature request without inviting recipients. Use the returned member ID to open the document in the sproof Sign editor.

Create signature request

Operation ID:
CreateSignatureRequest

This is the new create signature request. In addition to creating a single document invitation, it now supports creating envelopes and uploading multiple documents at once when sending invitations.

Parameters

Name Key Required Type Description
email
 email True string

Email of the sender. It must belong to a member of your plan.
firstName
 firstName True string

First name of the sender.
lastName
 lastName string

Last name of the sender.
role
 role string

The role of the sender on all documents.
email
 email string

Email of the recipient.
firstName
 firstName string

First name of the recipient.
lastName
 lastName string

Last name of the recipient.
doNotSendEmails
 doNotSendEmails boolean

If set to true no email is sent to the recipient.
customId
 customId string

To be used only when the recipient's email address is unknown at the time of inviting. This only works when you invite the recipients (not for prepare routes) and you want to use fastlane. The customId allows you to pre-generate a unique signing link for a recipient before sending an invitation. Must be a unique, alphanumeric string of at least 70 characters.

Note: The customId can only be used to build the recipient link to a document. It can not be used for other requests instead of the memberId. For details on URL construction, see Opening a document with a Custom ID
useFastlane
 useFastlane boolean

If set to true the signer receives a Fastlane link in the invitation email.
phoneNumber
 phoneNumber string

The phone number of this recipient. This is used for SMS verification. (eg: +43 699 1234 1234).
privateMessage
 privateMessage string

A private message for this specific recipient.
inPersonMode
 inPersonMode boolean

When this option is enabled, the recipient of the signature request will be required to sign the document in person and no email is sent. This mode is only available using the SES signature type
signatureTypes
 signatureTypes array of string

The signature type allowed for this recipient. At most one value is supported. Options: 'advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple'
tag
 tag string

This tag determines the identity provider that will be used for the signing process. Choose from a predefined set of supported providers.

Note1: Some providers are only available for certain signatureTypes, for example onetimeqes will require "signatureType" : ["qualifiedPlusIdent"]

Note2: When using sproof-qualified as default provider the recipient has to have an active sproof account with an active User+ licence.
canChange
 canChange boolean

Boolean to indicate if the invited recipient should be able to change the signature provider
country
 country string

The default country, if blank it's set to all, an error will be returned with what countries are available for the provider tag chosen
dueDate
 dueDate YYYY-MM-DD

The date until which the document can be signed. This due date is displayed to the recipient in the invite email and is also visible in the document details section of the dashboard. It serves as a deadline for completing the signing process.
reminderInterval
 reminderInterval number

Specifies the number of days between reminder emails.
startSendingReminders
 startSendingReminders YYYY-MM-DD HH:MM

Date from which reminders should be sent out
inviteLanguage
 inviteLanguage string

Specifies the language of the emails sent to anonymous users who do not have an account. For users with an account, the language they have selected in their profile will be used instead.
message
 message string

A custom message sent to the recipients within the email.
subject
 subject string

The subject line of the email sent to the recipients.
sendOutFinishedPdf
 sendOutFinishedPdf boolean

If set to true, the pdf is sent as an attachment to all recipients on the document (If it is smaller than 5MB).
focusedSigningMode
 focusedSigningMode boolean

When this option is enabled, the recipient of the signature request will be limited to signing or declining the document, and will not be able to navigate away from the page.
allowForwarding
 allowForwarding boolean

Allow forwarding of the invite.
collabSigningMode
 collabSigningMode object

An object where each key represents a signing round, and its corresponding value indicates whether collaborative signing is enabled for that round. If the value is true, only one signature is required to complete the specified signing round and proceed to the next round. For example, { '1': true } means that in signing round '1', only one signature is necessary.
usePlaceholders
 usePlaceholders boolean

If true, text placeholders/formFields stored in the document wil be used for inviting recipients.
inPersonSigning
 inPersonSigning boolean

When true, the recipient gets a popup where he needs to manually draw a signature
folderName
 folderName string

If given, an envelope will be created containing all documents in documentDataArray. (Required if more than one document is sent)
callbackUrl
 callbackUrl string

A POST request, including the document, will be sent to this URL when a new signature is created or when a recipient declines the document. In case of failure, a retry mechanism is in place to ensure the request is retried.
returnUrl
 returnUrl string

The link of the return button after signing a document
returnBtnText
 returnBtnText string

The text of the return button after signing a document
data
 data True string

The document (PDF or DOCX) data in base64 format.
mimetype
 mimetype string

MIME type of base64 encoded data PDF or DOCX, required if the document is not a pdf
fileName
 fileName True string

Name of the file
label
 label string

A custom label that can be sent to organize documents.
page
 page True integer

Number of the page the box is on, with the first page being 0.
pageWidth
 pageWidth number

Any integer value describing the page width. The larger the number, the better the precision when positioning the box in x y space. On an A4 page, we have 478 as a default value.
pageHeight
 pageHeight number

Any integer value describing the page height. The larger the number, the better the precision when positioning the box in x y space. On an A4 page, we have 676 as a default value.
x
 x True float

Represents the horizontal position of the box as a percentage of the page width. The origin (0,0) is at the top left of the page. A value of 0.1 means the box is positioned at 10% of the page width from the left.
y
 y True float

Represents the vertical position of the box as a percentage of the page height. The origin (0,0) is at the top left of the page. A value of 0.1 means the box is positioned at 10% of the page height from the top.
width
 width True float

Width of the box based on page dimensions, similar to the x and y coordinates. It's a float representing a percentage of the pageWidth.
height
 height True float

Height of the box based on page dimensions, similar to the x and y coordinates. It's a float representing a percentage of the pageHeight.
id
 id True string

A unique ID for this box, generated in any way you wish.
label
 label string

Placeholder text, such as the name of the field, e.g., "Date of Birth.".
value
 value string

Default value for the box. Can be null. If the box is of type 'chooseBox', the value can be null or one of the strings defined in the options.
fieldId
 fieldId string

A stable field identifier configured in the UI. Used to pre-fill workflow form fields via API requests.
readonly
 readonly boolean

If set to true, the invited person cannot modify the value of this box.
required
 required boolean

If set to true, the invited person cannot sign the document without filling out this box.
type
 type True string
multiline
 multiline boolean

Whether multiple lines are allowed.
displayValue
 displayValue True string
exportValue
 exportValue True string
group
 group number

Each radio box can be assigned to a group.
signatureTypes
 signatureTypes array of string

The signature type allowed for this document, can be overwritten by recipient signature type. At most one value is supported. Options: 'advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent'
refId
 refId string

The refId is an optional field used to cross-reference the uploaded document. If provided, it allows you to assign a custom reference identifier to the document, which will be returned as part of the document object in future API responses. This can be useful for tracking or organizing documents by an external system or workflow.
language
 language string

The document language.
folderId
 folderId string

The ID of a folder into which the documents should be inserted. This is only possible when both inviteData and folderName are undefined.
isAttachment
 isAttachment boolean

isAttachment is not needed in this case.
Recipient details
 recipientDetails True object

Recipient details keyed by recipient email. Example: {"mail@test.com":{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}]}}.
useFastlane
 useFastlane boolean

If set to true the signer receives a Fastlane link in the invitation email.
fastlaneProfileId
 fastlaneProfileId uuid

Specify the Fastlane profile which should be used with this document. (useFastlane must be set to true).

Returns

Body
EnvelopeResponse

Create signature request using placeholders

Operation ID:
CreateSignatureRequestUsingPlaceholders

Creates a signature request using placeholders stored in the uploaded document. Recipients and signature positions are extracted from the document.

Parameters

Name Key Required Type Description
email
 email True string

Email of the sender. It must belong to a member of your plan.
firstName
 firstName True string

First name of the sender.
lastName
 lastName string

Last name of the sender.
role
 role string

The role of the sender on all documents.
email
 email string

Email of the recipient.
firstName
 firstName string

First name of the recipient.
lastName
 lastName string

Last name of the recipient.
doNotSendEmails
 doNotSendEmails boolean

If set to true no email is sent to the recipient.
customId
 customId string

To be used only when the recipient's email address is unknown at the time of inviting. This only works when you invite the recipients (not for prepare routes) and you want to use fastlane. The customId allows you to pre-generate a unique signing link for a recipient before sending an invitation. Must be a unique, alphanumeric string of at least 70 characters.

Note: The customId can only be used to build the recipient link to a document. It can not be used for other requests instead of the memberId. For details on URL construction, see Opening a document with a Custom ID
useFastlane
 useFastlane boolean

If set to true the signer receives a Fastlane link in the invitation email.
phoneNumber
 phoneNumber string

The phone number of this recipient. This is used for SMS verification. (eg: +43 699 1234 1234).
privateMessage
 privateMessage string

A private message for this specific recipient.
inPersonMode
 inPersonMode boolean

When this option is enabled, the recipient of the signature request will be required to sign the document in person and no email is sent. This mode is only available using the SES signature type
signatureTypes
 signatureTypes array of string

The signature type allowed for this recipient. At most one value is supported. Options: 'advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple'
tag
 tag string

This tag determines the identity provider that will be used for the signing process. Choose from a predefined set of supported providers.

Note1: Some providers are only available for certain signatureTypes, for example onetimeqes will require "signatureType" : ["qualifiedPlusIdent"]

Note2: When using sproof-qualified as default provider the recipient has to have an active sproof account with an active User+ licence.
canChange
 canChange boolean

Boolean to indicate if the invited recipient should be able to change the signature provider
country
 country string

The default country, if blank it's set to all, an error will be returned with what countries are available for the provider tag chosen
dueDate
 dueDate YYYY-MM-DD

The date until which the document can be signed. This due date is displayed to the recipient in the invite email and is also visible in the document details section of the dashboard. It serves as a deadline for completing the signing process.
reminderInterval
 reminderInterval number

Specifies the number of days between reminder emails.
startSendingReminders
 startSendingReminders YYYY-MM-DD HH:MM

Date from which reminders should be sent out
inviteLanguage
 inviteLanguage string

Specifies the language of the emails sent to anonymous users who do not have an account. For users with an account, the language they have selected in their profile will be used instead.
message
 message string

A custom message sent to the recipients within the email.
subject
 subject string

The subject line of the email sent to the recipients.
sendOutFinishedPdf
 sendOutFinishedPdf boolean

If set to true, the pdf is sent as an attachment to all recipients on the document (If it is smaller than 5MB).
focusedSigningMode
 focusedSigningMode boolean

When this option is enabled, the recipient of the signature request will be limited to signing or declining the document, and will not be able to navigate away from the page.
allowForwarding
 allowForwarding boolean

Allow forwarding of the invite.
collabSigningMode
 collabSigningMode object

An object where each key represents a signing round, and its corresponding value indicates whether collaborative signing is enabled for that round. If the value is true, only one signature is required to complete the specified signing round and proceed to the next round. For example, { '1': true } means that in signing round '1', only one signature is necessary.
inPersonSigning
 inPersonSigning boolean

When true, the recipient gets a popup where he needs to manually draw a signature
folderName
 folderName string

If given, an envelope will be created containing all documents in documentDataArray. (Required if more than one document is sent)
callbackUrl
 callbackUrl string

A POST request, including the document, will be sent to this URL when a new signature is created or when a recipient declines the document. In case of failure, a retry mechanism is in place to ensure the request is retried.
returnUrl
 returnUrl string

The link of the return button after signing a document
returnBtnText
 returnBtnText string

The text of the return button after signing a document
data
 data True string

The document (PDF or DOCX) data in base64 format.
mimetype
 mimetype string

MIME type of base64 encoded data PDF or DOCX, required if the document is not a pdf
fileName
 fileName True string

Name of the file
label
 label string

A custom label that can be sent to organize documents.
page
 page True integer

Number of the page the box is on, with the first page being 0.
pageWidth
 pageWidth number

Any integer value describing the page width. The larger the number, the better the precision when positioning the box in x y space. On an A4 page, we have 478 as a default value.
pageHeight
 pageHeight number

Any integer value describing the page height. The larger the number, the better the precision when positioning the box in x y space. On an A4 page, we have 676 as a default value.
x
 x True float

Represents the horizontal position of the box as a percentage of the page width. The origin (0,0) is at the top left of the page. A value of 0.1 means the box is positioned at 10% of the page width from the left.
y
 y True float

Represents the vertical position of the box as a percentage of the page height. The origin (0,0) is at the top left of the page. A value of 0.1 means the box is positioned at 10% of the page height from the top.
width
 width True float

Width of the box based on page dimensions, similar to the x and y coordinates. It's a float representing a percentage of the pageWidth.
height
 height True float

Height of the box based on page dimensions, similar to the x and y coordinates. It's a float representing a percentage of the pageHeight.
id
 id True string

A unique ID for this box, generated in any way you wish.
label
 label string

Placeholder text, such as the name of the field, e.g., "Date of Birth.".
value
 value string

Default value for the box. Can be null. If the box is of type 'chooseBox', the value can be null or one of the strings defined in the options.
fieldId
 fieldId string

A stable field identifier configured in the UI. Used to pre-fill workflow form fields via API requests.
readonly
 readonly boolean

If set to true, the invited person cannot modify the value of this box.
required
 required boolean

If set to true, the invited person cannot sign the document without filling out this box.
type
 type True string
multiline
 multiline boolean

Whether multiple lines are allowed.
displayValue
 displayValue True string
exportValue
 exportValue True string
group
 group number

Each radio box can be assigned to a group.
signatureTypes
 signatureTypes array of string

The signature type allowed for this document, can be overwritten by recipient signature type. At most one value is supported. Options: 'advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent'
refId
 refId string

The refId is an optional field used to cross-reference the uploaded document. If provided, it allows you to assign a custom reference identifier to the document, which will be returned as part of the document object in future API responses. This can be useful for tracking or organizing documents by an external system or workflow.
language
 language string

The document language.
folderId
 folderId string

The ID of a folder into which the documents should be inserted. This is only possible when both inviteData and folderName are undefined.
isAttachment
 isAttachment boolean

isAttachment is not needed in this case.
useFastlane
 useFastlane boolean

If set to true the signer receives a Fastlane link in the invitation email.
fastlaneProfileId
 fastlaneProfileId uuid

Specify the Fastlane profile which should be used with this document. (useFastlane must be set to true).

Returns

Body
EnvelopeResponse

Delete document

Operation ID:
DeleteDocument

Deletes a document or removes a member's access to it, depending on whether the provided memberId belongs to the sender or a recipient, and whether the document is part of an envelope.

Documents in an envelope

The query parameter all has no effect for documents in an envelope.

With the sender memberId:

  • A single document is deleted for the sender and all recipients.
  • The document is removed from the envelope.

With the recipient memberId:

  • All documents in the envelope are removed for the recipient.
  • The recipient is marked as declined on all documents that were deleted for the recipient.
  • The documents remain available for all other members on the document.

Single documents

With the sender memberId and all=true:

  • The document is deleted for the sender and all recipients.

With the sender memberId and all=false:

  • The document is deleted only for the sender.
  • The document remains available for the other recipients on the document.

With the recipient memberId:

  • The recipient is marked as declined on the document.
  • The document remains available for all other members on the document.

Parameters

Name Key Required Type Description
Member ID
 memberId True string

Member ID
Delete for all recipients
 all boolean

Only relevant for single documents when the provided memberId belongs to the sender. If set to true, the document is deleted for the sender and all recipients. If set to false, the document is deleted only for the sender and remains available for the other recipients. This parameter has no effect for documents in an envelope (default = true) or when the provided memberId belongs to a recipient.

Returns

response
DeleteDocumentResponse

Get document

Operation ID:
GetDocument

Get signed document as binary or Base64-encoded string.

Parameters

Name Key Required Type Description
Member ID
 memberId True string

Member ID
Download format
 format string

Specifies the response format. Use pdf for binary PDF and base64 for a Base64-encoded response. Example base64 response: json { "base64": "JVBERi0xLjQKJe..." }

Returns

Name Path Type Description
base64
 base64 string

Base64-encoded PDF content

Get documents

Operation ID:
GetDocumentList

Returns documents created by the API token holder (authenticated user), regardless of whether those documents were created through the UI or via the API.

Documents created by other members of the same plan are not included. When role management is enabled for your plan, each user can have their own API token.

Parameters

Name Key Required Type Description
Entries Per Page
 perPage integer

Specify the number of entries per page.
Page Number
 page integer

Specify the page number.
Document Filter
 view string

Specify the document filter.
Sort Documents
 sort string

Document sorting. Append ":true" for descending sorting.
Search Query
 query string

Search query for various information.

Behavior:

  • Generally case-insensitive
  • Single word or quoted phrase (e.g. "Quarterly Report") performs substring match
  • Multiple words separated by spaces (e.g. quarterly report Q1) must all match as substrings (AND condition)
  • Fields searched: document name, member emails, member first/last names, folder name
  • Wildcards/regex are not supported
  • If the internal search index is not updated yet, only the document name is searched
Label Filter
 labels string

Filter documents by label name.
Created From
 startDate date-time

Filters the results starting from a specific createdAt date and time in UTC format (does not filter by updatedAt). Use this parameter in combination with 'endDate' to define a time range.
Created Until
 endDate date-time

Filters the results ending at a specific createdAt date and time in UTC format (does not filter by updatedAt). Use this parameter in combination with 'startDate' to define a time range.

Returns

Response object for document list operations

Document List Response
_DocumentListResponse

Get request status

Operation ID:
GetSignatureStatus

Get the status of a signature request. Returns a document JSON object or an error. The parameter is returned by the post request on document and is associated with the senders email.

Parameters

Name Key Required Type Description
Member ID
 memberId True string

Member ID

Returns

Body
DocumentStatusForFlow

Prepare signature request

Operation ID:
PrepareSignatureRequest

Creates a draft signature request without inviting recipients. Use the returned member ID to open the document in the sproof Sign editor.

Parameters

Name Key Required Type Description
email
 email True string

Email of the sender. It must belong to a member of your plan.
firstName
 firstName True string

First name of the sender.
lastName
 lastName string

Last name of the sender.
role
 role string

The role of the sender on all documents.
email
 email string

Email of the recipient.
firstName
 firstName string

First name of the recipient.
lastName
 lastName string

Last name of the recipient.
doNotSendEmails
 doNotSendEmails boolean

If set to true no email is sent to the recipient.
customId
 customId string

To be used only when the recipient's email address is unknown at the time of inviting. This only works when you invite the recipients (not for prepare routes) and you want to use fastlane. The customId allows you to pre-generate a unique signing link for a recipient before sending an invitation. Must be a unique, alphanumeric string of at least 70 characters.

Note: The customId can only be used to build the recipient link to a document. It can not be used for other requests instead of the memberId. For details on URL construction, see Opening a document with a Custom ID
useFastlane
 useFastlane boolean

If set to true the signer receives a Fastlane link in the invitation email.
phoneNumber
 phoneNumber string

The phone number of this recipient. This is used for SMS verification. (eg: +43 699 1234 1234).
privateMessage
 privateMessage string

A private message for this specific recipient.
inPersonMode
 inPersonMode boolean

When this option is enabled, the recipient of the signature request will be required to sign the document in person and no email is sent. This mode is only available using the SES signature type
signatureTypes
 signatureTypes array of string

The signature type allowed for this recipient. At most one value is supported. Options: 'advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple'
tag
 tag string

This tag determines the identity provider that will be used for the signing process. Choose from a predefined set of supported providers.

Note1: Some providers are only available for certain signatureTypes, for example onetimeqes will require "signatureType" : ["qualifiedPlusIdent"]

Note2: When using sproof-qualified as default provider the recipient has to have an active sproof account with an active User+ licence.
canChange
 canChange boolean

Boolean to indicate if the invited recipient should be able to change the signature provider
country
 country string

The default country, if blank it's set to all, an error will be returned with what countries are available for the provider tag chosen
dueDate
 dueDate YYYY-MM-DD

The date until which the document can be signed. This due date is displayed to the recipient in the invite email and is also visible in the document details section of the dashboard. It serves as a deadline for completing the signing process.
reminderInterval
 reminderInterval number

Specifies the number of days between reminder emails.
startSendingReminders
 startSendingReminders YYYY-MM-DD HH:MM

Date from which reminders should be sent out
inviteLanguage
 inviteLanguage string

Specifies the language of the emails sent to anonymous users who do not have an account. For users with an account, the language they have selected in their profile will be used instead.
message
 message string

A custom message sent to the recipients within the email.
subject
 subject string

The subject line of the email sent to the recipients.
sendOutFinishedPdf
 sendOutFinishedPdf boolean

If set to true, the pdf is sent as an attachment to all recipients on the document (If it is smaller than 5MB).
focusedSigningMode
 focusedSigningMode boolean

When this option is enabled, the recipient of the signature request will be limited to signing or declining the document, and will not be able to navigate away from the page.
allowForwarding
 allowForwarding boolean

Allow forwarding of the invite.
collabSigningMode
 collabSigningMode object

An object where each key represents a signing round, and its corresponding value indicates whether collaborative signing is enabled for that round. If the value is true, only one signature is required to complete the specified signing round and proceed to the next round. For example, { '1': true } means that in signing round '1', only one signature is necessary.
usePlaceholders
 usePlaceholders boolean

If true, text placeholders/formFields stored in the document wil be used for inviting recipients.
inPersonSigning
 inPersonSigning boolean

When true, the recipient gets a popup where he needs to manually draw a signature
folderName
 folderName string

If given, an envelope will be created containing all documents in documentDataArray. (Required if more than one document is sent)
callbackUrl
 callbackUrl string

A POST request, including the document, will be sent to this URL when a new signature is created or when a recipient declines the document. In case of failure, a retry mechanism is in place to ensure the request is retried.
returnUrl
 returnUrl string

The link of the return button after signing a document
returnBtnText
 returnBtnText string

The text of the return button after signing a document
data
 data True string

The document (PDF or DOCX) data in base64 format.
mimetype
 mimetype string

MIME type of base64 encoded data PDF or DOCX, required if the document is not a pdf
fileName
 fileName True string

Name of the file
label
 label string

A custom label that can be sent to organize documents.
page
 page True integer

Number of the page the box is on, with the first page being 0.
pageWidth
 pageWidth number

Any integer value describing the page width. The larger the number, the better the precision when positioning the box in x y space. On an A4 page, we have 478 as a default value.
pageHeight
 pageHeight number

Any integer value describing the page height. The larger the number, the better the precision when positioning the box in x y space. On an A4 page, we have 676 as a default value.
x
 x True float

Represents the horizontal position of the box as a percentage of the page width. The origin (0,0) is at the top left of the page. A value of 0.1 means the box is positioned at 10% of the page width from the left.
y
 y True float

Represents the vertical position of the box as a percentage of the page height. The origin (0,0) is at the top left of the page. A value of 0.1 means the box is positioned at 10% of the page height from the top.
width
 width True float

Width of the box based on page dimensions, similar to the x and y coordinates. It's a float representing a percentage of the pageWidth.
height
 height True float

Height of the box based on page dimensions, similar to the x and y coordinates. It's a float representing a percentage of the pageHeight.
id
 id True string

A unique ID for this box, generated in any way you wish.
label
 label string

Placeholder text, such as the name of the field, e.g., "Date of Birth.".
value
 value string

Default value for the box. Can be null. If the box is of type 'chooseBox', the value can be null or one of the strings defined in the options.
fieldId
 fieldId string

A stable field identifier configured in the UI. Used to pre-fill workflow form fields via API requests.
readonly
 readonly boolean

If set to true, the invited person cannot modify the value of this box.
required
 required boolean

If set to true, the invited person cannot sign the document without filling out this box.
type
 type True string
multiline
 multiline boolean

Whether multiple lines are allowed.
displayValue
 displayValue True string
exportValue
 exportValue True string
group
 group number

Each radio box can be assigned to a group.
signatureTypes
 signatureTypes array of string

The signature type allowed for this document, can be overwritten by recipient signature type. At most one value is supported. Options: 'advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent'
refId
 refId string

The refId is an optional field used to cross-reference the uploaded document. If provided, it allows you to assign a custom reference identifier to the document, which will be returned as part of the document object in future API responses. This can be useful for tracking or organizing documents by an external system or workflow.
language
 language string

The document language.
folderId
 folderId string

The ID of a folder into which the documents should be inserted. This is only possible when both inviteData and folderName are undefined.
isAttachment
 isAttachment boolean

isAttachment is not needed in this case.
Recipient details
 recipientDetails True object

Recipient details keyed by recipient email. Example: {"mail@test.com":{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}]}}.
useFastlane
 useFastlane boolean

If set to true the signer receives a Fastlane link in the invitation email.
fastlaneProfileId
 fastlaneProfileId uuid

Specify the Fastlane profile which should be used with this document. (useFastlane must be set to true).

Returns

Body
PrepareSignatureRequestResponse

Definitions

DeleteDocumentResponse

Delete Document Response
string

_DocumentListResponse

Response object for document list operations

Name Path Type Description
data
 data array of _Document

List of documents
Pagination Object
 pagination _PaginationObject

_PaginationObject

Name Path Type Description
total
 total integer

Total number of elements (e.g., documents) in a view (e.g., allDocuments)
lastPage
 lastPage integer

Number of the last page
perPage
 perPage integer

Number of documents per page
currentPage
 currentPage integer

Number of the current page
to
 to integer

Index of the last document

_Document

Name Path Type Description
name
 name string

Document name
id
 id string

Document ID
updatedAt
 updatedAt date

Date of last document update
createdAt
 createdAt date

Creation date of document
signaturesTypes
 signaturesTypes array of string

The types of signatures that are allowed for this recipient, can be overwritten by recipient signature types. Options: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
callbackUrl
 callbackUrl string

A post request including the document will be sent to this Url when a new signature is created
returnUrl
 returnUrl string

The link of the return button after signing a document
returnBtnText
 returnBtnText string

The text of the return button after signing a document
inPersonSigning
 inPersonSigning boolean
signingRound
 signingRound number
state
 state string

The current state of the document. Possible values are: draft, pending, declined, completed, attachment, manuallyPending, manuallyCompleted
member
 member

Usually the owner of the document, but if you use getSignatureStatus the member will be one who's id is provided in the request
members
 members array of DocumentListMember

A list of invited contacts
boxes
 boxes array of DocumentListResponseBox

Signature position data with additional response-specific fields. The cardStyle, pageWidth, and pageHeight fields are optional and may not be present in all API responses.
refId
 refId string
allSignersSigned
 allSignersSigned boolean
allMembersSigned
 allMembersSigned boolean
focusedSigningMode
 focusedSigningMode boolean

DocumentListResponseBox

Name Path Type Description
id
 id string
fieldId
 fieldId string

The configured Field ID used to prefill form fields. Returns null if no Field ID is configured.
type
 type string
value
 value

The value of the box field. Can be a string (including empty string), boolean, or null depending on the box type.
label
 label string
readOnly
 readOnly boolean

DocumentListMember

Name Path Type Description
id
 id string

The member ID can be used to open the document within the sproof Sign editor. A more detailed description can be found here
email
 email string

Email of document owner
firstName
 firstName string

Firstname of document owner
lastName
 lastName string

Lastname of document owner
lastActivityAt
 lastActivityAt date-time

Date and time of last activity (ISO 8601 datetime string)
createdAt
 createdAt date-time

Date and time of document upload (ISO 8601 datetime string)
signed
 signed boolean

Indicates whether the document was signed by the owner
isAdmin
 isAdmin boolean

Indicates whether the member has Admin status
isSigner
 isSigner boolean

Indicates whether the member is a signer
isApprover
 isApprover boolean

Indicates whether the member is an approver
isViewer
 isViewer boolean

Indicates whether the member is a viewer
approvedAt
 approvedAt date-time

Only if isApprover is true. Date and time when the member was approved (ISO 8601 datetime string)
viewedAt
 viewedAt date-time

Only if isViewer is true. Date and time when the member viewed the document (ISO 8601 datetime string)
signaturePosition
 signaturePosition

The signature position(s) for this member. Based on what is sent in the request you can expect either a single position object or an array of position objects.
signedAt
 signedAt date-time

Date and time of the signature (ISO 8601 datetime string)
signingOrder
 signingOrder number

The order in which this member should sign
declinedAt
 declinedAt date-time

Date and time when the member declined (ISO 8601 datetime string)
signatures
 signatures array of object

Array of signatures
signatureType
 signatures.signatureType string

Type of signature (e.g. aes_sproof)
signedAt
 signatures.signedAt date-time

Timestamp when the signature was applied (ISO 8601 datetime string)

PrepareSignatureRequestResponse

Name Path Type Description
folderId
 folderId string
folderName
 folderName string
documents
 documents array of object
id
 documents.id string
name
 documents.name string
language
 documents.language string
members
 documents.members array of

As this is a prepare signature request response, the members array will be empty. This is because the members are not invited yet.
member
 documents.member MemberResponseSchema

MemberResponseSchema

Name Path Type Description
id
 id string
documentId
 documentId string
email
 email string
firstName
 firstName string
lastName
 lastName string
isAdmin
 isAdmin boolean
createdAt
 createdAt date-time

Date and time when the member was created (ISO 8601 datetime string)
sentDeleteNotificationAt
 sentDeleteNotificationAt date-time

Date and time when delete notification was sent (ISO 8601 datetime string)
manuallyLastEmailSent
 manuallyLastEmailSent date-time

Date and time when the last manual email was sent (ISO 8601 datetime string)
signaturePosition
 signaturePosition MemberSignaturePositionResponse

Signature position data with additional response-specific fields. The cardStyle, pageWidth, and pageHeight fields are optional and may not be present in all API responses.
doNotSendEmails
 doNotSendEmails boolean
declinedAt
 declinedAt date-time

Date and time when the member declined (ISO 8601 datetime string)
signingOrder
 signingOrder number
onDemand
 onDemand string
recipientId
 recipientId string
signatureTypes
 signatureTypes array of string
signatureTypesActive
 signatureTypesActive boolean
privateMessage
 privateMessage string
customId
 customId string
useFastlane
 useFastlane boolean
role
 role string
approvedAt
 approvedAt date-time

Date and time when the member was approved (ISO 8601 datetime string)
verificationConfig
 verificationConfig
phoneNumber
 phoneNumber string
signatures
 signatures array of string
boxes
 boxes array of DocumentResponseBox

Form field boxes assigned to this member.
signedAt
 signedAt date-time

Date and time when the member signed (ISO 8601 datetime string)

DocumentResponseBox

Name Path Type Description
id
 id string
fieldId
 fieldId string

The configured Field ID used to prefill form fields. Returns null if no Field ID is configured.
type
 type string
value
 value string

The value of the box field. Can be a string (including empty string), boolean, or null depending on the box type.
label
 label string
readOnly
 readOnly boolean

MemberSignaturePositionResponse

Signature position data with additional response-specific fields. The cardStyle, pageWidth, and pageHeight fields are optional and may not be present in all API responses.

Name Path Type Description
Items
 SignaturePositionResponse

Signature position data with additional response-specific fields. The cardStyle, pageWidth, and pageHeight fields are optional and may not be present in all API responses.

SignaturePositionResponse

Signature position data with additional response-specific fields. The cardStyle, pageWidth, and pageHeight fields are optional and may not be present in all API responses.

Name Path Type Description
page
 page integer

Page number, starting with 0.
x
 x number

x coordinate of the signatures' top left position
y
 y number

y coordinate of the signatures' top left position
width
 width number

Width of the signature.
height
 height number

Height of the signature.
cardStyle
 cardStyle string

The visual style of the signature card. This field is optional and may not be returned in all responses.
pageWidth
 pageWidth number

The width of the page in pixels. This field is optional and may not be returned in all responses.
pageHeight
 pageHeight number

The height of the page in pixels. This field is optional and may not be returned in all responses.

EnvelopeResponse

Name Path Type Description
folderId
 folderId string
folderName
 folderName string
documents
 documents array of object
id
 documents.id string
name
 documents.name string
language
 documents.language string
startSendingReminders
 documents.startSendingReminders date-time

Date and time when reminders start being sent (ISO 8601 datetime string)
sendReminder
 documents.sendReminder boolean
reminderSent
 documents.reminderSent boolean
reminderInterval
 documents.reminderInterval number
createdAt
 documents.createdAt date-time

Date and time when the document was created (ISO 8601 datetime string)
callbackUrl
 documents.callbackUrl string
returnUrl
 documents.returnUrl string
returnBtnText
 documents.returnBtnText string
inPersonSigning
 documents.inPersonSigning boolean
signingRound
 documents.signingRound number
isTemplate
 documents.isTemplate boolean
templateId
 documents.templateId string
linkId
 documents.linkId string
linkExpiresAt
 documents.linkExpiresAt string
derivedFromLink
 documents.derivedFromLink boolean
state
 documents.state string
complianceLevel
 documents.complianceLevel string
allowForwarding
 documents.allowForwarding boolean
linkExpires
 documents.linkExpires boolean
setDueDate
 documents.setDueDate boolean
dueDate
 documents.dueDate date-time

Due date for the document (ISO 8601 datetime string)
focusedSigningMode
 documents.focusedSigningMode boolean
linkMaxSignaturesEnabled
 documents.linkMaxSignaturesEnabled boolean
linkMaxSignatures
 documents.linkMaxSignatures number
fastlaneProfileId
 documents.fastlaneProfileId string
refId
 documents.refId string
sendOutFinishedPdf
 documents.sendOutFinishedPdf boolean
signatureTypes
 documents.signatureTypes array of string
members
 documents.members array of MemberResponseSchema
member
 documents.member MemberResponseSchema
boxes
 documents.boxes array of DocumentResponseBox

General form field boxes that are not assigned to a specific recipient returned if the document has form fields. Fields assigned to recipients are returned in members[n].boxes.
overdue
 documents.overdue boolean

DocumentStatusForFlow

Name Path Type Description
id
 id string
name
 name string
state
 state string

The current state of the document. Possible values are: draft, pending, declined, completed, attachment, manuallyPending, manuallyCompleted
createdAt
 createdAt date
updatedAt
 updatedAt date
allSignersSigned
 allSignersSigned boolean
allMembersSigned
 allMembersSigned boolean
focusedSigningMode
 focusedSigningMode boolean