sproof Sign (Preview)
Use sproof Sign to automate safe electronic signature workflows for PDF and DOCX documents. Organizations can create single or multi-document signature requests, assign recipients and signing roles, track status, 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 |
| 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 single-document signature requests or multi-document envelopes, assign recipients and signing roles, retrieve request status, download completed documents, and delete documents.
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.
- 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 Documents in an envelope The query parameter With the sender
With the recipient
Single documents With the sender
With the sender
With the recipient
|
| Get document |
Get signed document as binary or Base64-encoded string. |
| 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. |
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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
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
|
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 |
|
|
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 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 |
|
|
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 types of signatures that are allowed for this recipient. 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.
Note2: When using |
|
|
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 | integer |
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 | integer |
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. |
|
|
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 types of signatures that are allowed for this recipient, can be overwritten by recipient signature types. 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 |
|
|
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
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
|
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
|
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 |
|
|
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 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 |
|
|
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 types of signatures that are allowed for this recipient. 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.
Note2: When using |
|
|
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 | integer |
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 | integer |
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. |
|
|
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 types of signatures that are allowed for this recipient, can be overwritten by recipient signature types. 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 |
|
|
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
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
declinedon 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
declinedon 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 |
Returns
- response
- DeleteDocumentResponse
Get document
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 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
base64
|
base64 | string |
Base64-encoded PDF content |
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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Member ID
|
memberId | True | string |
Member ID |
Returns
Definitions
DeleteDocumentResponse
- Delete Document Response
- string
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 |
A form field box in the document response. This is only returned if the document has form fields. If the document is signed the document will return boxes with the values that were filled out. |
|
overdue
|
documents.overdue | boolean |
DocumentResponseBox
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string | |
|
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 |
MemberResponseSchema
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string | |
|
documentId
|
documentId | string | |
|
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 | |
|
signedAt
|
signedAt | date-time |
Date and time when the member signed (ISO 8601 datetime string) |
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. |
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 |