Overview service methods for web service activity
AddNewDocumentRemote
A document is sent to DocuSign for signing.
Example: The signer provides the employee requesting the signature with their name, email address, and SMS-enabled phone number. The employee enters the data into the workflow form, requesting the signature from DocuSign. The signer receives an email with the link to the document and an SMS with a TAN, which he uses to sign the document.AddNewDocumentMultiSigners
A document is sent to DocuSign so that it can be signed by multiple people.
The example is the same as in "AddNewDocumentRemote" with the difference that the data of multiple signers is sent along with the signature requests.AddNewDocumentMultiPositions
A document is sent to DocuSign so that it can be signed by one person in multiple locations.
The example is the same as in "AddNewDocumentRemote" with the difference that the data of the signer, the positions of the requested signatures are also sent.AddNewClippedDocument
A document with multiple sections (files) is sent to DocuSign so that it can be signed by one person on multiple sections of the the document.DeleteUnsignedDocuments
Deletes a document already transmitted for signature.
Example: After sending the signature request, the employee realizes that he sent the wrong document. This allows the document to be withdrawn.
AddNewDocumentRemote
A document is sent to DocuSign for signing.
Parameter name | Workflow variable type | Mandatory/optional | Description | Values |
|---|---|---|---|---|
AccessCode (string) | Text | Mandatory for RecipientAuthenticationType = Access Code | If the Authentication type is “AccessCode”, this parameter is required. This will be the access code (similar to a password) that will be required to sign the document. The access code must be provided to the signer in a separate communication channel (phone call or email, for example). | |
AnchorText (string) | Text | Mandatory | This is the piece of text the service can look for on the document. If specified and not found, an error will occur. If not specified, then the subsequent location information will be absolute, rather than relative to finding a piece of text. | |
AnchorTextOccurrence (int) | Integer | Mandatory | Which occurrence of the anchor text should be used to be the starting location for placing the signature |
|
DateSignedAnchorText (string) | String | Optional | This is the piece of text the service can look for on the document. If specified and not found, an error will occur. If not specified, then the subsequent location information will be absolute, rather than relative to finding a piece of text. | |
DateSignedAnchorTextOccurrence (int) | Integer | Optional | Which occurrence of the anchor text should be used to be the starting location for placing the date signed. |
|
DateSignedFieldName (string) | Text | Mandatory | Identifies a file cabinet field on the document that will be updated with the date the document was signed by the user. It can be a text, date or datetime field. | |
DateSignedPageNumber (int) | Integer | Optional | Page number within the file to start looking for the anchor text. -1 indicates to look on the last page. If no anchor text is specified, it is the absolute page number. | |
DateSignedPositionX (int) | Integer | Optional | Relative to the left side of the anchor text, this is the horizontal location of the date signed text be placed on the document (millimeters again). Positive numbers are to the right. Negative numbers are to the left. | |
DateSignedPositionY (int) | Integer | Optional | Relative to the top of the anchor text, this is the vertical location of the date signed text to be placed on the document (millimeters again). Positive numbers are down. Negative numbers are up. | |
DaysBeforeExpiration (int) | Integer | Mandatory | If the value provided is greater than 0, there will be a time limit of this number of days before the document expires. If the time limit is passed, the document will be considered declined. It will be deleted from the VIDsigner service and the signer will no longer be able to sign it. | |
DocId (int) | Integer | Mandatory | ID of the document to be signed | |
EmailSubject (string) | Text | Mandatory | Subject of the email | |
FailureStatusValue (string) | Text | Mandatory | This provides a value to be set in the above field when a document is rejected by the user in DocuSign. | |
FileCabinetId (string) | Text | Mandatory | GUID of the file cabinet with the document | |
IncludeDateSigned (boolean) | Text | Optional | This parameter is optional but when set to “True”, the date signed will be included in the document and the parameters below for locating the date signed will be required. |
|
IncludeReport (boolean) | Text | Optional | This parameter is optional but if provided must have a value of ‘true’ or ‘false’. Setting it to true will append a second PDF to the document after the signed document. This PDF has information regarding the signer and the digital certificate that was added to the document. |
|
PageNumber (int) | Integer | Mandatory | Page number within the file to start looking for the anchor text. -1 indicates to look on the last page. If no anchor text is specified, it is the absolute page number. | |
PhoneNumber (string) | Text | Mandatory | Phone number used for two-factor authentication (use international phone number format, ex. +18455639045) during the signing process | |
PositionX (int) | Integer | Mandatory | Relative to the left side of the anchor text, this is the horizontal location of the signature image to be placed on the document (millimeters again). Positive numbers are to the right. Negative numbers are to the left. | |
PositionY (int) | Integer | Mandatory | Relative to the top of the anchor text, this is the vertical location of the signature image to be placed on the document (millimeters again). Positive numbers are down. Negative numbers are up. | |
PostSigningAction (string) | Text | Mandatory | This specifies what is to be done with the signed document after the user signs it in DocuSign. |
|
RecipientAuthenticationType (string) | Text | Mandatory | This allows the workflow to specify what type of DocuSign authentication is required to allow a signer to sign a document. |
|
RecipientMayProvideNumber (Boolean) | Text | Mandatory for RecipientAuthenticationType = Phone or SMS | Only for Phone/SMS authentication. If set to true, it ignores any value the user sets in the phone number. Then, at the time of signing the signer can provide the number to be called to receive the code by entering it in the DocuSign application. |
|
RejectionReasonFieldName (string) | Text | Optional | This parameter will specify an index field on the document that must be a text field. When the user declines to sign the document, the DocuSign application can be configured to ask them to provide a reason. If they decline to sign and enter a reason, the text they enter will be placed in this field. | |
Report Language (string) | Text | Mandatory for IncludeReport = True | This parameter is optional and only can be included if IncludeReport is set to “true”. When specified, it ensures the generated report that will be appended to the signed file is in the desired language. | de, en, es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH, zh_TW |
| Integer | Mandatory | Index of the section within the document to be signed. A section is one file in a clipped document consisting of multiple files. |
|
SignerEmail (string) | Text | Mandatory | Email address of the signer of the document | |
SignerName (string) | Text | Mandatory | Name of the person signing the document | |
StatusFieldName (string) | Text | Mandatory | This identifies an index field of the document that will be updated when a document is signed or rejected by the user in DocuSign. | |
SuccessStatusValue (string) | Text | Mandatory | This provides the value to be set in the above field when a document is signed. | |
Token (string) | Text | Mandatory | Token received in the registration step that identifies the customer organization and provides user credentials. |
AddNewDocumentMultiSigners
Used to send a document to the DocuSign for remote signature for multiple signers in different locations on one document. Note, the information about the signers and the signing positions in the document are in a delimited list and separated by a value that is specified using a parameter. The examples below will show the use of a comma.
NOTE: The order of the list must be consistent throughout all the parameters.
Parameter name | Workflow variable type | Mandatory/optional | Description | Values |
|---|---|---|---|---|
AccessCode (string) | Text | Mandatory for RecipientAuthenticationType = Access Code | If the Authentication type is “AccessCode”, this parameter is required. This will be the access code (similar to a password) that will be required to sign the document. The access code must be provided to the signer in a separate communication channel (phone call or email, for example). | |
DateSignedFieldName (string) | Text | Mandatory | Identifies a file cabinet field on the document that will be updated with the date the document was signed by the user. It can be a text, date or datetime field. Date is provided in UTC, if the field is a text field, the date will be displayed in UTC, if the field is a date or datetime field, DocuWare will display the date in the local format and timezone. | |
DaysBeforeExpiration (int) | Integer | Mandatory | If the value provided is greater than 0, there will be a time limit of this number of days before the document expires. If the time limit is passed, the document will be considered declined. It will be deleted from the DocuSign service and the signer will no longer be able to sign it. | |
DocId (int) | Integer | Mandatory | ID of the document to be signed | |
EmailMessage (string) | Text | Mandatory | Text that is displayed in the contents of the email | |
EmailSubject (string) | Text | Mandatory | Subject of the email | |
FailureStatusValue (string) | Text | Mandatory | This provides a value to be set in the above field when a document is rejected by the user in DocuSign. | |
FileCabinetId (string) | Text | Mandatory | GUID of the file cabinet with the document | |
IncludeDateSigned (boolean) | Text | Optional | This parameter is optional but when set to “True”, the date signed will be included in the document and the parameters below for locating the date signed will be required. |
|
IncludeReport (boolean) | Text | Optional | This parameter is optional but if provided must have a value of ‘true’ or ‘false’. Setting it to true will append a second PDF to the document after the signed document. This PDF has information regarding the signer and the digital certificate that was added to the document. |
|
MultiAnchorText (string) | Text | Mandatory | This parameter holds the anchor texts for the multiple signing locations. | |
MultiAnchorTextOccurrence (string) | Text | Mandatory | This parameter holds the anchor texts for the multiple signing locations. | |
MultiDateSignedAnchorText (string) | Text | Mandatory | This parameter holds the anchor texts for the multiple date signed locations.. | |
MultiDateSignedAnchorTextOccurrence (string) | Text | Mandatory | This parameter holds the anchor texts for the multiple date signed locations. | |
MultiDateSignedPageNumber (string) | Text | Mandatory | This parameter holds a delimited list of page numbers where date signed are located. | |
MultiDateSignedPositionX (string) | Text | Mandatory | This parameter holds a list of X positions for date signed placement. | |
MultiDateSignedPositionY (string) | Text | Mandatory | This parameter holds a list of Y positions for date signed placement. | |
MultiPageNumber (string) | Text | Mandatory | This parameter holds a delimited list of page numbers where signatures are located. | |
MultiPositionX (string) | Text | Mandatory | This holds a list of X positions for signature placement. | |
MultiPositionY (string) | Text | Mandatory | This holds a list of Y positions for signature placement | |
MultiSignerCount (int) | Text | Mandatory | This is the number of signatures being requested | |
MultiSignerEmail (string) | Text | Mandatory | This parameter holds the email addresses for the signers. | |
MultiSignerName (string) | Text | Mandatory | This parameter holds the names of the signers of the document. Example: “Peter Sanders,BrianFlorent” | |
MultiSignerPhoneNumber (string) | Text | Mandatory | Holds a delimited list of phone numbers that can be used for SMS verification. | |
MultiValueSeparator (string) | Text | Mandatory | This parameter is required and tells the service how the list of signers and their information will be separated. A common choice is a comma, a caret ^ or a pipe | | |
OrderedSignature (bool) | Text | Mandatory | When true, the signatures will be requested in the order that they are specified in the above fields. The first signer will receive an email, can sign and then the second signer will be sent an email and may sign, and so on. When false, all signers are notified parallel and may sign in any order. In both cases, the file cabinet is not updated with the signed document until all signatures are obtained. |
|
PostSigningAction (string) | Text | Mandatory | This specifies what is to be done with the signed document after the user signs it in DocuSign. |
|
RecipientAuthenticationType (string) | Text | Mandatory | This allows the workflow to specify what type of DocuSign authentication is required to allow a signer to sign a document. See section 2.1 for more information about these authentication types. |
|
RecipientMayProvideNumber (Boolean) | Text | Mandatory for RecipientAuthenticationType = Phone or SMS | Only for Phone/SMS authentication. If set to true, it ignores any value the user sets in the phone number. Then, at the time of signing the signer can provide the number to be called to receive the code by entering it in the DocuSign application. |
|
Report Language (string) | Text | Mandatory for IncludeReport = True | This parameter is optional and only can be included if IncludeReport is set to “true”. When specified, it ensures the generated report that will be appended to the signed file is in the desired language. | de, en, es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH, zh_TW |
SectionNumber (int) | Integer | Mandatory | Index of the section within the document to be signed. A section is one file in a clipped document consisting of multiple files. |
|
StatusFieldName (string) | Text | Mandatory | This identifies an index field of the document that will be updated when a document is signed or rejected by the user in DocuSign. | |
SuccessStatusValue (string) | Text | Mandatory | This provides the value to be set in the above field when a document is signed. | |
Token (string) | Text | Mandatory | Token received in the registration step that identifies the customer organization and provides user credentials. |
AddNewDocumentMultiPositions
Used to send a document to the DocuSign for remote signature for one signer to sign or initial in multiple locations. Note, the information about the signer and the signing positions in the document are in a delimited list and separated by a value that is specified using a parameter. The examples below will show the use of a comma.
NOTE: The order of the list must be consistent throughout all the parameters.
Parameter name | Workflow variable type | Mandatory/optional | Description | Values |
|---|---|---|---|---|
AccessCode (string) | Text | Mandatory for RecipientAuthenticationType = Access Code | If the Authentication type is “AccessCode”, this parameter is required. This will be the access code (similar to a password) that will be required to sign the document. The access code must be provided to the signer in a separate communication channel (phone call or email, for example). | |
DateSignedFieldName (string) | Text | Mandatory | Identifies a file cabinet field on the document that will be updated with the date the document was signed by the user. It can be a text, date or datetime field. Date is provided in UTC, if the field is a text field, the date will be displayed in UTC, if the field is a date or datetime field, DocuWare will display the date in the local format and timezone. | |
DaysBeforeExpiration (int) | Integer | Mandatory | If the value provided is greater than 0, there will be a time limit of this number of days before the document expires. If the time limit is passed, the document will be considered declined. It will be deleted from the DocuSign service and the signer will no longer be able to sign it. | |
DocId (int) | Integer | Mandatory | ID of the document to be signed | |
EmailMessage (string) | Text | Mandatory | Text that is displayed in the contents of the email | |
EmailSubject (string) | Text | Mandatory | Subject of the email | |
FailureStatusValue (string) | Text | Mandatory | This provides a value to be set in the above field when a document is rejected by the user in DocuSign. | |
FileCabinetId (string) | Text | Mandatory | GUID of the file cabinet with the document | |
IncludeDateSigned (boolean) | Text | Optional | This parameter is optional but when set to “True”, the date signed will be included in the document and the parameters below for locating the date signed will be required. |
|
IncludeReport (boolean) | Text | Optional | This parameter is optional but if provided must have a value of ‘true’ or ‘false’. Setting it to true will append a second PDF to the document after the signed document. This PDF has information regarding the signer and the digital certificate that was added to the document. |
|
MultiDateSignedAnchorText (string) | Text | Mandatory | This parameter holds the anchor texts for the multiple date signed locations.. | |
MultiDateSignedAnchorTextOccurrence (string) | Text | Mandatory | This parameter holds the anchor texts for the multiple date signed locations. | |
MultiDateSignedCount (int) | Integer | Mandatory | This parameter holds the occurrence of the anchor texts used for placing the multiple date signed tabs | |
MultiDateSignedPageNumber (string) | Text | Mandatory | This parameter holds a delimited list of page numbers where date signed are located. | |
MultiDateSignedPositionX (string) | Text | Mandatory | This parameter holds a list of X positions for date signed placement. | |
MultiDateSignedPositionY (string) | Text | Mandatory | This parameter holds a list of Y positions for date signed placement. | |
MultiInitialAnchorText (string) | Text | Mandatory | This parameter holds the anchor texts for the multiple initials locations |
|
MultiInitialAnchorTextOccurrence (string) | Text | Mandatory | Page number within the file to start looking for the anchor text. -1 indicates to look on the last page. If no anchor text is specified, it is the absolute page number. | |
MultiInitialCount (int) | Numeric | Mandatory | This is the number of initials tabs being placed on the document | |
MultiInitialPageNumber (string) | Text | Mandatory | Relative to the left side of the anchor text, this is the horizontal location of the date signed text be placed on the document (millimeters again). Positive numbers are to the right. Negative numbers are to the left. | |
MultiInitialPositionX (string) | Text | Mandatory | Relative to the top of the anchor text, this is the vertical location of the date signed text to be placed on the document (millimeters again). Positive numbers are down. Negative numbers are up. | |
MultiInitialPositionY (string) | Text | Mandatory | This holds a list of Y positions for initials placement. | |
MultiSignatureAnchorText (string) | Text | Mandatory | This parameter holds the anchor texts for the multiple signing locations. | |
MultiSignatureAnchorTextOccurrence (string) | Text | Mandatory | This parameter holds the anchor text occurrences (i.e. first, second or third time etc. text occurs in the document) for the multiple signature locations. | |
MultiSignatureCount (int) | Numeric | Mandatory | This is the number of signature tabs being placed on the document | |
MultiSignaturePageNumber (string) | Text | Mandatory | This holds a delimited list of page numbers where signatures are located | |
MultiSignaturePositionX (string) | Text | Mandatory | This holds a list of X positions for signature placement. | |
MultiSignaturePositionY (string) | Text | Mandatory | This holds a list of Y positions for signature placement | |
MultiValueSeparator (string) | Text | Mandatory | This parameter is required and tells the service how the list of signers and their information will be separated. A common choice is a comma, a caret ^ or a pipe | | |
PhoneNumber (string) | Text | Mandatory | Phone number used for two-factor authentication (use international phone number format, ex. +18455639045) during the signing process | |
PostSigningAction (string) | Text | Mandatory | This specifies what is to be done with the signed document after the user signs it in DocuSign. |
|
RecipientAuthenticationType (string) | Text | Mandatory | This allows the workflow to specify what type of DocuSign authentication is required to allow a signer to sign a document. See section 2.1 for more information about these authentication types. |
|
RecipientMayProvideNumber (Boolean) | Text | Mandatory for RecipientAuthenticationType = Phone or SMS | Only for Phone/SMS authentication. If set to true, it ignores any value the user sets in the phone number. Then, at the time of signing the signer can provide the number to be called to receive the code by entering it in the DocuSign application. |
|
Report Language (string) | Text | Mandatory for IncludeReport = True | This parameter is optional and only can be included if IncludeReport is set to “true”. When specified, it ensures the generated report that will be appended to the signed file is in the desired language. | de, en, es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH, zh_TW |
SectionNumber (int) | Integer | Mandatory | Index of the section within the document to be signed. A section is one file in a clipped document consisting of multiple files. |
|
SignerEmail (string) | Text | Mandatory | Email address of the signer of the document | |
SignerName (string) | Text | Mandatory | Name of the person signing the document | |
StatusFieldName (string) | Text | Mandatory | This identifies an index field of the document that will be updated when a document is signed or rejected by the user in DocuSign. | |
SuccessStatusValue (string) | Text | Mandatory | This provides the value to be set in the above field when a document is signed. | |
Token (string) | Text | Mandatory | Token received in the registration step that identifies the customer organization and provides user credentials. |
AddNewClippedDocument
Used to send multiple sections (files within a DocuWare document) of a document to the DocuSign for remote signature for one signer to add a signature, date or initials in one location per section. Note, the information about the sections and the signing positions in the document are in a delimited list and separated by a value that is specified using a parameter. The examples below will show the use of a comma.
NOTE: The order of the list must be consistent throughout all the parameters.
Parameter name | Workflow variable type | Mandatory/optional | Description | Values |
|---|---|---|---|---|
AccessCode (string) | Text | Mandatory for RecipientAuthenticationType = Access Code | If the Authentication type is “AccessCode”, this parameter is required. This will be the access code (similar to a password) that will be required to sign the document. The access code must be provided to the signer in a separate communication channel (phone call or email, for example). | |
DateSignedFieldName (string) | Text | Mandatory | Identifies a file cabinet field on the document that will be updated with the date the document was signed by the user. It can be a text, date or datetime field. Date is provided in UTC, if the field is a text field, the date will be displayed in UTC, if the field is a date or datetime field, DocuWare will display the date in the local format and timezone. | |
DaysBeforeExpiration (int) | Integer | Mandatory | If the value provided is greater than 0, there will be a time limit of this number of days before the document expires. If the time limit is passed, the document will be considered declined. It will be deleted from the DocuSign service and the signer will no longer be able to sign it. | |
DocId (int) | Integer | Mandatory | ID of the document to be signed | |
EmailMessage (string) | Text | Mandatory | Text that is displayed in the contents of the email | |
EmailSubject (string) | Text | Mandatory | Subject of the email | |
FailureStatusValue (string) | Text | Mandatory | This provides a value to be set in the above field when a document is rejected by the user in DocuSign. | |
FileCabinetId (string) | Text | Mandatory | GUID of the file cabinet with the document | |
IncludeReport (boolean) | Text | Optional | This parameter is optional but if provided must have a value of ‘true’ or ‘false’. Setting it to true will append a second PDF to the document after the signed document. This PDF has information regarding the signer and the digital certificate that was added to the document. |
|
MultiAnchorText (string) | Text | Mandatory | This parameter holds the anchor texts for the multiple signing locations. | |
MultiAnchorTextOccurrence (string) | Text | Mandatory | This parameter holds the anchor texts for the multiple signing locations. | |
MultiPageNumber (string) | Text | Mandatory | This holds a delimited list of page numbers where initials are located | |
MultiPositionX (string) | Text | Mandatory | This holds a list of X positions for signature placement. | |
MultiPositionY (string) | Text | Mandatory | This holds a list of Y positions for signature placement | |
MultiSectionCount (int) | Integer | Mandatory | Holds a delimited list of sections where signatures are located | |
MultiSectionNumber (string) | Text | Mandatory | This holds a delimited list of sections where signatures are located | |
MultiValueSeparator (string) | Text | Mandatory | This parameter is required and tells the service how the list of signers and their information will be separated. A common choice is a comma, a caret ^ or a pipe | | |
PhoneNumber (string) | Text | Mandatory | Phone number used for two-factor authentication (use international phone number format, ex. +18455639045) during the signing process | |
PostSigningAction (string) | Text | Mandatory | This specifies what is to be done with the signed document after the user signs it in DocuSign. |
|
RecipientAuthenticationType (string) | Text | Mandatory | This allows the workflow to specify what type of DocuSign authentication is required to allow a signer to sign a document. See section 2.1 for more information about these authentication types. |
|
RecipientMayProvideNumber (Boolean) | Text | Mandatory for RecipientAuthenticationType = Phone or SMS | Only for Phone/SMS authentication. If set to true, it ignores any value the user sets in the phone number. Then, at the time of signing the signer can provide the number to be called to receive the code by entering it in the DocuSign application. |
|
Report Language (string) | Text | Mandatory for IncludeReport = True | This parameter is optional and only can be included if IncludeReport is set to “true”. When specified, it ensures the generated report that will be appended to the signed file is in the desired language. | de, en, es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH, zh_TW |
SignerName (string) | Text | Mandatory | Name of the person signing the document | |
SignerEmail (string) | Text | Mandatory | Email address of the signer of the document | |
StatusFieldName (string) | Text | Mandatory | This identifies an index field of the document that will be updated when a document is signed or rejected by the user in DocuSign. | |
SuccessStatusValue (string) | Text | Mandatory | This provides the value to be set in the above field when a document is signed. | |
Token (string) | Text | Mandatory | Token received in the registration step that identifies the customer organization and provides user credentials. |
DeleteUnsignedDocuments
Used to retract a document that has been sent to DocuSign so the document cannot be signed by the user This is useful, if a document was sent in error and it should be withdrawn from the user.
Parameter name | Workflow variable type | Mandatory/optional | Description | Values |
|---|---|---|---|---|
DocId (int) | Integer | Mandatory | ID of the document to be signed | |
FileCabinetId (string) | Text | Mandatory | GUID of the file cabinet with the documentt | |
Token (string) | Text | Mandatory | Token received in the registration step that identifies the customer organization and provides user credentials. |
What happens after the document is signed or rejected?
After the document is signed or rejected, DocuSign notifies the DocuWare Signature Service.
If the document is signed, DocuWare Signature Service downloads the document from DocuSign. The parameter “PostSigningAction” determines how the document is handled – clip it before or after the original document or replace it with the new file. DocuWare Signature Service sets the field specified by StatusFieldName with the SuccessStatusValue. The workflow can use this status to continue.
If the document is rejected, DocuWare Signature Service sets the value of the field specified by StatusFieldName to the FailedStatusValue. The workflow can use this status to continue.
The service then removes the document from DocuSign.