APIService Web Service

APIService

Click here for a complete list of operations.

RequestStatusEx

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/RequestStatusEx"

<?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>
    <RequestStatusEx xmlns="http://www.docusign.net/API/3.0">
      <EnvelopeID>string</EnvelopeID>
    </RequestStatusEx>
  </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>
    <RequestStatusExResponse xmlns="http://www.docusign.net/API/3.0">
      <RequestStatusExResult>
        <RecipientStatuses>
          <RecipientStatus>
            <Type>Signer or Agent or Editor or Intermediary or CarbonCopy or CertifiedDelivery or InPersonSigner or SigningHost</Type>
            <Email>string</Email>
            <UserName>string</UserName>
            <RoutingOrder>unsignedShort</RoutingOrder>
            <Sent>dateTime</Sent>
            <Delivered>dateTime</Delivered>
            <Signed>dateTime</Signed>
            <Declined>dateTime</Declined>
            <DeclineReason>string</DeclineReason>
            <AutoRespondedReason>string</AutoRespondedReason>
            <Status>Created or Sent or Delivered or Signed or Declined or Completed or FaxPending or AutoResponded</Status>
            <RecipientIPAddress>string</RecipientIPAddress>
            <ClientUserId>string</ClientUserId>
            <AutoNavigation>boolean</AutoNavigation>
            <IDCheckInformation xsi:nil="true" />
            <RecipientAuthenticationStatus xsi:nil="true" />
            <CustomFields xsi:nil="true" />
            <TabStatuses xsi:nil="true" />
            <RecipientAttachment xsi:nil="true" />
            <AccountStatus>string</AccountStatus>
            <EsignAgreementInformation xsi:nil="true" />
            <FormData xsi:nil="true" />
            <RecipientId>string</RecipientId>
            <DeliveryMethod>Email or Fax</DeliveryMethod>
            <FaxNumber>string</FaxNumber>
          </RecipientStatus>
          <RecipientStatus>
            <Type>Signer or Agent or Editor or Intermediary or CarbonCopy or CertifiedDelivery or InPersonSigner or SigningHost</Type>
            <Email>string</Email>
            <UserName>string</UserName>
            <RoutingOrder>unsignedShort</RoutingOrder>
            <Sent>dateTime</Sent>
            <Delivered>dateTime</Delivered>
            <Signed>dateTime</Signed>
            <Declined>dateTime</Declined>
            <DeclineReason>string</DeclineReason>
            <AutoRespondedReason>string</AutoRespondedReason>
            <Status>Created or Sent or Delivered or Signed or Declined or Completed or FaxPending or AutoResponded</Status>
            <RecipientIPAddress>string</RecipientIPAddress>
            <ClientUserId>string</ClientUserId>
            <AutoNavigation>boolean</AutoNavigation>
            <IDCheckInformation xsi:nil="true" />
            <RecipientAuthenticationStatus xsi:nil="true" />
            <CustomFields xsi:nil="true" />
            <TabStatuses xsi:nil="true" />
            <RecipientAttachment xsi:nil="true" />
            <AccountStatus>string</AccountStatus>
            <EsignAgreementInformation xsi:nil="true" />
            <FormData xsi:nil="true" />
            <RecipientId>string</RecipientId>
            <DeliveryMethod>Email or Fax</DeliveryMethod>
            <FaxNumber>string</FaxNumber>
          </RecipientStatus>
        </RecipientStatuses>
        <TimeGenerated>dateTime</TimeGenerated>
        <EnvelopeID>string</EnvelopeID>
        <Subject>string</Subject>
        <UserName>string</UserName>
        <Email>string</Email>
        <Status>Any or Voided or Created or Deleted or Sent or Delivered or Signed or Completed or Declined or TimedOut or Template or Processing</Status>
        <Created>dateTime</Created>
        <Deleted>dateTime</Deleted>
        <Sent>dateTime</Sent>
        <Delivered>dateTime</Delivered>
        <Signed>dateTime</Signed>
        <Completed>dateTime</Completed>
        <Declined>dateTime</Declined>
        <TimedOut>dateTime</TimedOut>
        <ACStatus>string</ACStatus>
        <ACStatusDate>dateTime</ACStatusDate>
        <ACHolder>string</ACHolder>
        <ACHolderEmail>string</ACHolderEmail>
        <ACHolderLocation>string</ACHolderLocation>
        <SigningLocation>InPerson or Online</SigningLocation>
        <SenderIPAddress>string</SenderIPAddress>
        <EnvelopePDFHash>string</EnvelopePDFHash>
        <CustomFields>
          <CustomField>
            <Name>string</Name>
            <Show>string</Show>
            <Required>string</Required>
            <Value>string</Value>
            <CustomFieldType>Text or List</CustomFieldType>
            <ListItems>string</ListItems>
          </CustomField>
          <CustomField>
            <Name>string</Name>
            <Show>string</Show>
            <Required>string</Required>
            <Value>string</Value>
            <CustomFieldType>Text or List</CustomFieldType>
            <ListItems>string</ListItems>
          </CustomField>
        </CustomFields>
        <VaultingDetails>
          <EODTransactionName>string</EODTransactionName>
          <EODTransactionID>string</EODTransactionID>
          <EODDocumentProfileID>string</EODDocumentProfileID>
        </VaultingDetails>
        <AutoNavigation>boolean</AutoNavigation>
        <EnvelopeIdStamping>boolean</EnvelopeIdStamping>
        <AuthoritativeCopy>boolean</AuthoritativeCopy>
        <EnvelopeAttachment>
          <Attachment>
            <Data>base64Binary</Data>
            <Label>string</Label>
            <Type>string</Type>
          </Attachment>
          <Attachment>
            <Data>base64Binary</Data>
            <Label>string</Label>
            <Type>string</Type>
          </Attachment>
        </EnvelopeAttachment>
        <DocumentStatuses>
          <DocumentStatus>
            <ID>positiveInteger</ID>
            <Name>string</Name>
            <TemplateName>string</TemplateName>
            <Sequence>positiveInteger</Sequence>
            <DocumentFields xsi:nil="true" />
          </DocumentStatus>
          <DocumentStatus>
            <ID>positiveInteger</ID>
            <Name>string</Name>
            <TemplateName>string</TemplateName>
            <Sequence>positiveInteger</Sequence>
            <DocumentFields xsi:nil="true" />
          </DocumentStatus>
        </DocumentStatuses>
        <FormData>
          <xfdf>
            <fields xsi:nil="true" />
          </xfdf>
        </FormData>
        <VoidReason>string</VoidReason>
      </RequestStatusExResult>
    </RequestStatusExResponse>
  </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>
    <RequestStatusEx xmlns="http://www.docusign.net/API/3.0">
      <EnvelopeID>string</EnvelopeID>
    </RequestStatusEx>
  </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>
    <RequestStatusExResponse xmlns="http://www.docusign.net/API/3.0">
      <RequestStatusExResult>
        <RecipientStatuses>
          <RecipientStatus>
            <Type>Signer or Agent or Editor or Intermediary or CarbonCopy or CertifiedDelivery or InPersonSigner or SigningHost</Type>
            <Email>string</Email>
            <UserName>string</UserName>
            <RoutingOrder>unsignedShort</RoutingOrder>
            <Sent>dateTime</Sent>
            <Delivered>dateTime</Delivered>
            <Signed>dateTime</Signed>
            <Declined>dateTime</Declined>
            <DeclineReason>string</DeclineReason>
            <AutoRespondedReason>string</AutoRespondedReason>
            <Status>Created or Sent or Delivered or Signed or Declined or Completed or FaxPending or AutoResponded</Status>
            <RecipientIPAddress>string</RecipientIPAddress>
            <ClientUserId>string</ClientUserId>
            <AutoNavigation>boolean</AutoNavigation>
            <IDCheckInformation xsi:nil="true" />
            <RecipientAuthenticationStatus xsi:nil="true" />
            <CustomFields xsi:nil="true" />
            <TabStatuses xsi:nil="true" />
            <RecipientAttachment xsi:nil="true" />
            <AccountStatus>string</AccountStatus>
            <EsignAgreementInformation xsi:nil="true" />
            <FormData xsi:nil="true" />
            <RecipientId>string</RecipientId>
            <DeliveryMethod>Email or Fax</DeliveryMethod>
            <FaxNumber>string</FaxNumber>
          </RecipientStatus>
          <RecipientStatus>
            <Type>Signer or Agent or Editor or Intermediary or CarbonCopy or CertifiedDelivery or InPersonSigner or SigningHost</Type>
            <Email>string</Email>
            <UserName>string</UserName>
            <RoutingOrder>unsignedShort</RoutingOrder>
            <Sent>dateTime</Sent>
            <Delivered>dateTime</Delivered>
            <Signed>dateTime</Signed>
            <Declined>dateTime</Declined>
            <DeclineReason>string</DeclineReason>
            <AutoRespondedReason>string</AutoRespondedReason>
            <Status>Created or Sent or Delivered or Signed or Declined or Completed or FaxPending or AutoResponded</Status>
            <RecipientIPAddress>string</RecipientIPAddress>
            <ClientUserId>string</ClientUserId>
            <AutoNavigation>boolean</AutoNavigation>
            <IDCheckInformation xsi:nil="true" />
            <RecipientAuthenticationStatus xsi:nil="true" />
            <CustomFields xsi:nil="true" />
            <TabStatuses xsi:nil="true" />
            <RecipientAttachment xsi:nil="true" />
            <AccountStatus>string</AccountStatus>
            <EsignAgreementInformation xsi:nil="true" />
            <FormData xsi:nil="true" />
            <RecipientId>string</RecipientId>
            <DeliveryMethod>Email or Fax</DeliveryMethod>
            <FaxNumber>string</FaxNumber>
          </RecipientStatus>
        </RecipientStatuses>
        <TimeGenerated>dateTime</TimeGenerated>
        <EnvelopeID>string</EnvelopeID>
        <Subject>string</Subject>
        <UserName>string</UserName>
        <Email>string</Email>
        <Status>Any or Voided or Created or Deleted or Sent or Delivered or Signed or Completed or Declined or TimedOut or Template or Processing</Status>
        <Created>dateTime</Created>
        <Deleted>dateTime</Deleted>
        <Sent>dateTime</Sent>
        <Delivered>dateTime</Delivered>
        <Signed>dateTime</Signed>
        <Completed>dateTime</Completed>
        <Declined>dateTime</Declined>
        <TimedOut>dateTime</TimedOut>
        <ACStatus>string</ACStatus>
        <ACStatusDate>dateTime</ACStatusDate>
        <ACHolder>string</ACHolder>
        <ACHolderEmail>string</ACHolderEmail>
        <ACHolderLocation>string</ACHolderLocation>
        <SigningLocation>InPerson or Online</SigningLocation>
        <SenderIPAddress>string</SenderIPAddress>
        <EnvelopePDFHash>string</EnvelopePDFHash>
        <CustomFields>
          <CustomField>
            <Name>string</Name>
            <Show>string</Show>
            <Required>string</Required>
            <Value>string</Value>
            <CustomFieldType>Text or List</CustomFieldType>
            <ListItems>string</ListItems>
          </CustomField>
          <CustomField>
            <Name>string</Name>
            <Show>string</Show>
            <Required>string</Required>
            <Value>string</Value>
            <CustomFieldType>Text or List</CustomFieldType>
            <ListItems>string</ListItems>
          </CustomField>
        </CustomFields>
        <VaultingDetails>
          <EODTransactionName>string</EODTransactionName>
          <EODTransactionID>string</EODTransactionID>
          <EODDocumentProfileID>string</EODDocumentProfileID>
        </VaultingDetails>
        <AutoNavigation>boolean</AutoNavigation>
        <EnvelopeIdStamping>boolean</EnvelopeIdStamping>
        <AuthoritativeCopy>boolean</AuthoritativeCopy>
        <EnvelopeAttachment>
          <Attachment>
            <Data>base64Binary</Data>
            <Label>string</Label>
            <Type>string</Type>
          </Attachment>
          <Attachment>
            <Data>base64Binary</Data>
            <Label>string</Label>
            <Type>string</Type>
          </Attachment>
        </EnvelopeAttachment>
        <DocumentStatuses>
          <DocumentStatus>
            <ID>positiveInteger</ID>
            <Name>string</Name>
            <TemplateName>string</TemplateName>
            <Sequence>positiveInteger</Sequence>
            <DocumentFields xsi:nil="true" />
          </DocumentStatus>
          <DocumentStatus>
            <ID>positiveInteger</ID>
            <Name>string</Name>
            <TemplateName>string</TemplateName>
            <Sequence>positiveInteger</Sequence>
            <DocumentFields xsi:nil="true" />
          </DocumentStatus>
        </DocumentStatuses>
        <FormData>
          <xfdf>
            <fields xsi:nil="true" />
          </xfdf>
        </FormData>
        <VoidReason>string</VoidReason>
      </RequestStatusExResult>
    </RequestStatusExResponse>
  </soap12:Body>
</soap12:Envelope>