Developer

POST Document Fill and Sign API

This API will allow the user to send the document to multiple recipients. Those recipients can put their editable controls by themselves.

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

body

ATTRIBUTE

DESCRIPTION

user_id

string(32)

mandatory

UserId given in companyprofile page.

Example: USR1HINU6OROEZZP1YS1592227436777

document_name

string(32)

mandatory

Name of the document.

Example: HR Policy

documents

array of object

mandatory

An Array of multiple documents.

Example: HR Policy

Attribute	Description
name string(32) mandatory	Name of the file. Example: HR Policy
fileExtension string(10) mandatory	Extention of the file. Example: .pdf
documentBase64 string(max) mandatory	Bas64 of the file. Example: iVBORw0KGgoAAAANSUhEUgAAAhEAAADrCAYAAADXCMREAAAAAXNSR0 IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAACRbSU RBVHhe7d2/jxVXmvBx/ogNHU0yzvgHJsUjOZrVJh5PNCQ7ckTCbmCRIDQSiRkLTdDewF qpJcZohBxZGI0IrFf82Alsy/tiIxosm25s3oaGRqM2q3791qtv3fu0nz6uqlv30Fxo+H6ko7p1 6pxTp4rgee6p29SBR

recipients

array of object

mandatory

This parameter is an array of object and should contain the details of recipients i.e. name and email.

Attribute	Description
name string(32) mandatory	Name of the recipient. Example: Sachin
email string(32) mandatory	Email of the recipient. Example: sachin@gmail.com

groupdetails

object

optional

This parameter is an object and should contain the value of group i.e. Id and GroupName.

Attribute	Description
Id string(32) mandatory	Unique Id of that particular group. Example: 125
GroupName string(32) mandatory	Name of the group. Example: Employees

signingorder

string(1)

mandatory

Signing order of the recipients can be set.

Possible Values: 0 or 1

subject

string(32)

mandatory

Subject name of the email template.

Example: KonsignCase

message

string(32)

optional

Message can be conveyed to the recipients via the Email template.

Example: Please sign teh document.

allowDelegation

boolean

optional

This parameter will allow recipients to delegate the document.

Possible Values: true or false

allowapplysignAll

boolean

optional

This parameter will allow recipients to apply sign all at once in the document.

Possible Values: true or false

allowkonsignlogoinsign

boolean

optional

This parameter will include konsign logo in the signature.

Possible Values: true or false

allowsignaftergroupdecline

boolean

optional

This parameter will allow other group recipients to complete the document even after some of them have declined the document.

Possible Values: true or false

expirationdate

string(10)

mandatory

This parameter will assign expiry date to the document.

Possible Values: 2020-12-03

reminderBeforeExpiration

string(2)

optional

This parameter will remind recipients to sign the document before specified days of the expiry date.

Example: 2

reminders

string(10)

optional

This parameter will allow to set reminders for the document.

Possible Values: daily, weeekly or custom

customreminder

object

optional

This parameter will required when reminders is set to custom. This parameter is an object and should contain the value of custom reminders i.e. beforefirstreminder and daysbetweenreminder.

Attribute	Description
beforefirstreminder string(32) mandatory	Number of days before sending first reminder of the expiring date of the document. Example: 20
daysbetweenreminder string(32) mandatory	Number of days between reminder. Example: 5

ipaddress

string(32)

optional

Ip address of the system.

Example: 172.16.254.1

browser

string(32)

optional

Browser name.

Example: Chrome

string(32)

optional

Operating System name.

Example: Microsoft Windows

country

string(32)

optional

Country name.

Example: India

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

status

boolean

This parameter indicates the status of API call.

Possible Values: true or false

data

object

This parameter gives the information about the result of the API response.

Attribute	Description
document_id string(32)	Unique Id of the document. Example: 8JIA11252061081EUW6MK20207933692

message

string(100)

This parameter is the result message which contains information about the result.

Example: mail send successfully.

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