GET Get Prepared Document Data API

This API will list all the data for the prepared 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
Session Id of the document in encrypted form, session id is fetched from the response of the create document api.
Example: ecNUhTVdQthOp1sqVRohsbWgwKptzV1ELEFY2La0RUguloSfxuTs64ks4Cobvgju

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 about the result of the API response.
Attribute Description
SrNo
numeric
Serial Number of the recipient.
Example: 1
Id
numeric
Id of the recipient
Example: 33303
Name
string
Name of the Recipient.
Example: Govyanshi Upadhyay
Email
string
Email addresss of the recipient.
Example: govyanshi.upadhyay@konze.com
Mobile
numeric
Phone Number of the recipient.
Example: 896543211
AccessCode
string
Access code for the document.
Example: 0
chkcode
boolean
It indicates whether access code is present or not.
Example: false
Signoption
string
Signing option.
Example: Need To Sign
Sign_Doc_Id
numeric
Signed Document Id of the document.
Example: 22120
Signingorder
numeric
Signing order of the document for recipient.
Example: 1
SignImagePath
string
Signing image path of the document.
Example: NULL
Setsignorder
boolean
It indicates whether the signing order is set or not.
Example: false
Showsign
boolean
Show Sign.
Example: false
ExpirDate
string
Expiry Date of the document.
Example: 2023-05-02 13:01:58.733
Note
string
Note.
Example: Hey
Status
string
Status of the document.
Example: In Process
Active
booelan
It indicates whether the document is active.
Example: true
IsDeleted
booelan
It indicates whether the document is deleted or not.
Example: false
CreatedBy
numeric
User Id of the creator.
Example:  24546
CreatedOn
string
Date on which the document is created.
Example: 2023-05-02T13:01:58.733Z
UpdatedBy
numeric
Id of the user who last modified the document.
Example: 1096
UpdatedOn
string
Date on which the document is modified.
Example: 2023-06-02T13:01:58.733Z
IsGroup
boolean
It indicates whether it is a group or not.
Example: false
GroupName
string
Name of the group.
Example: Techies
GroupId
numeric
Id of the Group.
Example: 123
UserInput
numeric
Input from the user.
Example: null
AllowSigners
boolean
Allow Signers.
Example: true
Colour
string
Colour of the sign.
Example: #007bff
Role
string
Role of the recipient.
Example:Admin
array of object
This parameter gives the information about the recipient of the document.
Attribute Description
Sign_ID
numeric
Signed Document Id.
Example: 22120
Name
string
Name of the document.
Example: Another Test
Doc_Mast_Id
numeric
Document Master Id.
Example: 24634
FullImageName
string
Location of the file in base64 encoded form.
Example: L3VwbG9hZHMvNmM5YmJiN2 EtOTlhNC00MjVkLWFmYzAtMDZmNjJjMDIwMGRjLzZjOWJ iYjdhLTk5YThZmMwLTA2ZjYyYzAyMDBkYy5qcGc=
FileName
string
Name of the file.
Example: testingtest.jpg
SignLocation
string
Location where controls are placed.
Example: [{"parentdocid":"doc_0","docname":"doc_0", "maindivid":"sign_main_0","controlname":"signdiv", "mastid":"21413520e7e25dc602539a95690b5049:d29008706f513d29b6d16f162e2dae32", "isoriginal":"true","controlvalue":"Signature","controlid":"","controlXpos":"468px", "controlYpos":"366px","parentdocheight":1081, "parentdocwidth":750,"noofradiobuttons":0, "noofcheckboxes":0,"value":"Signature","roleid":"3815", "signername":"3815|buyer ()","isrequired":"required", "signerid":"3815|buyer ()","reciname":"3815|buyer ()", "title":"buyer ()","placeholder":"","backgroundColor":"", "color":"rgb(102, 16, 242)","fontsize":"16px","screenwidth":1440, "screenheight":821,"elementWidth":93.1719,"elementHeight":52.5078}]
Doc_Id
numeric
Document Id.
Example: 24634
caseid
string
Case Id.
Example: YGSM8XB9202305021301558441159
isPredefine
booelan
It indicates the predefined field.
Example: false
ExpireDate
string
Expiry date of the document.
Example: 2023-12-03T00:00:00.000Z

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/getallprepareddocumentdata?sid=YOUR_SESSION_ID
https://console.konsign.com/api/SignedDocument/getallprepareddocumentdata?sid=YOUR_SESSION_ID
REQUEST RESPONSE 
											
                                                var request = require('request');
                                                var options = {
                                                'method': 'GET',
                                                'url': 'https://console.konsign.com/api/SignedDocument/getallprepareddocumentdata?sid=YOUR_SESSION_ID',
                                                'headers': {
                                                    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJEYXRhIjp7InVzZXJpZCI6IjU0NiIsImVtYWlsIjoiaGl0ZXNoLmpvc2hpQGtvbnplLmNvbSIsImFwcEtleSI6IjNhNjI4N2U3LTNkOTItNDVjNy04YTk2LTg0MjAyMjA0MDc1MiIsImtleSI6InByb2R1Y3Rpb25LZXkifSwiaWF0IjoxNjgzMDkzMDg5LCJleHAiOjE2ODMxNzIyODl9.xNAwNMzpFz3yZ_zjQDhhwHbZfregq0I1O3uH6ZwXal4'
                                                }
                                                };
                                                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/getallprepareddocumentdata?sid=YOUR_SESSION_ID");
                                            request.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJEYXRhIjp7InVzZXJpZCI6IjU0NiIsImVtYWlsIjoiaGl0ZXNoLmpvc2hpQGtvbnplLmNvbSIsImFwcEtleSI6IjNhNjI4N2U3LTNkOTItNDVjNy04YTk2LTg0MjAyMjA0MDc1MiIsImtleSI6InByb2R1Y3Rpb25LZXkifSwiaWF0IjoxNjgzMDkzMDg5LCJleHAiOjE2ODMxNzIyODl9.xNAwNMzpFz3yZ_zjQDhhwHbZfregq0I1O3uH6ZwXal4");
                                            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
											}
										}