Currently using DocuSign-Powerform which generates signing link to recipient. I need to know if signing link can be generated by envelope ID through DocuSign API for specific project requirement.
In order to use the API to generate a link that can be used to initiate the recipient signing session, the envelope must have been created via the API in the first place. (In the API documentation, this scenario -- creating the envelope via API and then subsequently using the API to generate the link that can be used to initiate the recipient signing session -- is referred to as "embedded" signing or "captive" signing.)
If you're creating the envelope via any other means (e.g., Powerforms or the DocuSign web UI), it's not possible to use the API to generate a link that can be used to initiate the recipient signing session.
Related
I am trying to implement embedded signing in our application. I followed the steps as mentioned in the guide - https://developers.docusign.com/esign-rest-api/guides/concepts/embedding
I am able to create the envelope, generate the recipient signing URL, use that URL to sign and complete the document. But I haven't received the completed signed document to the email that I mentioned as the Signer.
Is there any additional properties that I need to specify to receive the document signed via the recipient signing URL?
What is the other way to receive the signed document in this case, Can I use webhook to receive the completed document?
Yes, webhook is the better approach for this.
in Embedded signing there are no emails going to the signer. That's the purpose. Embedding it in your app unlike remote signing where emails are sent.
Your app can receive a webhook notification from connect and retrieve the complete document.
https://developers.docusign.com/esign-rest-api/code-examples/webhook-status provide some examples. There are other resources about how to use DocuSign Connect webhook.
There's an option for this in the esignature admin tool., Send completion emails to embedded signers
That setting is account-wide. So if your application is used by people in multiple accounts, you'll need to set it for each account.
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.
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.
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.
I am using SOAP based API call "CreateAndSendEnvelope" to create an envelope into my DocuSign account for remote recipients. I haven't used captive recipients and I also have not created any envelopes from templates so far.
My main reason for not creating envelopes from templates is my document to be included in the DocuSign envelope is not static, it gets generated dynamically based upon certain conditions.
If I need to include recipients as captive recipients in an envelope, do I always have to create an envelope from a template?
As I mentioned earlier, I cannot create an envelope using template as then every time I need to create an envelope, I need to create a template first.
Is there a way to create an envelope first and then redirect a recipient to a signing page/console/URL?
I assume that as remote recipients, captive recipients need not be the DocuSign account users.
Yes you can definitely embed recipients without using any templates - they are two separate, unrelated things. To configure embedded recipients through the SOAP API you just need to set their captive info.
On each recipient there is CaptiveInfo property which has a clientUserId element that you need to set if you want to embed them. It's up to you what value to use for each recipient, but you just need to remember that info when later requesting the URL for them.
There's a whole page on the DocuSign Developer Center that discusses Embedding functionality and even though it's tailored for the REST API it will still give you some needed info:
https://www.docusign.com/developer-center/explore/features/embedding-docusign
Then to link it back to the SOAP API you can view sample code through the DocuSign SOAP SDK that's up on GitHub. It has 5 sample projects, written in Java, PHP, .NET, Ruby, and Salesforce (apex).
https://github.com/docusign/DocuSign-eSignature-SDK