Skip to navigation
eSignature SOAP API 101Docusign Security Requirements and API Call Limits

Integration Keys

View as Markdown

Docusign has introduced a system of integration keys to identify third-party applications. The use of integration keys is mandatory for API calls to our production system (www.docusign.net) and for developer sandboxes (https://demo.docusign.net).

The integration key is used to allow you to send requests with the users passed via the UsernameToken. Users with Docusign privileges will be allowed to be passed in the UsernameToken as long as a valid integration key is provided.

Important:

Web service calls made without an integration key will receive an exception for every call made. The exception message states, “The specified integration key was not found or is disabled” (error number 3).

Integration keys are provided to API developers by Docusign. If you do not have an integration key, follow this procedure to obtain one:

  1. Create or login to your developer account
    If you do not already have a developer account, create one, following the prompts and entering all required information. At the end of the process, you will be logged into your developer account. If you have previously created a developer account, log in before continuing.

  2. Access the My Apps & Keys page
    Open the My Apps & Keys page for your developer account.

  3. Add and configure a new app
    To add and configure a new app, follow these steps:

    1. You’ll see a dialog box to enter your app name. Give your app a short, but descriptive name, such as Docusign HR Integration.
    2. Select ADD to add your app. Your app is automatically assigned an integration key (GUID) value that cannot be changed.
    3. Add the integration key to your code for use as described below in Integration Key Usage and in the Authentication section. You can test your integration key in the demo environment.
    4. When you are ready to certify your code for the production account, see Go-Live for the process to promote your integration key to the production environment.

Integration key usage

The integration key must be placed in front of the user ID that is in the Username node of the UsernameToken. The integration key must be wrapped with brackets, “[ and ]”.

Example format:

<wsse:Username>[Key Here]2988541c-xxxx-xxxx-xxxx-f2d324062ca3</wsse:Username>

Example header
<soap:Header>
<wsa:Action>http://www.docusign.net/API/3.0/GetRecipientEsignList</wsa:Action>
<wsa:MessageID>uuid:3f9d7626-xxxx-xxxx-xxxx-2bd5e8026b17</wsa:MessageID>
<wsa:ReplyTo>
<wsa:Address>http://schemas.xmlsoap.org/ws/2004/03/addressing/role/anonymous</wsa:Address>
</wsa:ReplyTo>
<wsa:To>http://demo.docusign.net/api/3.0/api.asmx</wsa:To>
<wsse:Security soap:mustUnderstand="1">
<wsu:Timestamp wsu:Id="Timestamp-8838aa24-xxxx-xxxx-xxxx-26539e14f750">
<wsu:Created>2006-04-14T14:29:23Z</wsu:Created>
<wsu:Expires>2006-04-14T14:34:23Z</wsu:Expires>
</wsu:Timestamp>
<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="SecurityToken-7c7b695e-cef7-463b-b05a-9e133ea43c41">
<wsse:Username>[Integration Key Here]2988541c-xxxx-xxxx-xxxx-f2d324062ca3</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
<wsse:Nonce>SjlScsL5q3cC1CDWrcMx3A==</wsse:Nonce>
<wsu:Created>2006-04-14T14:29:23Z</wsu:Created>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>