DocuSign Information Guide. Send On Behalf Of Functionality. Overview. Table of Contents

Transcription

1 DocuSign Information Guide Send On Behalf Of Functionality Overview The DocuSign Send On Behalf Of functionality permits automated sending through the DocuSign API by an integrated sender on behalf of another sender. The Send On Behalf Of functionality is only available to Enterprise level accounts that use the DocuSign API to send envelopes. This guide provides information about how the functionality works, how to enable the function, and how to use the function in the API sending process. Table of Contents How it Works... 2 Enabling the Functionality... 2 Usage... 2 For More Information... 5

2 2 How it Works When Send On Behalf Of is enabled for an account member, that member becomes a System Sender and can send envelopes through the API for another user by adding the user identifier for that user to the authentication or Credential API login when sending envelopes. When the envelope is sent, the name of the System Sender that sent the envelope is replaced with the name of the user that the envelope is sent on behalf of. When a recipient receives the invitation to sign, the text of the states that the invitation was sent on behalf of the user and the sending and signing process for the Send On Behalf Of functionality is the same as the normal sending and signing process. Any returned (bounced) s are sent to the Send On Behalf Of sender and not to the member that used the API to send the envelope. Enabling the Functionality The Send On Behalf Of functionality can be enabled for an account member by a DocuSign Customer Administrator through the DocuSign console or by contacting your DocuSign Account Manger. The Send On Behalf Of functionality cannot be enabled through the DocuSign Account Management API. Enabling Send On Behalf Of Rights in the DocuSign Console 1. The DocuSign Customer Administrator logs in to the DocuSign Console and goes to the Account Preferences page. 2. Click Users, under the Account Administration heading, find the user account to update and click Open on the same line. The Manage User page is displayed. 3. Click Permissions to update the settings. Important: An account member must have Account-Wide Rights enabled to use the Send On Behalf of functionality. 4. Select Send On Behalf Of Rights (API), under the DocuSign API heading. 5. Click Save the member information is saved. Usage The DocuSign API Send On Behalf Of function can use the normal authentication for the DocuSign API or the node in the Credential API Login to add a Send On Behalf Of identifier The Send On Behalf Of identifier can be a properly formatted address, with an option semicolon delimited user name, or a User ID (UID), if using the Single Sign On (SSO) environment, that can be looked up in the DocuSign SSO configuration. If the identifier is a properly formatted address, the system conducts a look-up of the address and user name (if provided) to see if that user is a member of the account. If membership in the account is not found, a Partner Authentication Failed exception is thrown. The account used for the check is the one associated with the account member s login credentials (User Name address and password). If the identifier is not an address (the identifier fails the regular expression test for an ), it is assumed that the identifier is a UID. A search is conducted for the UID in the Single Sign On (SSO) customer system and the address and user name associated with

3 3 the UID are retrieved from the system. Then the system conducts a look-up of the address and user name to see if that user is a member of the account. If membership in the account is not found, a Partner Authentication Failed exception is thrown. The account used for the Single Sign On check is the one associated with the account member s login credentials (User Name address and password). Send On Behalf Of SOAP Examples The examples in this section show the different ways the Send On Behalf Of identifier is used with the Credential API Login or authentication in a SOAP Header, with a status request for an envelope. The more common use for Send On Behalf Of is with one of the DocuSign API envelope sending methods and the RequestStatus method is used here for brevity. These examples use an Integrator Key and Send On Behalf Of identifier, both included in separate brackets in the or Username objects. The Send On Behalf Of identifier is highlighted in the examples. Example: Credential API Login with Address <Login xmlns=" < >[BILL a-a9e9-211cef79e5f3][john.doe@docusign.com]test9@docusign.com</ > <Password>XXXXXXXX</Password> </Login> Example: Authentication in SOAP Header with Address <soap:header> <wsse:usernametoken xmlns:wsu=" wss-wssecurity-utility-1.0.xsd" wsu:id="securitytoken-7c7b695e-cef7-463b-b05a- 9e133ea43c41"> <wsse:username>[bill a-a9e9-211cef79e5f3][john.doe@docusign.com] c- 4ec b520-f2d324062ca3</wsse:Username> <wsse:password Type=" </wsse:usernametoken> </soap:header>

4 4 Example: Credential API Login with Address and optional User Name <Login xmlns=" < >[BILL- <Password>XXXXXXXX</Password> </Login> Example: Authentication in SOAP Header with Address and optional User Name <soap:header> <wsse:usernametoken xmlns:wsu=" wss-wssecurity-utility-1.0.xsd" wsu:id="securitytoken-7c7b695e-cef7-463b-b05a- 9e133ea43c41"> <wsse:username>[bill- Doe] c-4ec b520-f2d324062ca3</wsse:Username> <wsse:password Type=" </wsse:usernametoken> </soap:header> Example: Credential API Login with SSO UID <Login xmlns=" < >[BILL- <Password>XXXXXXXX</Password> </Login>

5 5 Example: Authentication in SOAP Header with SSO UID <soap:header> <wsse:usernametoken xmlns:wsu=" wss-wssecurity-utility-1.0.xsd" wsu:id="securitytoken-7c7b695e-cef7-463b-b05a- 9e133ea43c41"> <wsse:username>[bill a-a9e9-211cef79e5f3][P134325] c-4ec b520-f2d324062ca3</wsse:username> <wsse:password Type=" </wsse:usernametoken> </soap:header> For More Information For more information about additional DocuSign features, go to the DocuSign Support Site.

6 6 Copyright, Trademark and Patent Information Copyright DocuSign, Inc. All rights reserved. DocuSign, the DocuSign logo, Close it in the Cloud, SecureFields, Stick-eTabs, PowerForms, "The fastest way to get a signature", The No-Paper logo, Smart Envelopes, SmartNav, DocuSign It!, The World Works Better with DocuSign, Your world works better with DocuSign and ForceFields are trademarks or registered trademarks of DocuSign, Inc. in the United States and or other countries. All other trademarks and registered trademarks are the property of their respective holders. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of DocuSign, Inc. Under the law, reproducing includes translating into another language or format. Every effort has been made to ensure that the information in this manual is accurate. DocuSign, Inc. is not responsible for printing or clerical errors. Information in this document is subject to change without notice. U.S. Patent 6,289,460, U.S. Patent 6,944,648, and other patents pending. Version: DocuSign Release (August 2012) If you have any comments or feedback on our documentation, please send them to us at: Documentation@DocuSign.com.