GetRecipientAuthenticationStatusEx

This method requests the details of authentication checks for a recipient.

Schema

Name	Schema Type	Description
EnvelopeId	DSXId	The envelope ID associated with the recipient authentication check.
RecipientEmail	String	The recipient’s email address.
RecipientName	String	The recipient’s name.
RoutingOrder	Integer	Optional element. The recipient’s RoutingOrder in the envelope.

Sample Request XML

SOAPAction: "http://www.docusign.net/API/3.0/GetRecipientAuthenticationStatusEx"
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <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>

This method returns AuthenticationStatus with elements listed below. The response only returns the applicable authentication result. The result contains the authentication status, a date time stamp and authentication failure details (if provided).

Name	Schema Type	Description
AccessCodeResult	EventResult	Result for an access code authentication check, it returns: – Pass or Fail, – The date/time of the event, – A string with the details of a failed authentication, if provided. This is only provided in case of a failed authentication. – A string with a vendor status code, if provided. This is only provided in case of a failed authentication.
IDQuestionsResult	EventResult	Result for an ID question authentication check. It returns the same elements as shown in the AccessCodeResult above.
IDLookupResult	EventResult	Result for an ID lookup authentication check. It returns the same elements as shown in the AccessCodeResult above.
AgeVerifyResult	EventResult	Result for an age verification authentication check. It returns the same elements as shown in the AccessCodeResult above.
STANPinResult	EventResult	Result for a Student Authentication Network (STAN) check. It returns the same elements as shown in the AccessCodeResult above.
OFACResult	EventResult	Result for an Office of Foreign Asset Control (OFAC) check. It returns the same elements as shown in the AccessCodeResult above.
PhoneAuthResult	EventResult	Result for a phone authentication check. It returns the same elements as shown in the AccessCodeResult above.
LiveIDResult	EventResult	Result for a Live ID authentication check. It returns the same elements as shown in the AccessCodeResult above.
FacebookResult	EventResult	Result for a Facebook authentication check. It returns the same elements as shown in the AccessCodeResult above.
GoogleResult	EventResult	Result for a Google authentication check. It returns the same elements as shown in the AccessCodeResult above.
LinkedinResult	EventResult	Result for a LinkedIn authentication check. It returns the same elements as shown in the AccessCodeResult above.
SalesforceResult	EventResult	Result for a Salesforce authentication check. It returns the same elements as shown in the AccessCodeResult above.
TwitterResult	EventResult	Result for a Twitter authentication check. It returns the same elements as shown in the AccessCodeResult above.
OpenIDResult	EventResult	Result for an Open ID authentication check. It returns the same elements as shown in the AccessCodeResult above.
AnySocialIDResult	EventResult	Result for any other social ID authentication check. It returns the same elements as shown in the AccessCodeResult above.
YahooResult	EventResult	Result for a Yahoo authentication check. It returns the same elements as shown in the AccessCodeResult above.

Sample Response XML

<?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>