I am using the DocuSign API in an embedded manner. I create an envelope and add signers, the first signer always being set as embedded. This allows me to retrieve a URL that is then embedded in an iframe.
However, I also wish, to trigger an email (as soon as the envelope has been created, NOT upon completion) that gets sent to the primary recipient/signer as if they were a nonembedded signer.
I tried adding the signer twice, with the same role, to the recipients, but that didn't work. No email was sent.
Is there a way to accomplish this?
I believe there is a setting to enable this but that it needs to be enabled by someone on DocuSign's side, like your account manager. If you do not have an account manager yet please respond to the auto-generated emails that were sent out to you once you created your account, you should have 3 of them.
The account settings available are only for Completion emails. However, the REST API also supports an embeddedRecipientStartURL parameter on the signer object that triggers a normal DocuSign email. The value of this parameter is the URL that should be included in the email. This means you can link back to your own application and request the recipient view as normal.
Check here for more detail: Signer embeddedRecipientStartURL. Note: if you set this to a value of "SIGN_AT_DOCUSIGN" then DocuSign will provide its own URL and take care of signing. The trade-off is that you won't be able to initiate any bespoke authentication you are doing in your own application.
Related
createSender creates a URL, which I would like to use to let the sender preview the document before it's send out. Hence the documents are created using templates and and the API.
The link which is created would lead me out of my UI. Does the user need to sign in? Future plan is to have many user's, which have no DocuSign account.
For embedded sending Your app will have to authenticate the user. If you are doing a Service Integration then your Api account will be used as the sender.
Once the sending url is generated using the createSenderView api, there is no authentication required to access the URL.
You also have an option to build a User Application using the docusign Api where your App can support sending from multiple accounts.
The createSenderView requires that the person is a DocuSign user (with their own account and password).
Only DocuSign users can send. We charge for sending, not for signing or receiving.
What exactly do you want to preview? (And why?)
the documents themselves? Use the EnvelopeDocuments resource. You can also preview the thumbnails of the documents.
the documents with the "fields" ("tabs") that indicate where people will sign? I'm not sure that is do-able.
or the recipients and their routing order? Use EnvelopeRecipients: list method.
Added
Another solution is to use a dummy certified delivery "recipient". Add this recipient as the first recipient. This will block the envelope from proceeding on the recipient routing.
Then get the envelope's documents to show as a preview.
Then, if ok, alter the envelope's recipients to remove the certified delivery recipient. The envelope will then continue on with the first "real" recipient.
I'm using DocuSign's REST API to create envelopes in embedded signing mode. With the function CreateRecipientView i get only a temporary link. But i would prefer to get an permanent link like in the notification mail. How can i get this link/URL?
Getting permanent signing links is not possible using the DocuSign rest API.
For remote signers, only the signer can receive the signing link through email. No one else will have access to the signing URL.
Setting permanent signing/access link is possible with "embeddedRecipientStartURL" by using a captive recipient aka "clientUserId" and your own URL endpoint whereby you authenticate your users and determine if they can access the envelope via a Request Recipient View.
Documentation here.
You can also request emails be sent per captive recipients as well as many other "Portal" centric options that put you in full control of the user experience.
To give your signers permanent links, your application creates the links by itself. Eg myapp.myserver.com/signing_links/95a086f7-a76e-40ec-938e-987be996d220
The number should be a guid, not a database record key. This is needed to prevent someone from guessing what one of these permanent links is, so they can't read (or sign!) someone else's documents.
When someone opens their browser to go to one of the signer links, your application looks up the guid in the your app's database. The database record will include the DocuSign envelope_id and the recipient_id that the link represents.
Next your app uses that data to request an embedded recipient view link from DocuSign. Then (if you get a good response back from DocuSign), your app redirects the user's browser to the signing page on DocuSign.
(You'd get back an error from DocuSign if the recipient had already signed, or the envelope had been voided, etc.)
Guess what? The above is more or less how DocuSign gives out the "permanent" links in its emails--those links always redirect to one of the 5-minutes-only signing ceremony links.
Remember that you need to authenticate the signers, or include additional authentication options in your envelope, since you don't know who is going to end up pressing one of your app's signer links.
Setting vs Getting permanent signing/access link is possible with "embeddedRecipientStartURL" by using a captive recipient aka "clientUserId" and your own URL endpoint whereby you authenticate your users and determine if they can access the envelope via a Request Recipient View.
https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST%20API%20References/Recipients/Signers%20Recipient.htm
You can also request emails be sent per captive recipients as well as many other "Portal" centric options that put you in full control of the user experience.
So Net/Net, LarryK and CodingDawg are correct, each from a specific view. It ultimately is up to you to decide which way works best for your application and users.
In docusign is it possible to create a signing request via the web interface and then retrieve the sigining URL via the API
at the moment, I update the Envelope using the API to attach a clientUserID as this is lacking when created via the web interface.
Then I retrieve the signing view url however, there is no signing tab when navigating to that url. The only action I have is to close.
I have tested using the API and the envelope contains signing tabs so I'm not sure what the issue would be.
Any help would be much appreciated!
When you send a DocuSign envelope if you assign one or more tabs to your recipient it becomes what's known as a Free Form signing experience, where the recipient decides where to sign the document.
On the other hand if you specify one or more tabs for the recipient then it's a Guided Signing experience. In guided signing the recipient can only sign and take actions at the tabs the sender has specified.
It sounds like you are successfully creating the envelope and signing URL but that there are no tabs configured for the signer. If that's the case you should confirm your code is identifying the recipient correctly by specifying the name, email, recipientId, and clientUserId values.
I would also check that the tabs are being set in your request body correctly for the given recipient. First get the recipient information for the envelope using the EnvelopeRecipients: list API to ensure the data is what you expect, then generate the signing URL using the corresponding data.
DocuSign: when using an embedded signer, how do you send email to the signer if they select "Finish Later?"
I have tried to deselect the "Suppress Emails to Embedded Signers". But that did not seem to change anything.
If it is not possible to send a signer an email, how does they get back to the document, since the url that is generated is only good for 5 minutes?
DocuSign offers two main methods for initiating workflows with your recipients: Remote Recipients or Embedded Recipients.
Remote Recipients, which is the default, receive an email from the DocuSign platform which has a link that they use to open the signature request through a browser and sign through the DocuSign Web App (i.e. website). In this scenario recipients are guided through the DocuSign website and have full access to all features and settings.
On the other hand, Embedded Recipients do not context-switch, wait for an email, and then sign through the website. Instead, when you embed a given recipient you are telling the DocuSign platform that YOU are taking care of everything, such as preparing the signing URL, delivering to the user (recipient), and handling the callback once they are done signing.
In this case, whether they sign the document, decline to sign, close the window, or do something else like hit the "Finish Later" button, there will be a query parameter appended to the return URL you configure so that you can determine what action they took. For instance if they declined to sign the document and your returnUrl was set to https://www.docusign.com/developer-center the callback would look like:
https://www.docusign.com/developer-center?event=decline
Therefore, when you Embed a recipient and they either do not sign in time (due to the 5 min expiration of the URL) or they try to access it more than once (they are one-time use only) your app will need to parse the returnUrl to determine what action they took and simply generate a new signing URL when needed.
i Am Using Docu Sign demo Sample. with help of Demo Sample i am Creating an Application and Trying to Send Email to my Recipient but my recipient is not receiving any mail. i checked email credential and firewall all are okay.
But i am getting Success status by .
EnvelopeStatus status = client.CreateAndSendEnvelope(envelope);
// If we succeeded, go to the status
if (status.SentSpecified)
{
AddEnvelopeID(status.EnvelopeID);
Response.Redirect("GetStatusAndDocs.aspx", false);
}
Status.SentSpecified is true all time.
i dont know where is the Problem?
Thanks in Advance to Assist me.
Normally when DocuSign recipients are not receiving emails it's because one (or more) of the following reasons:
The email notification is not enabled for the action in question (usually signature request).
Security or spam software is catching/filtering the email before it reaches the recipient.
You are setting the recipient as an embedded recipient.
An invalid or incorrect email address has been provided in the request.
Possible resolutions for each
Check email notification preferences by logging into the DocuSign Console and going to Preferences -> Manage Email Notifications.
Check your security software settings, firewalls, spam/junk mail filtering, inspect logs, etc.
Embedded recipients by default do not receive an email (since they are immediately signing). Making a recipient Embedded means setting the clientUserId property for them. To NOT make them an embedded recipient do NOT set the clientUserId property (don't include it in the request at all)
Ensure the intended email addresses are being set.
Something else that might help debug these types of issues - you can always request the problematic envelope through an API call and inspect it. If using the DocuSign SOAP API you can do this through the RequestEnvelope() call, if using REST look to do a GET call on the /accounts/{accountId}/envelopes/{envelopeId} URI
I would like to add to what #Ergin mentioned that there are Features to enable sending of emails to Embedded receipients.
You should look for these two somewhat confusingly named features:
Suppress Emails to Embedded Signers (checked by default)
Use Envelope Complete Email for (non-suppressed) Embedded Signers
The fix for me was to uncheck the first one and check the second one. This page has a more thorough description:
Suppress Email to Embedded Signers (Check box) – When selected an email completion notice is not sent to embedded signers when envelope signing is completed. This option is only used with the embedded signing function of the DocuSign API and cannot be selected if the Use Envelope Complete Email for (non-suppressed) Embedded Signers option is selected.
Use Envelope Complete Email for (non-suppressed) Embedded Signers (Check box) - When selected an email completion notice is sent to embedded signers when envelope signing is completed. This option is only used with the embedded signing function of the DocuSign API.
As a note you will need to modify this under the DocuSign Admin portal's "Signing Settings".