Credential

Click here for a complete list of operations.

Login

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api/3.0/credential.asmx HTTP/1.1
Host: na2.docusign.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.docusign.net/API/Credential/Login"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Login xmlns="http://www.docusign.net/API/Credential">
      <Email>string</Email>
      <Password>string</Password>
      <ReturnBaseUrl>boolean</ReturnBaseUrl>
    </Login>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LoginResponse xmlns="http://www.docusign.net/API/Credential">
      <LoginResult>
        <Success>boolean</Success>
        <ErrorCode>User_Does_Not_Exist_In_System or Account_Lacks_Permissions or User_Lacks_Permissions or User_Authentication_Failed or Unspecified_Error or Success</ErrorCode>
        <AuthenticationMessage>string</AuthenticationMessage>
        <Accounts>
          <Account>
            <AccountID>string</AccountID>
            <AccountName>string</AccountName>
            <UserID>string</UserID>
            <UserName>string</UserName>
            <Email>string</Email>
            <BaseUrl>string</BaseUrl>
          </Account>
          <Account>
            <AccountID>string</AccountID>
            <AccountName>string</AccountName>
            <UserID>string</UserID>
            <UserName>string</UserName>
            <Email>string</Email>
            <BaseUrl>string</BaseUrl>
          </Account>
        </Accounts>
      </LoginResult>
    </LoginResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /api/3.0/credential.asmx HTTP/1.1
Host: na2.docusign.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Login xmlns="http://www.docusign.net/API/Credential">
      <Email>string</Email>
      <Password>string</Password>
      <ReturnBaseUrl>boolean</ReturnBaseUrl>
    </Login>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <LoginResponse xmlns="http://www.docusign.net/API/Credential">
      <LoginResult>
        <Success>boolean</Success>
        <ErrorCode>User_Does_Not_Exist_In_System or Account_Lacks_Permissions or User_Lacks_Permissions or User_Authentication_Failed or Unspecified_Error or Success</ErrorCode>
        <AuthenticationMessage>string</AuthenticationMessage>
        <Accounts>
          <Account>
            <AccountID>string</AccountID>
            <AccountName>string</AccountName>
            <UserID>string</UserID>
            <UserName>string</UserName>
            <Email>string</Email>
            <BaseUrl>string</BaseUrl>
          </Account>
          <Account>
            <AccountID>string</AccountID>
            <AccountName>string</AccountName>
            <UserID>string</UserID>
            <UserName>string</UserName>
            <Email>string</Email>
            <BaseUrl>string</BaseUrl>
          </Account>
        </Accounts>
      </LoginResult>
    </LoginResponse>
  </soap12:Body>
</soap12:Envelope>