Secured Signing API

<back to all web services

GetActiveDocumentsRequest

The following routes are available for this service:
GET/Document/GetActiveDocuments/{Folder}Returns account user's active documentsReturns an array of all In progress and signed documents that haven't been removed.
GetActiveDocumentsRequest Parameters:
NameParameterData TypeRequiredDescription
FolderpathstringYes

Allowable Values

  • InBox
  • Progress
  • Signed
DocumentLogquerybooleanNowheather return with documeng log

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Document/GetActiveDocuments/{Folder} HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
  <DocumentResponse>
    <Reference>String</Reference>
    <ClientReference>String</ClientReference>
    <DueDate>String</DueDate>
    <EditUrl>String</EditUrl>
    <Folder>String</Folder>
    <FormDirectReference>String</FormDirectReference>
    <GMT>String</GMT>
    <HasFileUploaded>false</HasFileUploaded>
    <IDVerificationRequested>false</IDVerificationRequested>
    <LastSignedDate>String</LastSignedDate>
    <Logs>
      <DocumentLog>
        <Action>String</Action>
        <Date>String</Date>
        <GMT>String</GMT>
        <Name>String</Name>
        <Role>String</Role>
      </DocumentLog>
    </Logs>
    <MatterNumber>String</MatterNumber>
    <Name>String</Name>
    <PackageReference>String</PackageReference>
    <Signers>
      <SignerStatusResponse>
        <Email>String</Email>
        <FirstName>String</FirstName>
        <LastName>String</LastName>
        <MiddleName>String</MiddleName>
        <ClientReference>String</ClientReference>
        <MobileCountry>String</MobileCountry>
        <MobileNumber>String</MobileNumber>
        <ShareUsers>
          <ShareUser>
            <Email>String</Email>
            <FirstName>String</FirstName>
            <LastName>String</LastName>
            <MiddleName>String</MiddleName>
            <IsDefault>false</IsDefault>
            <IsOwner>false</IsOwner>
          </ShareUser>
        </ShareUsers>
        <IsFaceToFaceSigning>false</IsFaceToFaceSigning>
        <ReviewBeforeSigningEnabled>false</ReviewBeforeSigningEnabled>
        <SignerReference>String</SignerReference>
        <VideoConfirmationEnabled>false</VideoConfirmationEnabled>
        <SigningKey>String</SigningKey>
        <DeclinedReason>String</DeclinedReason>
        <Editable>false</Editable>
        <HasSigned>false</HasSigned>
        <IDCheckStatus>String</IDCheckStatus>
        <IDVerificationFaceMatchResult>String</IDVerificationFaceMatchResult>
        <IDVerificationLivenessResult>String</IDVerificationLivenessResult>
        <IDVerificationResult>String</IDVerificationResult>
        <IDVerificationStatus>String</IDVerificationStatus>
        <SignedStatus>Initialized</SignedStatus>
        <VideoConfirmationDetail>
          <Email>String</Email>
          <IsVideoDisabled>false</IsVideoDisabled>
          <IsVideoOptOut>false</IsVideoOptOut>
          <IsVideoReady>false</IsVideoReady>
          <IsWitness>false</IsWitness>
          <Name>String</Name>
          <Password>String</Password>
          <ShortUrl>String</ShortUrl>
          <WitnessOwner>String</WitnessOwner>
        </VideoConfirmationDetail>
      </SignerStatusResponse>
    </Signers>
    <Status>String</Status>
  </DocumentResponse>
</ArrayOfDocumentResponse>