Sign at Docusign
As per the above thread, it is possible to retrieve Signing console URL for email recipients too by setting EmbeddedRecipientStartURL property to value "SIGN_AT_DOCUSIGN", As per the documentation(Sign at Docusign), below example has to be framed in order to open Docusign Signing console.
http://senderHost/[[mergeField1]]/beginSigningSession?[[mergeField2]]&[[mergeField3]]
Please explain what is senderHost & what should be filled in the mergeField properties accordingly? Let me know if you need any additional information related to this query.
BVS, I believe that's the opposite. If you provide EmbeddedRecipientStartURL field with SIGN_AT_DOCUSIGN, the signature will happen completely on DocuSign, and you don't have to provide any URL or merge fields.
If the value SIGN_AT_DOCUSIGN is used for this node, the recipient
will be directed to an embedded signing or viewing process directly at
DocuSign.
On the other hand, if you want to route the client through your own application BEFORE he or she goes to DocuSign, you could provide this kind of template URL with merge fields to better handle the request.
Information can be appended to the embeddedRecipientStartURL using
merge fields. The available merge fields items are: envelopeId,
recipientId, recipientName, recipientEmail, and customFields. The
customFields must be part of the recipient or envelope. The merge
fields are enclosed in double brackets.
By example: if you wanted to handle the request before the signer goes to DocuSign, you could send something like https://senderHost?envId=[[envelopeId]]&email=[[recipientEmail]]. Sender host is your host, so it can be anything on the internet (www.yoursite.com, by example).
Hope it helps!
Related
I've been working on an integration that sends an envelope to 2 signers. I am trying to test and program for the case of 1 of the signers having a bad email address. I would need to:
Be notified of this (webhook?)
Update the email address for the signer
Update the email address in the custom fields as that's printed on the agreement
Resend the envelope
When I enable the delivery failure notification in Connect (this is set up at the account level, for now), I don't see where the failure is noted in the webhook response or for which signer the error is happening.
I've found multiple links via Google talking about "correct and resend" but I haven't been able to get anything definitive in terms of what steps need to be taken or a (PHP) code example. I've also found "resend" in the API reference but still no code examples.
I also haven't seen any code examples (PHP) of how I would update a signer's email address and how that would work via the API.
It'd also be good to know how to update custom field data for both signers so the email address in the contract is updated (it's listed separately as part of the custom form data).
And finally, how would I resend the envelope?
Thank you for your thoughts.
Per DocuSign support (customersupport#docusign.com):
Be notified of this (webhook?)
I have updated your account settings and now you should be able to see AutoResponded in your webhook messages when email invalid or unreachable.
(my comments: so it sounds like you have to ask to be able to see this stuff, it's not part of their standard webhook responses)
Update the email address for the signer
I also haven't seen any code examples of how I would update a signer and how that would work.
Unfortunately we don't have an example for recipient update but the logic is to get list of all recipients, pick the one need to be updated, and update.
You can use below to retrieve all recipients per envelope
https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/
GET /restapi/v2.1/accounts/accountId/envelopes/envelopeId/recipients
Extract the one you need to update edit email and update using the below
https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/update/
PUT /restapi/v2.1/accounts/accountId/envelopes/envelopeId/recipients
You can also see example code in C# how to do this in this thread https://github.com/docusign/docusign-csharp-client/issues/307
Update the email address in the custom fields as that's printed on the agreement
There is bug case created ( above link ) regarding this. At the moment you can not update signer custom fields case EC-2944.
Resend the envelope
You can resend the envelope during recipient update
https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/update/
PUT /restapi/v2.1/accounts/accountId/envelopes/envelopeId/recipients
My commentary:
Since custom fields can't be updated, this whole use-case goes out the window. We can't have contracts with incorrect data on it, so my client will have to do these corrections by hand. Kind of a bummer.
I'm a BA trying to understand DocuSign's eSignature feature (specifically, requesting a signature via email aka remote signing) as my company are soon to integrate. I'm really struggling to understand the end to end workflow. Is anybody able to A) shed light on this in layman's terms and/or B) point me toward documentation that better explains this than this documentation does? A step by step breakdown with no assumptions would be so helpful.
I'm particularly cloudy on how the "signing link" works; when/how it is generated and shared with the recipient and how they interact with it.
Thanks.
I suggest you look at these two:
If you are looking for non-developer document - https://www.docusign.com/products/electronic-signature/how-docusign-works
If you are looking to write code - https://developers.docusign.com/esign-rest-api/code-examples/code-example-request-a-signature-via-email
The idea is this: the signing is contained in something we call an envelope. An envelope represents a transaction. In that transaction you have people (recipients) and documents. You also need to specify how the recipients act on the documents with tabs (signing elements).
After you define all of this (which require you to specify among other things - email address(es) of the signers) you change the status to "sent" to actually send the envelope which means emails will be sent to remote signers.
At that point the DocuSign system automatically generates an email to any recipient that needs to sign that is in the first routing order (lowest number).
These emails will include a link.
That links does indeed expire eventually, but only to be replaced with a new link sent to the same email.
Clicking the link will launch the signing UI where the signer can complete the signing.
when all recipients completed acting on the envelope - the envelope is complete and a final signed/complete PDF is produced.
I've been looking at the API docs on Docusign (e.g. https://developers.docusign.com/esign-rest-api/guides/envelopes) but finding it pretty unclear.
I would like to:
Upload a document (e.g. pdf or docx)
Email signatory #1 that it needs to be signed
Know when they sign e.g. a webbook
Email the next signatory that it's their turn to sign it
I don't want to add all the people who need to sign it at once, but request them one by one (or multiple at each stage).
Can someone please point me in the right direction for doing this? Thanks
I'd recommend checking out DocuSign's Quickstart examples in your favorite language: https://developers.docusign.com/esign-rest-api/code-examples/quickstart-request-signature-email
To have signatories receive the envelope sequentially, you'll want to define a routing order for each recipient. DocuSign automatically moves through the routing order, so after signer 1 completes their portion, signer 2 will be notified.
To receive a notification to your webhook listener, you'll want to look in to DocuSign Connect: https://developers.docusign.com/esign-rest-api/guides/connect
I am new to DocuSign, have made the tutorials and read through the DocuSign API documentation. I am developing in Java, and have successfully achieved to send documents for signing from a template to an email address. The document then gets opened, a custom field gets filled out. The document gets signed by the user.
Well now here are two questions that arise for me:
1) Am I right with the assumption that custom fields are to be used for virtually any form field like "Which pets do you have?" that a user is expected to fill out? Almost all the other fields which I can add when creating a template are being filled out automatically by DocuSign.
2) I have added a name and surname field as well as a custom field and the "sign here" field to the template from which I am sending the document via the API. Once the recipient has has filled out the information and signed the document, I would like to request the information which the user has entered into the custom field. How can I do that? I have found various requests for getting the status of a document or envelope. But never found how I can retrieve the actual user input.
Regards
Josef
In DocuSign if you have common tabs that you use for your recipients in your requests then you can use the Custom Fields to create them once then re-use them in your subsequent requests. However, in general if you want to have editable fields where you will gather info from your recipients then you can use the Text field and un-check read-only. If setting through the API it would look like this:
"textTabs": [
{
"tabLabel": "NameOfTheTab",
"value": "12345"
}
You can read more about using these fields through the Features section of the DocuSign Developer Center.
With regards to your second question of how to retrieve the data that your recipients fill out, remember that tabs are always specific to recipients (as opposed to the documents themselves) so take a look at the Get Tab Information for Recipient API call.
Example:
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs
Can we "refresh" the document names in envelopes retroactively? We've already sent out our envelopes but need to change the document names inside of the completed/sent out envelopes. There is around a few hundred envelopes to update so updating each one individually will be problematic. The reason we need to do this is that we have a few different envelopes but when setting up the documents inside of the envelope the documents were setup with the same name so when we receive the Document through the API the documents had the same name so each document was overwriting the previous entry.
Sorry but I don't believe this is possible. Once an envelope has been sent and its status is "In-Process" the only aspects you can change are recipient(s), tab(s), and or custom fields (which are at the envelope level, not document level), and if it's in "Completed" status then there's nothing you can change about it.
So there's currently no way to change the document names of a sent envelope, and I'm not sure if there ever will be as that's like having someone sign something, then changing an aspect about that something that they signed underneath them.
With regards to what you CAN change once an envelope has been sent, you can edit the following recipient info:
email, userName, signerName, routingOrder, faxNumber, and deliveryMethod
And you can modify tabs for a given recipient as well. You can also modify any envelope custom fields you might have in the envelope. One final point I'll make, is that in our system a POST http request is always to add or create things, and a PUT http requests is for modifying existing envelopes - so whenever you are modifying a recipient, tab, or custom field make sure your requests are PUT requests.
References:
Modify or Correct and Resend Recipient Information
Modify Envelope Custom Fields for an Envelope
Modify Tabs for a Recipient