APIService Web Service

APIService

Click here for a complete list of operations.

GetRecipientAuthenticationStatusEx

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

<?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>
    <GetRecipientAuthenticationStatusEx xmlns="http://www.docusign.net/API/3.0">
      <Arg>
        <EnvelopeId>string</EnvelopeId>
        <RecipientName>string</RecipientName>
        <RecipientEmail>string</RecipientEmail>
        <RoutingOrder>int</RoutingOrder>
      </Arg>
    </GetRecipientAuthenticationStatusEx>
  </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>
    <GetRecipientAuthenticationStatusExResponse xmlns="http://www.docusign.net/API/3.0">
      <GetRecipientAuthenticationStatusExResult>
        <AccessCodeResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </AccessCodeResult>
        <IDQuestionsResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </IDQuestionsResult>
        <IDLookupResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </IDLookupResult>
        <AgeVerifyResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </AgeVerifyResult>
        <STANPinResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </STANPinResult>
        <OFACResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </OFACResult>
        <PhoneAuthResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </PhoneAuthResult>
        <LiveIDResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </LiveIDResult>
        <FacebookResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </FacebookResult>
        <GoogleResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </GoogleResult>
        <LinkedinResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </LinkedinResult>
        <SalesforceResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </SalesforceResult>
        <TwitterResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </TwitterResult>
        <OpenIDResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </OpenIDResult>
        <AnySocialIDResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </AnySocialIDResult>
        <YahooResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </YahooResult>
      </GetRecipientAuthenticationStatusExResult>
    </GetRecipientAuthenticationStatusExResponse>
  </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/api.asmx HTTP/1.1
Host: eu1.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>
    <GetRecipientAuthenticationStatusEx xmlns="http://www.docusign.net/API/3.0">
      <Arg>
        <EnvelopeId>string</EnvelopeId>
        <RecipientName>string</RecipientName>
        <RecipientEmail>string</RecipientEmail>
        <RoutingOrder>int</RoutingOrder>
      </Arg>
    </GetRecipientAuthenticationStatusEx>
  </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>
    <GetRecipientAuthenticationStatusExResponse xmlns="http://www.docusign.net/API/3.0">
      <GetRecipientAuthenticationStatusExResult>
        <AccessCodeResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </AccessCodeResult>
        <IDQuestionsResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </IDQuestionsResult>
        <IDLookupResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </IDLookupResult>
        <AgeVerifyResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </AgeVerifyResult>
        <STANPinResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </STANPinResult>
        <OFACResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </OFACResult>
        <PhoneAuthResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </PhoneAuthResult>
        <LiveIDResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </LiveIDResult>
        <FacebookResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </FacebookResult>
        <GoogleResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </GoogleResult>
        <LinkedinResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </LinkedinResult>
        <SalesforceResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </SalesforceResult>
        <TwitterResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </TwitterResult>
        <OpenIDResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </OpenIDResult>
        <AnySocialIDResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </AnySocialIDResult>
        <YahooResult>
          <Status>Passed or Failed</Status>
          <EventTimestamp>dateTime</EventTimestamp>
          <FailureDescription>string</FailureDescription>
          <VendorFailureStatusCode>string</VendorFailureStatusCode>
        </YahooResult>
      </GetRecipientAuthenticationStatusExResult>
    </GetRecipientAuthenticationStatusExResponse>
  </soap12:Body>
</soap12:Envelope>