We have multiple recipients per envelope and the signing order is set. Can we get the envelope based on the status of individual recipients?. I don't see anything that we can do to achieve this through ListStatusChangesOptions. I know that we can achieve this by listRecipients but this did not give us an option to set parameters to limit the data, like ListStatusChangesOptions.
I want to reduce the API call limit, if there is an option to directly limit the data sent from DocuSign based on the status of the individual recipients.
Eg: Get all the Envelopes whose recipient1 status is completed.
Instead of getting more than required envelopes through listStatusChanges and limiting them by using listRecipients
No, there is no API call to fetch envelope details based on recipient status. Instead I would propose to use DocuSign Connect. It has trigger event of Recipient Signed, so once recipient has signed you will get a message from DocuSign with envelope details like envelopeId, which recipient Signed it etc, and this will save a lot of your API calls and DocuSign Connect is the recommended way from DocuSign instead of doing polling. You can learn more about DS Connect here,
https://www.docusign.com/supportdocs/ndse-admin-guide/Content/custom-connect-configuration.htm
https://www.docusign.com/supportdocs/pdf/connect-guide.pdf
Related
We have ASP.ET MVC Web application. We are using Docusign SDK For C#.
We are planning to go Live with DocuSign Integration and We looked at DocuSign limits (specially 15 minutes get request limit).
We need an advice on how to avoid violation in Envelop Correction scenario. Steps are as given below.
Get status of envelop
Get recipients of envelop and show it user in the GUI
User updates email in the GUI and submits form
On backend we Get recipients again with all tabs and custom fields, Update email address
Call Update recipients method
You see on number 4. It is 15 minutes violation. How to handle this scenario?
We don't want to create Whole mechanism for Saving/Caching DocuSign Recipients data and statuses. As those statuses can change from DocuSign or some of the recipient can decline or void envelop. We want to fetch latest recipient data to update on the time of execution.
I agree with Inbar that you could store the results of the first get_recipients call. You could either store it in the user's session state (server side) or send it all to the browser and then have the browser return it.
I'd go with session state
Saving data in the session state isn't a big deal.
Re:
As those statuses can change from DocuSign or some of the recipient can decline or void envelope.
So you're worried that while the application user is updating an email address, the envelope will be declined by a recipient?
In that case you could lock the envelope while your user is updating it. Or you could not send the envelope until after the user has updated it. Or if you get an error while updating the recipients, that would be the time to do the extra recipients_get.
When i check format of XML notification for Docusign Connect event - i observe signed field for recipient which contains date time of signment.
When i check REST API for envelope recipients i see that signedDateTime for recipient is Reserved for DocuSign.
https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/list
Why in one place it is available while in another - it is not?
Does REST API is something newer than XML event?
What is the most correct way to determine signment date for each recipient?
making a call to get recipients using the DocuSign eSignature v2.1 API would include this data
See here
https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/list
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients
Check the info for dateSigned inside the json
I am using Remote Signing with the DocuSign api, but I want to know how to determine what action the recipient took (i.e. they signed, declined to sign, viewed, etc). How do I do this?
You want the status of the envelopes you sent?
Best technique is to create a webhook and have DocuSign call your server when the envelope's status changes.
You can create DocuSign notification message subscriptions at either the account level or at the individual envelope level.
See this blog entry for more info. Ask additional questions on StackOverflow if you have any difficulties.
There is a documentation about possible envelop status value from docusign for a given envelope.
Howver i am trying to understand if there are any documentation which lists out the possible "Action" value from docusign in the "Audit_event" REST API method.
The reaosn is I am storing the audit events locally to avoid multiple API calls and i wanted to account for all the possible action values.
Thanks for reading
Since there were any documentation provided, i am including the staus i have seen based on my reverse engg
Registered
Sent Invitations
Printable Copy Delivered
Printable Copy Attached to Email
AccessCode Passed
AccessCode Failed
Viewed
Signed
Approved
Resent
Voided
Declined
Correction Initiated
Correction Cancelled
Viewed In-Session
Corrected
I've never seen any documentation for possible values of the action property within a GET Envelope Audit Events response -- to the best of my knowledge, none exists. You might be stuck having to 'reverse engineer' to determine possible values. i.e., create envelopes via the DocuSign web console, act on them in a variety of ways (both as Sender and as Recipient) -- for example: Send Envelope, Void Envelope, Decline Envelope, Sign Envelope, View Envelope, Pass Signer Authentication, Fail Signer Authentication, etc. etc. etc. -- and then examine the corresponding action values that appear in the GET Envelope Audit Events response for those Envelopes.
Obviously this approach is not ideal, since someone fairly new to DocuSign won't necessarily know all of things that can be done with an Envelope, in order to trigger the various action values in the API response. Perhaps someone from DocuSign will see this post and chime in with a list of all possible values...or better yet, add this info to the API Guide one day soon.
How can I check if a document is signed with DocuSign API? Exists any API service that lets me know the document status?
I tried to obtain all objects in "completed" folder but the response doesn't contains documentId and I can't know which of documents is each of the objects
DocuSign tracks Recipient status and Envelope status (but not Document status). In other words:
If Envelope status = Completed, you can safely assume that each
Recipient in the envelope workflow supplied all information that the
Sender marked as Required.
If Recipient status = Completed, you can safely assume that the
Recipient supplied all information that the Sender marked as Required
for him/her.
You have several options for determining the status of a Recipient or an Envelope:
Use the DocuSign REST API (https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/get/). If you're wanting to query for the status of a single envelope-- the operation is: GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{{envId}}
Use the DocuSign SOAP API (http://www.docusign.com/sites/default/files/DocuSignAPI_Guide.pdf).
Use DocuSign Connect, such that Connect will notify your "listener" application about Envelope and/or Recipient statuses that you specify. See here
Finally, when querying for Envelope status using either the REST API or SOAP API, keep in mind the polling limitations that DocuSign imposes on the request status operations. These limitations are described in the API Best Practices guide