Bulk Contract Start

• Start Bulk Contract

• For bulk sending, the order of signatures depends on the steps you set in the template. (It depends on the template step type) The sender will be set as starter of document and the signer's information will be determined by the value in unset_player_list. Document will be sent for all signers in the unset_player_list.

API URL

Url	Type	Code
https://docs.esignon.net/JEDOC/Common.do	POST	1410Q

Request

Parameters

Headers

Parameter Name	DataType	Description
Content-Type	String	application/json
Authorization	String	esignon {token}

Body

Body - Header Parameter

Parameter Name	DataType	Description
request_code	String	"1410Q"
request_msg	String	"Start Work Flow Bulk Sending"
session_id	String	"thread_023"
version	String	"9.9.99"

Body - Body Parameter

Parameter Name	DataType	Description
comp_id	String	Company ID
biz_id	String	"0"
memb_email	String	Document starter's email
workflow_name	String	""
workflow_lib_id	String	lid_id created when creating the template (You can check the select Templete list.)
unset_player_list	Data	Enter the signers information
unset_player_list.memb_id_type	String	"EMail"
unset_player_list.email	String	Email address
unset_player_list.name	String	Signer name
unset_player_list.language	String	"ko-KR","en-US","ja-JP"
unset_player_list.workflow_name	String	Document name to start
unset_player_list.enable_mobile_cert	String	"false" ( is only available in Korea.)
unset_player_list.mobile_number	String	"" ( is only available in Korea.)
unset_player_list.enable_password_cert	String	Password authentication feature "True or false"
unset_player_list.password_hint	String	Password hint
unset_player_list.password	String	Password
field_list	Data	Field value added in case there is a value to be entered in advance
field_list.doc_id	String	Templete ID
field_list.field_name	String	Templete field name
field_list.field_value	String	The value you want to enter in the field
comment	String	""
enable_legal_agreement	String	"false"

Request Body Example

{
  "header": {
    "request_code": "1410Q",
    "api_name": "Start Work Flow Bulk Sending",
    "session_id": "",
    "version" : "9.9.99"
  },
  "body": {
    "comp_id": "{Company ID}",
    "biz_id": "0",
    "memb_email": "{ Email of document starter}",
    "workflow_lib_id": "{ templete lib_id }",
    "workflow_name": "",
    "unset_player_list": [{
        "memb_id_type" : "{ EMail }",
        "email": "{ email adress }",
        "name" : "{ Signer name }",
        "language": "ko-KR",//ko-KR, ja-JP, en-US
        "workflow_name" : "{ document name }",
        "enable_mobile_cert" : "flase",//( is only available in Korea.)
        "mobile_number" : "",//( is only available in Korea.)
        "enable_password_cert":"{true or false}",
	      "password_hint":"{Password to use when proceeding with the contract hint}",  		
	      "password":"{Password to use when proceeding with the contract}",
        "field_list": [{ // Field used to transfer by entering a value in the field at contract startup
      				"doc_id": "{ Templete ID }",
      				"field_name": "{ Templete field name }",
      				"field_value": "{ The value you want to enter in the appropriate field }"
			  }]
      }],// Send contracts to all customers you set up
    "comment": "",
    "enable_legal_agreement":"false"
  }
}

Response

Code	Description	Reference
200	success	success
400	Connection failed

Result_msg

Code	Description	Reference
00	success	success
-1	fail	Parsing failed because the body information of the received message is incorrect.
10	fail	The specific Work Flow Library does not exist.
11	fail	Failed.
12	fail	The maximum storage capacity has been exceeded.
13	fail	The maximum number of documents is exceeded.
14	fail	The usage period has expired.
15	fail	The writer setting is incorrect.

Response Body Example

}
	"body":{
		"workflow_list":[
			{
			"workflow_id": "{Document ID}",
			"unset_player_email": "{Signer email}",
			"unset_player_name": "{Signer name}",
			"result": "OK",
			"description": "",
			"workflow_name": "{Documnet name}",
			"token": "{accesstoken}",
			"lang": "ko-KR",
			"reg_date": "{Company Payment Renewal Date}"},
			"comp_id": "{Company ID}",
			"biz_id": "0",
			"memb_email": "{Email of document starter}",
			"workflow_lib_id": "{Templete lib_id}"
			},
	"header":{
		"session_id": "thread_023",
		"response_code": "1410A",
		"result_code": "00",
		"result_msg": "Start Work Flow bulk Sending.",
		"version": "9.9.99"
	}
}