契约锁 API

合同管理-修改签署方

POST

/v2/signatory/edit

创建合同时未设置签署方信息的合同，可调用该接口补全签署方的信息。
对于已存在签署方信息的合同，可调用该接口修改签署方信息；
对于公司类型：已接收则不可修改，未接收则可修改；
对于个人类型：无论个人是否认证、是否接收，都可修改签署方信息。

请求参数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数application/json

signatoryId

string

签署方ID

必需

tenantName

string

签署方名称

必需

receiver

object (UserRequest)

用户信息

必需

contact

string

联系方式

必需

contactType

enum<string>

联系类型

必需

MOBILE（手机号），EMAIL（邮箱），EMPLOYEEID（员工ID），NUMBER（员工编号），BIZID（用户在对接方系统的唯一标识）

枚举值:

MOBILEEMAILEMPLOYEEIDNUMBERBIZID

name

string

姓名

可选

示例

{
  "signatoryId": 2688358519446442500,
  "tenantType": "PERSONAL",
  "companyName": "广州思晨",
  "userName": "谢兰花",
  "contact": "19000009091"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/signatory/edit' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}' \
--header 'Content-Type: application/json' \
--data-raw '{
	"signatoryId":2688358519446442382,
	"tenantType":"PERSONAL",
	"companyName":"广州思晨",
	"userName":"谢兰花",
	"contact":"19000009091"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

result

object

必需

string

签署方ID

可选

tenantType

enum<string>

签署方类型

可选

COMPANY（公司）， PERSONAL（个人）

枚举值:

COMPANYPERSONAL

serialNo

integer

签署顺序

可选

actions

array[object (ActionResponse) {4}]

签署动作（签署流程）

可选

status

enum<string>

签署方状态

可选

枚举值:

DRAFTRECALLEDSIGNINGREJECTEDSIGNEDEXPIREDFILLINGWAITINGINVALIDINGINVALIDEDFORCE_END

receiver

object (UserAuthInfoResponse)

接收人

可选

示例

{
  "result": {
    "id": "3053227768331370625",
    "tenantType": "PERSONAL",
    "status": "WAITING",
    "tenantName": "思晨教育",
    "receiver": {
      "name": "ABC",
      "contact": "15111111111",
      "contactType": "MOBILE"
    },
    "serialNo": 1,
    "delaySet": false,
    "sponsor": false
  },
  "code": 0,
  "message": "SUCCESS"
}

合同管理-抄送合同

合同管理-添加签署方