Skip to navigation
eSignature SOAP API 101Authentication

Optional authentication mechanism: XML signature

View as Markdown

In addition to the UsernameToken, any account may elect to enforce that all API requests be signed with a valid third-party X.509 certificate 2. For any RequestRecipientToken and ExportAuthoritativeCopy calls, Docusign requires an XML signature. If enabled, the Docusign Connect API will validate that the SOAP body of the message is signed. Please contact your Docusign representative to enable this setting. Supported certificate authorities are VeriSign and Thawte.

For more information about OASIS standards, see OASIS Web Services Security (WSS) TC.

Example SOAP envelope with XML signature
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   soap:Header
      wsa:Actionhttp://www.docusign.net/API/3.0/GetRecipientEsignList</wsa:Action>
      wsa:MessageIDuuid:3f9d7626-c088-43b4-b579-2bd5e8026b17</wsa:MessageID>
      wsa:ReplyTo
         wsa:Addresshttp://schemas.xmlsoap.org/ws/2004/03/addressing/role/anonymous</wsa:Address>
      </wsa:ReplyTo>
      wsa:Tohttp://demo.docusign.net/api/3.0/api.asmx</wsa:To>
      <wsse:Security soap:mustUnderstand="1">
         <wsu:Timestamp wsu:Id="Timestamp-8838aa24-9759-4f85-8bf2-26539e14f750">
            wsu:Created2006-04-14T14:29:23Z</wsu:Created>
            wsu:Expires2006-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:Username2988541c-4ec7-4245-b520-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:NonceSjlScsL5q3cC1CDWrcMx3A==</wsse:Nonce>
            wsu:Created2006-04-14T14:29:23Z</wsu:Created>
         </wsse:UsernameToken>
         <wsse:BinarySecurityToken ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3" EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="SecurityToken-b7825bf5-xxxx-xxxx-xxxx-88dff075fab8">MIIEdD...LdfBdg==</wsse:BinarySecurityToken>
         <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
            <SignedInfo>
               <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" />
               <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
               <Reference URI="#Id-6c2377a1-xxxx-xxxx-xxxx-101543d5d721">
                  <Transforms>
                     <Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#" />
                  </Transforms>
                  <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
                  <DigestValue>auFLuvdCM5tbsrruRJUY7h0vf9E=</DigestValue>
               </Reference>
            </SignedInfo>
            <SignatureValue>d21v1CT2U...+D7FTo=</SignatureValue>
            <KeyInfo>
               wsse:SecurityTokenReference
                  <wsse:Reference URI="#SecurityToken-b7825bf5-xxxx-xxxx-xxxx-88dff075fab8" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3" />
               </wsse:SecurityTokenReference>
            </KeyInfo>
         </Signature>
      </wsse:Security>
   </soap:Header>
   <soap: Body wsu:Id="Id-6c2377a1-xxxx-xxxx-xxxx-101543d5d721">
      <GetRecipientEsignList xmlns="http://www.docusign.net/API/2.0">
         <UserName>UserName</UserName>
         <SenderEmail>username@email.com</SenderEmail>
         <RecipientEmail>name@email.com</RecipientEmail>
         <AccountId>2184872a-xxxx-xxxx-xxxx-1ec864cec29d</AccountId>
      </GetRecipientEsignList>
   </soap:Body>
</soap:Envelope>