DocuSign API: Specify Signature Image for Embedded Recipient (captive recipient) - docusignapi

Our Docusign integration is such that a user has a Docusign account, can create an envelope, and they become an embedded signer on the new envelope.
The embedded signer is assigned a clientUserId and this causes a signature image to be assigned to them.
However, this user has an existing signature image that they would like to use (their signatureId is known).
I know it is possible to delete a signature image for a captive recipient using the Accounts: deleteCaptiveRecipient endpoint. However, the description states that it "provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used."
I'm interested in assigning an existing signature image that is associated with the user's Docusign account to this embedded recipient.
Is it possible to set a signature image for an embedded recipient?
Edit: Since it is not possible to do so, I have 2 follow up questions:
1) Due to our integration, a user may be an embedded recipient on many envelopes (ie on every envelope they create).
Would the deleteCaptiveRecipient not be suitable since there is no way to identify a unique embedded recipient by ID (ie only update one embedded recipient)?
2) If the user is assigned a new clientUserId, is their old signature image will still be available if the previous clientUserId is assigned again?
Thus, option 2 seems to be the better option for our integration (since it is per envelope).

There is no API call to associate Signature image to a signer. Signature needs to be done as a Human activity only. Now embedded Signers are considered as accountless signers and DocuSign never checks if that signer has a DocuSign account or not if you have assigned that signer as an embedded signer, so DocuSign will not show the user's account signature image. There is no way to set a signature image for an embedded recipient.
For #1, Ideally you should use same clientUserId for same recipient, as clientUserId is an index on DocuSign tables so it is quick to fetch the data if same clientUserId is used again and again in different envelopes. Normally, we suggest to use employeeNumber, or any unique userId for that recipient in your system for clientUserId. This way same clientUserId will be used across all the envelopes for the same embedded recipient. If its not possible to use any of the above then you can use emailId in clientUserId that way also same clientUserId, name and email will be used across all the envelopes sent to that embedded signer.
For #2, For embedded signing, as long as you pass the same name/email#/clientUserID for a specific individual, DocuSign will remember the signature they adopted and re-apply it for future signature events.

Related

Change embedded signature responsibility

I am embedding the signature request with DocuSign in my application. Is there any way that I can allow customers to change embedded signature responsibility(forward the document to someone else)?
I have already checked the setting to enable recipients to Assign to Someone Else according to this link: https://support.docusign.com/s/document-item?language=en_US&rsc_301&bundleId=yca1573855023892&topicId=uin1573855010064.html&_LANG=enus
enter image description here
Another question, if it is impossible then is there any way that customers can save all the changes that they have made so far?
Embedded Signing doesn't directly support signers changing signing responsibility. This is because out-of-the-box if a captive signer did so, the recipient they changed it to would not have a way to access the envelope.
The most straightforward way to resolve this would be to change the signer to a Remote signer so that the Signer Reassign function you've linked would work.
If it's necessary for a signer to remain embedded/captive, but still have the ability to reassign, you would need to build out functionality in your application that would (outside of DocuSign)
prompt the recipient for the new signer's info
make an UpdateRecipient call on the envelope to change the name/email/clientUserId as needed
Notify the new recipient that they have an envelope to sign
Grant the new recipient access to the envelope.

Embedded signing error when envelope signing order is set

I am integrating a WebApp with DocuSign and use Embedded Signing to allow users sign the envelopes I am creating (and updating recipients) on the fly out of some predefined templates.
Everything works ok in the simple cases but for the templates with the signing order set (Second recipient should sign the envelope only when the first one has done) I've got {"errorCode":"UNKNOWN_ENVELOPE_RECIPIENT","message":"The recipient you have identified is not a valid recipient of the specified envelope."} error message when creating Recipient View.
Could you advise is there a way to show the envelope for such recipient (second) if now is not her turn to sign? Or this is how Embedded Signing works and you are not able to create Recipient View for the recipient whose recipient order is not the current?
Thank you!
You can only show the embedded view for the current signer or recipient. You can have more than one current person at a time by setting their routing orders to the same number.
Eg, two signers can have routing order of 1.
Either change the template, or you may be able to update the routing order via a composite template when you send the envelope

Document Templates - Roles Set to In person or email signing

I have successfully created a system to use a document template to create a new envelope.
The system has a tabbed UI and iframe that fetches new URLs from the Docusign API every time a tab is changed, and when a URL expires.
My problem is that now, some clients will either be sign in-person or sign via email. After reading the docs, I don't see a way to change from an in-person to an email signer after the envelope has been created. Is that correct?
Is it possible to set whether a role will be in-person or email sign at the time of envelope creation, without affecting the original template?
If that is not possible, Is my best option to create a template with duplicate fields for both in-person and email signing, and only use the appropriate ones based on my case?
If you need to change an in-person signer to a remote signer, or vice-versa, or any other recipient type into another recipient type you have two options:
Perform an Envelope Correction
Remove then Add the Recipient back to the in-process envelope as a different type.
For option #1, using an envelope correction you can edit things like recipients, tabs, and even documents if they have not been signed yet. Make the following API call to request the correction URL of an envelope:
POST /v2/accounts/{accountId}/envelopes/{envelopeId}/views/correct
API Docs: https://docs.docusign.com/esign/restapi/Envelopes/EnvelopeViews/createCorrect/
For option #2, the system does not let you convert a recipient into another recipient type - HOWEVER - you can delete a recipient from an envelope then add them back in as a different type. For instance, delete an in-person signer and then add them back in as a signer.
You can see the needed calls through the EnvelopeRecipients Resource.

Create an envelope without sending an email to signer

I'm working on a C#.net website and using DuoSecurity services to request electronic signatures. I want the users to sign the documents trough my web site so I decided to use the embedded signing feature.
To use this feature, you first need to create an envelope, but while creating an envelope I'm required to enter the signer's email address so DocuSign sends him an email with a link to the document, but I don't want this email to be sent.
To make it short, is there any way to create a DocuSign envelope without having DocuSign send an email to the signer? (I don't mind entering the signer's email, I have all the required information, it's just that for security purposes I don't want the end-user to receive the document URL trough email).
If not, is there any way to use the embedded signing feature without creating an envelope (I doubt it, but I really need a way to upload a document to DocuSign without them sending an email to the signer).
Thanks in advance,
The system will not send them an email if you are using Embedding functionality. To make use of Embedding and generate a URL token for a given envelope you need to set the clientUserId property for your recipients.
When the clientUserId property is present and its value is not null no email is sent to the recipient (only the envelope complete email gets sent once signing is done, but that is configurable). Basically the only thing you have to remember with embedding is that you set the clientUserId property for your recipients at the time they are added to the envelope, then when you are request a URL token you need to reference the same email, name, and clientUserId combination.
You're two best resources on this are the Embedding API Walkthroughs (see the bottom 3):
http://iodocs.docusign.com/APIWalkthroughs
And the DocuSign Dev Center page on Embedding functionality:
Features -> Embedding

Modify a recipient to enable requireIDLookup

We are using the REST API v2.
Consider this scenario:
Our system creates an envelope with two signers. The second signer
doesn’t have any kind of authentication via Docusign. In terms of the
API that means setting signer.requireIdLookup = false (no RSAID verification).
The first signer signs ok.
BEFORE the second signer signs the system
determines that authentication via RSAID is required after all. I
tried updating signer 2 to enable RSAID, but it doesn’t work. By
reading the documentation here it looks like changing the
requireIdLookup on a sent envelope is not supported.
Any ideas on how to do this? Voiding the envelope and starting again is not a good option because we don't want signer 1 to sign again.
As mentioned in the above comments, this is currently not supported. You need to determine if you will be using RSA ID check - which is controlled through the requireIDLookup property - at the time you are adding your recipients to the envelope, which might not necessarily be at the time of envelope creation. It's possible to create the envelope and save it as a draft envelope, then add recipients at a later time.

Resources