DSAPIService

Click here for a complete list of operations.

RequestRecipientToken

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/dsapi.asmx HTTP/1.1
Host: www.docusign.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.docusign.net/API/3.0/RequestRecipientToken"

<?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>
    <RequestRecipientToken xmlns="http://www.docusign.net/API/3.0">
      <EnvelopeID>string</EnvelopeID>
      <ClientUserID>string</ClientUserID>
      <Username>string</Username>
      <Email>string</Email>
      <AuthenticationAssertion>
        <AssertionID>string</AssertionID>
        <AuthenticationInstant>dateTime</AuthenticationInstant>
        <AuthenticationMethod>Password or Email or PaperDocuments or HTTPBasicAuth or SSLMutualAuth or X509Certificate or Kerberos or SingleSignOn_CASiteminder or SingleSignOn_InfoCard or SingleSignOn_MicrosoftActiveDirectory or SingleSignOn_Passport or SingleSignOn_SAML or SingleSignOn_Other or Smartcard or RSASecureID or Biometric or None or KnowledgeBasedAuth</AuthenticationMethod>
        <SecurityDomain>string</SecurityDomain>
      </AuthenticationAssertion>
      <ClientURLs>
        <OnSigningComplete>string</OnSigningComplete>
        <OnViewingComplete>string</OnViewingComplete>
        <OnCancel>string</OnCancel>
        <OnDecline>string</OnDecline>
        <OnSessionTimeout>string</OnSessionTimeout>
        <OnTTLExpired>string</OnTTLExpired>
        <OnException>string</OnException>
        <OnAccessCodeFailed>string</OnAccessCodeFailed>
        <OnIdCheckFailed>string</OnIdCheckFailed>
        <OnFaxPending>string</OnFaxPending>
        <GenerateSignedDocumentAsynch>boolean</GenerateSignedDocumentAsynch>
      </ClientURLs>
    </RequestRecipientToken>
  </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>
    <RequestRecipientTokenResponse xmlns="http://www.docusign.net/API/3.0">
      <RequestRecipientTokenResult>string</RequestRecipientTokenResult>
    </RequestRecipientTokenResponse>
  </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/dsapi.asmx HTTP/1.1
Host: www.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>
    <RequestRecipientToken xmlns="http://www.docusign.net/API/3.0">
      <EnvelopeID>string</EnvelopeID>
      <ClientUserID>string</ClientUserID>
      <Username>string</Username>
      <Email>string</Email>
      <AuthenticationAssertion>
        <AssertionID>string</AssertionID>
        <AuthenticationInstant>dateTime</AuthenticationInstant>
        <AuthenticationMethod>Password or Email or PaperDocuments or HTTPBasicAuth or SSLMutualAuth or X509Certificate or Kerberos or SingleSignOn_CASiteminder or SingleSignOn_InfoCard or SingleSignOn_MicrosoftActiveDirectory or SingleSignOn_Passport or SingleSignOn_SAML or SingleSignOn_Other or Smartcard or RSASecureID or Biometric or None or KnowledgeBasedAuth</AuthenticationMethod>
        <SecurityDomain>string</SecurityDomain>
      </AuthenticationAssertion>
      <ClientURLs>
        <OnSigningComplete>string</OnSigningComplete>
        <OnViewingComplete>string</OnViewingComplete>
        <OnCancel>string</OnCancel>
        <OnDecline>string</OnDecline>
        <OnSessionTimeout>string</OnSessionTimeout>
        <OnTTLExpired>string</OnTTLExpired>
        <OnException>string</OnException>
        <OnAccessCodeFailed>string</OnAccessCodeFailed>
        <OnIdCheckFailed>string</OnIdCheckFailed>
        <OnFaxPending>string</OnFaxPending>
        <GenerateSignedDocumentAsynch>boolean</GenerateSignedDocumentAsynch>
      </ClientURLs>
    </RequestRecipientToken>
  </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>
    <RequestRecipientTokenResponse xmlns="http://www.docusign.net/API/3.0">
      <RequestRecipientTokenResult>string</RequestRecipientTokenResult>
    </RequestRecipientTokenResponse>
  </soap12:Body>
</soap12:Envelope>