This API allows user to get list of document from a specific account. You can specify start index and end index of a list. If a date is specify, only document updated on the specific date will be listed.

You can set level of information is needed. Either you need the signer information or only document information.

This API allows filter based on the document state. You can choose to get all documents or only document in certain state, eg: document that in completed state.

Sequence to call API for get document list

Source Code Sample

String startIndex = "0";
String pageSize = "0";  
String rDetail = "2"; 
String state="1"; 
String date=""

String param = "{\"startIndex\":\"" + startIndex + "\",\"pageSize\":\"" + pageSize + "\",\"rDetail\":\"" + rDetail + "\",\"contractState\":\"" + state + "\"}";
byte[] encRequestBody = Utils.aesEcbPkcs5PaddingEncrypt(param, apiSecret);
data = Utils.bytes2HexString(encRequestBody);
mac = Utils.SHA256(new StringBuilder(data).append(apiSecret).toString().getBytes()); 

Sample code to get document list from response

Request Body Creation

{
	"startIndex":"0",
	"pageSize":"0",
	"rDetail": "2",
	"contractState": "1",
}

Example of Request

https://<domain>/signserver/v1/contract/list?accesstoken=d7a3ad1586084a58&data=5a899f31ce22453fadc37c1a&mac=75706f345fc7129c6eb5cb

Expected Response

{
   "contractList":[
     {
        "createtime":"2021-07-15 23:11:23",
        "addressee":
         [
             {
              "idcardnum":"",
              "signstate":1,
              "authtype":0
             }
         ],
        "contractnumber":"3F075B0EC95853A5B736825C5E0DDB8B",
        "contractlog":
        [
             {
              "logtype":0,
              "description":"Document [] added",
              "logtime":"2021-07-15 23:11:23", 
              "operator":"chrischang@gmail.com"
             },
             {
              "logtype":1,
              "description":"Document viewed by recipient: [chrischang@gmail.com]",
              "logtime":"2021-07-16 13:48:37", 
              "operator":" chrischang@gmail.com"
             },
             {
               "logtype":2,
               "description":"[] API used:'signFlatSignContract' contract signed:[3F075B0EC95853A5B736825C5E0DDB8B]  Success!",
               "logtime":"2021-07-16 13:49:05", 
               "operator":" chrischang@gmail.com"
             },
         }
      ],
   "contractCnt":1,
   "contractTotal":1
}

API reference :  Get Document List