DocuSign API - define from which group (in case an user is linked to multiple groups) the envelope must be sent - docusignapi

We use API connection to send envelopes. I found how to apply brand in the envelope but not group. Can I set the group (and associated parameters) in the envelope, as some of my users are identified in several groups?
Thank you
We send and receive envelopes using only one account now, but we need to configure more accounts to deal with different settings

First, not sure if when you say "group" you mean account, or you mean group, because both things exist in DocuSign, and are different.
Second, since this is Stackoverflow, I'll assume you are writing code and building an integration and not just using the web app.
So, I'll address both options:
Group:
This article shows you how to do this in 6 langs, here is how the C# code looks like:
// signingGroupId should hold the string with the Signing Group ID
Signer signer1 = new Signer
{
Name = "test1", // Signing group name
SigningGroupId = signingGroupId,
RecipientId = "1",
};
Note that you have to have a group and find the ID for this group.
Account:
If you are using the API, the account is based on the authentication or on the access token you obtained. You will have to use a different account to authenticate and also make API calls.
AccountId is a unique GUID that determines the account you use and is passed on the URL for each API, however, it's not enough just to change this URL, you have to have an access token obtained for this account by using either JWT or
Auth Code Grant
.

Related

DocuSign SOAP based API with DocuSign Account ID

I have been using DocuSign SOAP Based API calls to create and send envelopes and am using legacy authentication method in which I can specify email address and password of the DocuSign user who is going to create envelopes.
One our client have multiple DocuSign account with the same user. When I setup an authentication header thru the SOAP based API call, I do not have a way to specify which account I am making API calls against.
How do I make sure that I am making API calls against the specific account?
You have two ways of accomplishing this.
1) You can make a getlogin call to retrieve a list of the logins associated with an account and use the default.
OR
2) Instead of supplying the email address for the user you can supply the API UserName in the login headers, which is a unique number for that user. This can be retrieved from the API and Keys or Users section if they're using the New DocuSign Experience, or through the user Permission section if still using Classic.
While the ApiUserName or email address is usually supplied in the authentication header, the ID for the account is in the XML body for the call. the combination of apiUserName and AccountId should be sufficient in picking a specific user, even if they have the same email address associated with multiple accounts.

Customise user and account names in signature ceremony

I'm providing a service for many different clients.
I'm using the DocuSign APIs.
I'd like to customise the user name and the account name displayed at the top left of the signature ceremony web page (the part surrounded with a red line in the screenshot below)
It looks like it needs a new account each time the account name needs to be changed and a new user each time the user name needs to be changed.
Is it possible to do this without creating new account and new user, and how can I do this via the API?
I hope my question is clear enough.
The sender Account Name/User Name cannot be changed per envelope. Once they are set during account creation they will be applied to all the envelopes sent from the account.
If your integration is supporting multiple clients, then you will probably have to authenticate differently. DocuSign supports various authentication mechanisms. Consider using oAuth or SOBO based on your application needs.

send document to a group of people:: Any one able to sign

We are using SOAP API with Document option. In regular way we do attach Recipient Id to Signature Tab to send a document for Signature, in this case only one signer can do sign on Signature tab.
We need to send a Document to group of people where anyone in the group should be able to sign on it.
I have come across a concept in DocuSign call it as "Signing Group" for this we need create group manually in the DocuSign account using all required email addresses.
But as per our requirement Email addresses are not static, Email addresses are dynamic that will vary every time we do send the document.
*Signing group option is might not relevant to our requirement. Is there any other go to achieve it...?
Thanks,
Vishwa
Based upon the current DocuSign API Documentation, it seems that the SOAP API does not support management of signing groups (create/delete/get/list/update) at this time. However, the DocuSign REST API does provide that type of functionality: https://docs.docusign.com/esign/restapi/SigningGroups/SigningGroups/

How do you get the DocuSign Account ID using the API?

In the DocuSign GUI it shows a number in the top right corner which I presume is the company account ID. If your user is in multiple company accounts then you can switch between these accounts and the number changes. My demo account ID's are 17107 and 1133955.
I cannot find a way to get this ID using the API. I need it because a customer has multiple accounts with the same company name and we need to show the same account ID to them so they can differentiate between the accounts in our GUI like they can in the DocuSign GUI.
With the Credential API I can get the list of accounts for the user but the account ID here is the API account ID which is a GUID, not an integer.
Using a simple Login API call you'll get a list of the user's accounts. Each of the loginAccount objects within that list also contains an accountId parameter.
Please see the documentation regarding the login_information REST API call:
https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST API References/Login.htm?Highlight=login_information

creating a docusign envelope from template with api created user profile

given a demo docusign account with a template, through the api i have created a group with default permission profile of "Docusign Sender" and created a user profile and a membership to the group. using the new user profiles creds (and the account id of the parent docusign account), i can fetch templates shared by the docusign account but i cannot create an envelope from such a template. the error message received is:
USER_LACKS_PERMISSIONS : This user lacks sufficient permissions to access this resource
i can post more details if necessary but perhaps this is a well-known behavior that i just have been unable to resolve through researching the api and stackoverflow.
We discussed that you are using REST to grab shared templates to create envelopes.
When creating a user profile from API those users do not have the correct permission set. When creating the same user from the web console it works. One suggestion might be to grab the permission set of an known good user and compare it to the profile obtained from a user created by your API request:
https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST%20API%20References/Get%20Use%20Profile.htm?Highlight=profile
https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST%20API%20References/Get%20Group%20Information.htm
it seems this particular error message is what happens when a user profile attempts to create an envelope (at least from a template in this case) while specifying a bccEmailAddresses recipient under emailSettings. if this bcc recipient is removed, envelope creation succeeds. of course, specifying a bcc recipient is no problem using the parent account's credentials.

Resources