契约锁 API

签署服务-签署个人签名

POST

/v2/contract/personalsign

调用此接口使用用户的个人签名进行签署，调用此接口前需要获得用户的个人签名授权（【授权管理】-【个人签名授权页面】）。

请求参数

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确定合同，且合同是以子公司身份创建的，则需要传递该值，用于确定合同主体、操作主体

user

object

个人用户

必需

contact

string

联系方式

必需

contactType

enum<string>

联系类型

必需

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

枚举值:

MOBILEEMAILEMPLOYEEIDNUMBERBIZID

stampers

array[object (StamperRequest) {9}]

指定签署位置

可选

type

enum<string>

签署类型

必需

COMPANY（公章），TIMESTAMP（时间戳），ACROSS_PAGE（骑缝章）

枚举值:

COMPANYTIMESTAMPACROSS_PAGE

documentId

string

合同文档ID

必需

sealId

string

印章ID

可选

keyword

string

关键字

可选

keywordIndex

integer

关键字索引

可选

1代表第1个关键字，0代表所有关键字，-1代表倒数第1个关键字；默认为1

page

string

坐标页码

可选

0代表所有,-1代表最后一页

offsetX

string

横坐标/关键字偏移量

可选

offsetY

string

纵坐标/关键字偏移量

可选

datePattern

enum<string>

时间戳格式

可选

HYPHEN（yyyy-mm-dd），Chinese（yyyy年mm月dd日（阿拉伯数字）），ALL_Chinese（yyyy年mm月dd日（中文））；仅type为TIMESTAMP时生效，默认为HYPHEN

枚举值:

HYPHENChineseALL_Chinese

locateAllStamperKeywords

boolean

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

可选

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

companySignatory

object (CompanyRequest)

企业签署方

可选

若签署的是企业签署方下的个人签字节点，则需要传递该值，用于确认企业签署方（注：仅能操作平台方公司及其子公司）；默认签署个人用户签署方

string

公司id

可选

不可与名称同时为空

name

string

公司名称

可选

不可与id同时为空

示例

{
  "user": {
    "contact": "dolore adipisicing sint",
    "contactType": "BIZID"
  },
  "stampers": [
    {
      "type": "TIMESTAMP",
      "documentId": "27",
      "sealId": "18",
      "offsetY": "quis exercitation consequat",
      "keyword": "amet labore est magna",
      "offsetX": "aute pariatur deserunt",
      "datePattern": "ALL_Chinese",
      "keywordIndex": 2,
      "page": "proident laboris et"
    },
    {
      "type": "COMPANY",
      "documentId": "89",
      "offsetY": "minim",
      "keyword": "commodo sint occaecat",
      "page": "ut ullamco amet eiusmod",
      "sealId": "51",
      "keywordIndex": 44,
      "offsetX": "non sit",
      "datePattern": "HYPHEN"
    },
    {
      "type": "TIMESTAMP",
      "documentId": "30",
      "datePattern": "HYPHEN",
      "offsetY": "nulla",
      "page": "eiusmod aliquip",
      "keywordIndex": 66,
      "keyword": "magna veniam",
      "sealId": "65",
      "offsetX": "reprehenderit officia Excepteur sunt"
    },
    {
      "type": "ACROSS_PAGE",
      "documentId": "58",
      "keywordIndex": 98,
      "offsetY": "laboris Excepteur qui officia",
      "offsetX": "Lorem do",
      "page": "veniam magna labore laborum amet",
      "datePattern": "ALL_Chinese",
      "sealId": "62",
      "keyword": "adipisicing"
    },
    {
      "type": "TIMESTAMP",
      "documentId": "87",
      "offsetX": "dolor non ex ea commodo",
      "keywordIndex": 61,
      "sealId": "91",
      "keyword": "reprehenderit fugiat dolore sint",
      "datePattern": "Chinese",
      "page": "ea Duis",
      "offsetY": "est officia nisi reprehenderit ea"
    }
  ],
  "contractId": "18",
  "locateAllStamperKeywords": true,
  "bizId": "39",
  "companySignatory": {
    "name": "电军我习",
    "id": "88"
  },
  "tenantName": "正局想见说"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/contract/personalsign' \
--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 '{
    "user": {
        "contact": "dolore adipisicing sint",
        "contactType": "BIZID"
    },
    "stampers": [
        {
            "type": "TIMESTAMP",
            "documentId": "27",
            "sealId": "18",
            "offsetY": "quis exercitation consequat",
            "keyword": "amet labore est magna",
            "offsetX": "aute pariatur deserunt",
            "datePattern": "ALL_Chinese",
            "keywordIndex": 2,
            "page": "proident laboris et"
        },
        {
            "type": "COMPANY",
            "documentId": "89",
            "offsetY": "minim",
            "keyword": "commodo sint occaecat",
            "page": "ut ullamco amet eiusmod",
            "sealId": "51",
            "keywordIndex": 44,
            "offsetX": "non sit",
            "datePattern": "HYPHEN"
        },
        {
            "type": "TIMESTAMP",
            "documentId": "30",
            "datePattern": "HYPHEN",
            "offsetY": "nulla",
            "page": "eiusmod aliquip",
            "keywordIndex": 66,
            "keyword": "magna veniam",
            "sealId": "65",
            "offsetX": "reprehenderit officia Excepteur sunt"
        },
        {
            "type": "ACROSS_PAGE",
            "documentId": "58",
            "keywordIndex": 98,
            "offsetY": "laboris Excepteur qui officia",
            "offsetX": "Lorem do",
            "page": "veniam magna labore laborum amet",
            "datePattern": "ALL_Chinese",
            "sealId": "62",
            "keyword": "adipisicing"
        },
        {
            "type": "TIMESTAMP",
            "documentId": "87",
            "offsetX": "dolor non ex ea commodo",
            "keywordIndex": 61,
            "sealId": "91",
            "keyword": "reprehenderit fugiat dolore sint",
            "datePattern": "Chinese",
            "page": "ea Duis",
            "offsetY": "est officia nisi reprehenderit ea"
        }
    ],
    "contractId": "18",
    "locateAllStamperKeywords": true,
    "bizId": "39",
    "companySignatory": {
        "name": "电军我习",
        "id": "88"
    },
    "tenantName": "正局想见说"
}'

返回响应

🟢200成功

application/json

Body

code

integer

响应码

必需

message

string

响应消息

必需

示例

{
  "code": 0,
  "message": "SUCCESS"
}

签署服务-签署作废合同

组织架构-子公司列表