GET Get History of the document API

This API will get the recipients and history of the document.

Request Attributes

API Content Type: JSON

Head

ATTRIBUTE DESCRIPTION
x-access-token
string
mandatory
Token generated from the authentication api.
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.TU5NzgyMDA1N30.9eO_xh eyJEYXRhIjp7InVzZXJpZCI6IjY3NCIsImVtYWlsIjoiYWFhYWFhYWFhYWjuunGJQ YmwuY29tIiwia2V5IjoidGVzdGluZ0tleSJ9LCJpYXQiOjE1OTc3NDA4NTpj6gc8dM csIFhY7n1mV4cUBxa2P3ICI6M2VyWq19OzuHAefeTEj

query

ATTRIBUTE DESCRIPTION
SId
string
mandatory
Signed Id of the document in encrypted form.
Example: 8d23138efeaf2a6dc2ac65689896c2ee:359f280d85af0a6cb73da2489c2c7f79
UId
string
mandatory
User Id of the sender in encrypted form.
Example: 4e896290b7d078e1d780fecc4ef37eba:76bcc02f88004069e497637db1e9fb89
eid
string
mandatory
Email Id of the sender in encrypted form.
Example: d28aa0016c6f24a353abbf187c96929e:00962c5c6e9cd3f0efd3e33c88c6d99d9d6b976482b41fed883e17b591bc3c71

Response Attributes

API Content Type: JSON

body

ATTRIBUTE DESCRIPTION
statuscode
string(3)
This is the status code corresponding to a particular message and is returned to the user. The different status codes corresponding to this API are mentioned below
Example: 200
message
string(100)
This parameter is the result message which contains information about the result.
Example: Get Data Successfully.
array of object
This parameter gives the information of the recipients of the document.
Attribute Description
RecipientId
numeric
Id of the Recipient.
Example: 1
CaseStatus
string
Status of the document.
Example: Completed
RecStatus
string
Status of the Document from Recipient.
Example: Completed
RecipientName
string
Name of the recipient.
Example: Govyanshi Upadhyay
Code
numeric
Code to access the document.
Example: 120044
RecipientEmail
string
Email Id of the recipient.
Example: govyanshi.upadhyay@konze.com
MessageStatus
string
Status of the email.
Example: accepted
IsGroupPresent
boolean
It indicates whether it is a group or not.
Example: false
Requests
numeric
Number of recipients of the document.
Example: 3
Remaining
numeric
Number of recipients who hasn't completed the document.
Example: 1
Signoption
string
Signing option of the document.
Example: Need to Sign
IsDelegated
boolean
It indicates whether the document is delegated or not.
Example: false
array of object
This parameter gives the information about the history of the document.
Attribute Description
SenderName
string
Name of the sender of the document.
Example: Govyanshi Upadhyay
SenderEmail
string
Email Id of the sender of the document.
Example: Another Test
CaseName
string
Name of the document.
Example: Memo Temp
CaseStatus
string
Status of the document.
Example: Completed
DocCompletedDate
string
The document completion date.
Example: 14 Jun 2023 , 05:41 AM
RecipientName
string
Name of the recipient.
Example: Keval Pandya
RecipientStatus
string
Status of the document for that recipient.
Example: Completed
RecipientSignDate
string
The date on which recipient signed the document.
Example: 14 Jun 2023 , 05:41 AM
RecipientEmail
string
Email Id of the recipient.
Example: keval.pandya@konze.com
MailSentDate
string
Date on which email has been sent to the recipient.
Example: 14 Jun 2023 , 05:37 AM
Ipaddress
string
IP address of the machine.
Example: 1
Country
string
Country.
Example: India
browser
string
Browser of the recipient from where the document is viewed/signed.
Example: Chrome 114.0.0.0
os
string
Operating System of the device.
Example: Windows 10
Mobile
boolean
It indicates where the document is signed/viewed by mobile.
Example: Windows 10
ScreenSize
string
ScreenSize of the device.
Example: 1600 x 900
Navigator
string
Navigator.
Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36
Timezone
string
Timezone.
Example: UTC
Activity
string
It indicates what action has been performed on the document.
Example: viewed the document
RecipientRole
string
Role of the recipient.
Example: HR

Response Codes and Messages

statuscode status Description
200
true
 Success
401
false
 Your Session has expired
409
false
 Conflict has occured
422
false
 Invalid parameter
500
false
 System error
https://console.konsign.com/api/SignedDocument/getHistory?UId=YOUR_USER_ID&SId=YOUR_SIGNED_DOCUMENT_ID&eid=YOUR_EMAIL_ID
https://console.konsign.com/api/SignedDocument/getHistory?UId=YOUR_USER_ID&SId=YOUR_SIGNED_DOCUMENT_ID&eid=YOUR_EMAIL_ID
REQUEST RESPONSE 
											
                                                var request = require('request');
												var options = {
												'method': 'GET',
												'url': 'https://console.konsign.com/api/SignedDocument/getHistory?UId=YOUR_USER_ID&SId=YOUR_SIGNED_DOCUMENT_ID&eid=YOUR_EMAIL_ID',
												'headers': {
												}
												};
												request(options, function (error, response) {
												if (error) throw new Error(error);
												console.log(response.body);
												});

										
									

											var client = new HttpClient();
											var request = new HttpRequestMessage(HttpMethod.Get, "https://console.konsign.com/api/SignedDocument/getHistory?UId=YOUR_USER_ID&SId=YOUR_SIGNED_DOCUMENT_ID&eid=YOUR_EMAIL_ID");
											var response = await client.SendAsync(request);
											response.EnsureSuccessStatusCode();
											Console.WriteLine(await response.Content.ReadAsStringAsync());
										
									
										{
											"head": {
												"responseTimestamp": "1526969112101",
												"version": "v1",
												"clientId": "C11",
												"signature": "TXBw50YPUKIgJd8gR8RpZuOMZ+csvCT7i0/YXmG//J8+BpFdY5goPBiLAkCzKlCkOvAQip/Op5aD6Vs+cNUTjFmC55JBxvp7WunZ45Ke2q0="
											},
											"body": {
												"resultInfo": {
													"resultStatus": "S",
													"resultCode": "0000",
													"resultMsg": "Success"
												},
												"txnToken": "fe795335ed3049c78a57271075f2199e1526969112097",
												"isPromoCodeValid": false,
												"authenticated": false
											}
										}