GET api/Document?userid={userid}&group={group}&docid={docid}&token={token}

Request Information

URI Parameters

Name	Type	Additional information
userid	string	Default value is
group	string	Default value is
docid	integer	Default value is -1
token	string	Default value is

Body Parameters

None.

Response Information

Resource Description

DocumentGetResponse

Name	Description	Type	Additional information
Data		Collection of Document	None.
Response		BaseResponseItems	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    {
      "Group": "sample string 1",
      "Status": "sample string 2",
      "Id": 3,
      "DisplayId": "sample string 4",
      "Requestor": "sample string 5",
      "RequestorId": "sample string 6",
      "SubjectName": "sample string 7",
      "DateOfBirth": "2025-08-20T14:28:37.782883+00:00",
      "Type": "sample string 9",
      "Date": "2025-08-20T14:28:37.782883+00:00",
      "DaysOutstanding": 11,
      "Comments": [
        {
          "Type": "sample string 1",
          "Text": "sample string 2",
          "Timestamp": "2025-08-20T14:28:37.782883+00:00"
        },
        {
          "Type": "sample string 1",
          "Text": "sample string 2",
          "Timestamp": "2025-08-20T14:28:37.782883+00:00"
        }
      ],
      "DocumentDate": "2025-08-20T14:28:37.782883+00:00",
      "Action": "sample string 13",
      "ActionDate": "2025-08-20T14:28:37.782883+00:00",
      "DeclineReason": "sample string 15",
      "Signers": [
        {
          "Guid": "sample string 1",
          "GroupGuid": "sample string 2",
          "Name": "sample string 3",
          "Role": "sample string 4",
          "Signed": true,
          "SignatureApplied": true
        },
        {
          "Guid": "sample string 1",
          "GroupGuid": "sample string 2",
          "Name": "sample string 3",
          "Role": "sample string 4",
          "Signed": true,
          "SignatureApplied": true
        }
      ],
      "DocumentData": "sample string 16",
      "PageCount": 17
    },
    {
      "Group": "sample string 1",
      "Status": "sample string 2",
      "Id": 3,
      "DisplayId": "sample string 4",
      "Requestor": "sample string 5",
      "RequestorId": "sample string 6",
      "SubjectName": "sample string 7",
      "DateOfBirth": "2025-08-20T14:28:37.782883+00:00",
      "Type": "sample string 9",
      "Date": "2025-08-20T14:28:37.782883+00:00",
      "DaysOutstanding": 11,
      "Comments": [
        {
          "Type": "sample string 1",
          "Text": "sample string 2",
          "Timestamp": "2025-08-20T14:28:37.782883+00:00"
        },
        {
          "Type": "sample string 1",
          "Text": "sample string 2",
          "Timestamp": "2025-08-20T14:28:37.782883+00:00"
        }
      ],
      "DocumentDate": "2025-08-20T14:28:37.782883+00:00",
      "Action": "sample string 13",
      "ActionDate": "2025-08-20T14:28:37.782883+00:00",
      "DeclineReason": "sample string 15",
      "Signers": [
        {
          "Guid": "sample string 1",
          "GroupGuid": "sample string 2",
          "Name": "sample string 3",
          "Role": "sample string 4",
          "Signed": true,
          "SignatureApplied": true
        },
        {
          "Guid": "sample string 1",
          "GroupGuid": "sample string 2",
          "Name": "sample string 3",
          "Role": "sample string 4",
          "Signed": true,
          "SignatureApplied": true
        }
      ],
      "DocumentData": "sample string 16",
      "PageCount": 17
    }
  ],
  "Response": {
    "Processed": "sample string 1",
    "Error": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<DocumentGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignAPI.Models.Responses">
  <Response>
    <Error>sample string 2</Error>
    <Processed>sample string 1</Processed>
  </Response>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignAPI.Models.DTOs">
    <d2p1:Document>
      <d2p1:Action>sample string 13</d2p1:Action>
      <d2p1:ActionDate>2025-08-20T14:28:37.782883+00:00</d2p1:ActionDate>
      <d2p1:Comments>
        <d2p1:DocumentComment>
          <d2p1:Text>sample string 2</d2p1:Text>
          <d2p1:Timestamp>2025-08-20T14:28:37.782883+00:00</d2p1:Timestamp>
          <d2p1:Type>sample string 1</d2p1:Type>
        </d2p1:DocumentComment>
        <d2p1:DocumentComment>
          <d2p1:Text>sample string 2</d2p1:Text>
          <d2p1:Timestamp>2025-08-20T14:28:37.782883+00:00</d2p1:Timestamp>
          <d2p1:Type>sample string 1</d2p1:Type>
        </d2p1:DocumentComment>
      </d2p1:Comments>
      <d2p1:Date>2025-08-20T14:28:37.782883+00:00</d2p1:Date>
      <d2p1:DateOfBirth>2025-08-20T14:28:37.782883+00:00</d2p1:DateOfBirth>
      <d2p1:DaysOutstanding>11</d2p1:DaysOutstanding>
      <d2p1:DeclineReason>sample string 15</d2p1:DeclineReason>
      <d2p1:DisplayId>sample string 4</d2p1:DisplayId>
      <d2p1:DocumentData>sample string 16</d2p1:DocumentData>
      <d2p1:DocumentDate>2025-08-20T14:28:37.782883+00:00</d2p1:DocumentDate>
      <d2p1:Group>sample string 1</d2p1:Group>
      <d2p1:Id>3</d2p1:Id>
      <d2p1:PageCount>17</d2p1:PageCount>
      <d2p1:Requestor>sample string 5</d2p1:Requestor>
      <d2p1:RequestorId>sample string 6</d2p1:RequestorId>
      <d2p1:Signers>
        <d2p1:Document.Signer>
          <d2p1:GroupGuid>sample string 2</d2p1:GroupGuid>
          <d2p1:Guid>sample string 1</d2p1:Guid>
          <d2p1:Name>sample string 3</d2p1:Name>
          <d2p1:Role>sample string 4</d2p1:Role>
          <d2p1:SignatureApplied>true</d2p1:SignatureApplied>
          <d2p1:Signed>true</d2p1:Signed>
        </d2p1:Document.Signer>
        <d2p1:Document.Signer>
          <d2p1:GroupGuid>sample string 2</d2p1:GroupGuid>
          <d2p1:Guid>sample string 1</d2p1:Guid>
          <d2p1:Name>sample string 3</d2p1:Name>
          <d2p1:Role>sample string 4</d2p1:Role>
          <d2p1:SignatureApplied>true</d2p1:SignatureApplied>
          <d2p1:Signed>true</d2p1:Signed>
        </d2p1:Document.Signer>
      </d2p1:Signers>
      <d2p1:Status>sample string 2</d2p1:Status>
      <d2p1:SubjectName>sample string 7</d2p1:SubjectName>
      <d2p1:Type>sample string 9</d2p1:Type>
      <d2p1:UserId>sample string 18</d2p1:UserId>
    </d2p1:Document>
    <d2p1:Document>
      <d2p1:Action>sample string 13</d2p1:Action>
      <d2p1:ActionDate>2025-08-20T14:28:37.782883+00:00</d2p1:ActionDate>
      <d2p1:Comments>
        <d2p1:DocumentComment>
          <d2p1:Text>sample string 2</d2p1:Text>
          <d2p1:Timestamp>2025-08-20T14:28:37.782883+00:00</d2p1:Timestamp>
          <d2p1:Type>sample string 1</d2p1:Type>
        </d2p1:DocumentComment>
        <d2p1:DocumentComment>
          <d2p1:Text>sample string 2</d2p1:Text>
          <d2p1:Timestamp>2025-08-20T14:28:37.782883+00:00</d2p1:Timestamp>
          <d2p1:Type>sample string 1</d2p1:Type>
        </d2p1:DocumentComment>
      </d2p1:Comments>
      <d2p1:Date>2025-08-20T14:28:37.782883+00:00</d2p1:Date>
      <d2p1:DateOfBirth>2025-08-20T14:28:37.782883+00:00</d2p1:DateOfBirth>
      <d2p1:DaysOutstanding>11</d2p1:DaysOutstanding>
      <d2p1:DeclineReason>sample string 15</d2p1:DeclineReason>
      <d2p1:DisplayId>sample string 4</d2p1:DisplayId>
      <d2p1:DocumentData>sample string 16</d2p1:DocumentData>
      <d2p1:DocumentDate>2025-08-20T14:28:37.782883+00:00</d2p1:DocumentDate>
      <d2p1:Group>sample string 1</d2p1:Group>
      <d2p1:Id>3</d2p1:Id>
      <d2p1:PageCount>17</d2p1:PageCount>
      <d2p1:Requestor>sample string 5</d2p1:Requestor>
      <d2p1:RequestorId>sample string 6</d2p1:RequestorId>
      <d2p1:Signers>
        <d2p1:Document.Signer>
          <d2p1:GroupGuid>sample string 2</d2p1:GroupGuid>
          <d2p1:Guid>sample string 1</d2p1:Guid>
          <d2p1:Name>sample string 3</d2p1:Name>
          <d2p1:Role>sample string 4</d2p1:Role>
          <d2p1:SignatureApplied>true</d2p1:SignatureApplied>
          <d2p1:Signed>true</d2p1:Signed>
        </d2p1:Document.Signer>
        <d2p1:Document.Signer>
          <d2p1:GroupGuid>sample string 2</d2p1:GroupGuid>
          <d2p1:Guid>sample string 1</d2p1:Guid>
          <d2p1:Name>sample string 3</d2p1:Name>
          <d2p1:Role>sample string 4</d2p1:Role>
          <d2p1:SignatureApplied>true</d2p1:SignatureApplied>
          <d2p1:Signed>true</d2p1:Signed>
        </d2p1:Document.Signer>
      </d2p1:Signers>
      <d2p1:Status>sample string 2</d2p1:Status>
      <d2p1:SubjectName>sample string 7</d2p1:SubjectName>
      <d2p1:Type>sample string 9</d2p1:Type>
      <d2p1:UserId>sample string 18</d2p1:UserId>
    </d2p1:Document>
  </Data>
</DocumentGetResponse>