I'm able to create an envelope with the API which returns the envelopeId which looks like:
13f23354-7eee-41d3-897a-c1353a1e465c
When I navigate to docusign in my browser and open the envelope the url is:
https://na2.docusign.net/MEMBER/EnvelopeSetup.aspx?ti=ad05458248c54654a16a54195bf72ffe
I don't see what that "ad05458248c54654a16a54195bf72ffe" id is. I've tried every envelope API in the documentation (many don't make sense, but I tried them anyways):
/accounts/{accountId}/envelopes/{envelopeId}
/accounts/{accountId}/envelopes/{envelopeId}/audit_events
/accounts/{accountId}/envelopes/{envelopeId}/custom_fields
/accounts/{accountId}/envelopes/{envelopeId}/email_settings
/accounts/{accountId}/envelopes/{envelopeId}/notification
/accounts/{accountId}/envelopes/{envelopeId}/templates
But that id isn't anywhere.
Is there a way to retrieve that URL id? and/or is there another way I can get the url for the envelope?
The ID that appears as part of any URL when you're using the DocuSign web console is an internal ID -- you cannot use it with the API in any way. The Envelope ID value that DocuSign returns in response to the "Create Envelope" API request is the ID that you'll want to use with any API request that requires an Envelope ID.
It's not exactly clear to me what you mean by "[url for] managing an envelope" -- but I'd suggest you explore the following operations in the DocuSign REST API Guide:
Post Envelope Correction (page 146)
Modify or Correct and Resend Recipient Information (page 137)
Post Sender View (page 149)
(I'd guess that "Post Envelope Correction" is likely what you're after.)
Related
For the envelope which has been already created and notification has been sent to the recipients, how do we get the signature URL using eSignature REST API? The signature URL is nothing but the link which is embedded in the DocuSign email to the recipients.
Update: Once the envelopes are created, I am trying to show the signing links in a web portal so that users can view all the signing links and take action.
If you would like to use this URL inside your app, we call this Embedded Signing. You can follow a code example in multiple languages to do that here.
You make an API call to this URL:
POST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient
And you provide something called clientUserId which is a unique string that represents your app/user/envelope.
You can also provide a redirect URI where the user would land after they're done signing.
I'm using the docusign api and am having some trouble with a query string param. Basically I'm trying to grab the recipient information of an envelope along with the status of the envelope in a single call.
I am able to grab each of information individually with the following api calls and they both work
1.) Envelope endpoint (has a status field with overall envelope status such as Signed, Voided, Declined, etc...):
https://na2.docusign.net/restapi/v2/accounts/:accountId/envelopes/:docusignEnvelopeId/
2.) Envelope/recipients endpoint (has information regarding recipients)
https://na2.docusign.net/restapi/v2/accounts/:accountId/envelopes/:docusignEnvelopeId/recipients
However, I'm trying to see if I can grab these information all within one API call. According to the docs here for the general envelope endpoint, I think I should be able to with a query param
https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/get#request.
Under the include Optional Query Parameters section, there's a param for "include" which says I can grab recipients from the 1st endpoint. "Specifies additional information about the envelope to return. Enter a comma-separated list, such as tabs,recipients. Valid values are..."
I've been trying to modify the first endpoint with this include param to look something like this...
https://na2.docusign.net/restapi/v2/accounts/:accountId/envelopes/:docusignEnvelopeId?include=recipients
But I have been unable to have recipients show up as well. Was wondering if I'm just typing in the param wrong or if this is not available anymore. Any help would be appreciated!
Thanks :)
The include parameters were added in v2.1 of the eSignature API, so they don't work in v2. Changing your URL to https://na2.docusign.net/restapi/v2.1/accounts/:accountId/envelopes/:docusignEnvelopeId?include=recipients should return the recipient info.
I am getting the below response using Docusign envelope API
{
""envelopeId"": ""0aac02c3-ccdc-4bfe-88af-eefa2438d696"",
""uri"": ""/envelopes/0aac02c3-ccdc-4bfe-88af-eefa2438d696"",
""statusDateTime"": ""2016-10-14T10:39:02.4900000Z"",
""status"": ""created""
}
I am unable to open the envelope, even though I have logged into the Docusign site in the web. Let me know the URL to open the envelope. The response doesn't give the exact URL.
Created status means you will find it in your draft folder and that it has not been sent. If you want a POST sender view then you will need to make the correct call and use the URL returned by DocuSign to access the view and send the envelope.
So I'm using REST API for my DocuSign handling, and I have this snippet that checks every 30 mins the status of each envelope, but I'm having hard time find out if there is a way to trigger response (i.e. email) as soon as someone signs the document?
Yes, the DocuSign REST API includes a webhook facility that you can use. When you call Envelopes:Create, include an eventNotification object. In that object you include an internet-accessible URL.
The DocuSign platform will then make HTTPS POSTS to your URL when there is an interesting status change to your envelope. (You define "interesting" status changes as part of the eventNotification object.)
See the eventNotification section in the docs.
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