契约锁 API

签署服务-签署作废合同

POST

/v2/contract/invalidsign

调用此接口签署作废合同。

请求参数

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

sealId

string

印章ID

可选

发起方签署作废文件时指定的印章，作废合同时使用。若发起方已签署，不传默认取发起方印章ID

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时，对于传入的关键字定位的签署位置，只需定位到任意一个签署位置的关键字即可

示例

{
  "tenantName": "资支作规山",
  "sealId": "93",
  "bizId": "13",
  "stampers": [
    {
      "type": "ACROSS_PAGE",
      "documentId": "29",
      "keywordIndex": 67,
      "keyword": "sed consequat deserunt",
      "datePattern": "HYPHEN",
      "offsetY": "magna sint velit esse elit",
      "page": "anim irure amet",
      "sealId": "21",
      "offsetX": "ut ullamco exercitation et"
    },
    {
      "type": "COMPANY",
      "documentId": "5",
      "datePattern": "Chinese",
      "keyword": "ut",
      "offsetY": "Excepteur anim velit",
      "keywordIndex": 90,
      "page": "occaecat quis pariatur",
      "sealId": "80",
      "offsetX": "labore mollit Lorem est in"
    },
    {
      "type": "COMPANY",
      "documentId": "21",
      "offsetY": "Duis eiusmod sed",
      "datePattern": "ALL_Chinese",
      "sealId": "16",
      "offsetX": "veniam ut officia",
      "keywordIndex": 21,
      "keyword": "magna",
      "page": "laboris"
    },
    {
      "type": "ACROSS_PAGE",
      "documentId": "12",
      "offsetY": "Duis ex adipisicing",
      "sealId": "54",
      "keywordIndex": 73,
      "page": "sed dolor culpa",
      "datePattern": "ALL_Chinese",
      "offsetX": "officia ea ut voluptate",
      "keyword": "officia ipsum eiusmod"
    },
    {
      "type": "TIMESTAMP",
      "documentId": "34",
      "sealId": "53",
      "page": "consectetur",
      "datePattern": "ALL_Chinese",
      "keywordIndex": 17,
      "keyword": "ad in",
      "offsetY": "qui id consequat nisi",
      "offsetX": "cillum dolore"
    }
  ],
  "contractId": "71",
  "locateAllStamperKeywords": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/contract/invalidsign' \
--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 '{
    "tenantName": "资支作规山",
    "sealId": "93",
    "bizId": "13",
    "stampers": [
        {
            "type": "ACROSS_PAGE",
            "documentId": "29",
            "keywordIndex": 67,
            "keyword": "sed consequat deserunt",
            "datePattern": "HYPHEN",
            "offsetY": "magna sint velit esse elit",
            "page": "anim irure amet",
            "sealId": "21",
            "offsetX": "ut ullamco exercitation et"
        },
        {
            "type": "COMPANY",
            "documentId": "5",
            "datePattern": "Chinese",
            "keyword": "ut",
            "offsetY": "Excepteur anim velit",
            "keywordIndex": 90,
            "page": "occaecat quis pariatur",
            "sealId": "80",
            "offsetX": "labore mollit Lorem est in"
        },
        {
            "type": "COMPANY",
            "documentId": "21",
            "offsetY": "Duis eiusmod sed",
            "datePattern": "ALL_Chinese",
            "sealId": "16",
            "offsetX": "veniam ut officia",
            "keywordIndex": 21,
            "keyword": "magna",
            "page": "laboris"
        },
        {
            "type": "ACROSS_PAGE",
            "documentId": "12",
            "offsetY": "Duis ex adipisicing",
            "sealId": "54",
            "keywordIndex": 73,
            "page": "sed dolor culpa",
            "datePattern": "ALL_Chinese",
            "offsetX": "officia ea ut voluptate",
            "keyword": "officia ipsum eiusmod"
        },
        {
            "type": "TIMESTAMP",
            "documentId": "34",
            "sealId": "53",
            "page": "consectetur",
            "datePattern": "ALL_Chinese",
            "keywordIndex": 17,
            "keyword": "ad in",
            "offsetY": "qui id consequat nisi",
            "offsetX": "cillum dolore"
        }
    ],
    "contractId": "71",
    "locateAllStamperKeywords": true
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

示例

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

签署服务-自定义模板文件作废合同

签署服务-签署个人签名