合同管理-添加签署方

请求参数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数application/json

contractId

string

合同ID

可选

合同ID与业务ID二选一，不能同时为空

bizId

string

业务ID

可选

合同ID与业务ID二选一，不能同时为空

tenantName

string

子公司名称

可选

若使用业务ID发起合同，且合同是以子公司身份创建的，则需要传递该值，用于确定合同主体

signatory

object (SignatoryRequest)

签署方信息

可选

id

string

签署方ID

可选

tenantType

enum<string>

签署方类型

必需

COMPANY（公司）， PERSONAL（个人）

枚举值:

COMPANYPERSONAL

status

enum<string>

签署方状态

可选

DRAFT（草稿） RECALLED（已撤回），SIGNING（签署中），REJECTED（已退回），SIGNED（已完成），EXPIRED（已过期），FILLING（拟定中），WAITING（待签署），INVALIDING（作废中），INVALIDED（已作废）

枚举值:

DRAFTRECALLEDSIGNINGREJECTEDSIGNEDEXPIREDFILLINGWAITINGINVALIDINGINVALIDED

tenantName

string

签署方名称

可选

delaySet为false时必填

receiver

object (UserRequest)

接收人

可选

delaySet为false时必填

serialNo

integer

签署顺序

可选

actions

array[object (ActionRequest) {9}]

签署动作

可选

attachments

array[object (AttchmentRequest) {4}]

附件要求

可选

用于指定用户签署时上传的附件

userAuthInfo

object (UserAuthInfoRequest)

指定签署方认证信息

可选

category

object (CategoryRequest)

业务类型

可选

仅公司类型接收方（内部企业）生效，可指定该签署方对应的业务分类

delaySet

boolean

是否延迟设置签署方信息

可选

默认为false

locateAllStamperKeywords

boolean

是否必须找出全部签署位置传入的关键字

可选

默认为true；传入false时，对于传入的关键字定位的签署位置，只需定位到任意一个签署位置的关键字即可

示例

{
    "contractId":"{{contractIdAdd}}",
    "signatory":{
        "tenantType":"PERSONAL",
        "tenantName":"{{personalTenantName}}",
        "receiver":{
            "contact":"{{personalContact}}",
            "contactType":"MOBILE"
        }
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/signatory/add' \
--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 '{
    "contractId":"{{contractIdAdd}}",
    "signatory":{
        "tenantType":"PERSONAL",
        "tenantName":"{{personalTenantName}}",
        "receiver":{
            "contact":"{{personalContact}}",
            "contactType":"MOBILE"
        }
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

示例

{
    "result": {
        "id": "3053227780717150393",
        "tenantType": "PERSONAL",
        "status": "WAITING",
        "tenantName": "程桂英",
        "receiver": {
            "contact": "18161426316",
            "contactType": "MOBILE"
        },
        "serialNo": 2,
        "delaySet": false,
        "sponsor": false
    },
    "code": 0,
    "message": "SUCCESS"
}