# 存签电子合同API接口文档 V5.1.9

# 获取鉴权Token

# 简要描述

通过app_key和app_secret请求api 授权码,用来请求业务api。token有效时长为120分钟。

# 访问地址

/oauth2/tokens

# 请求方式

POST

# 请求参数

参数名 参数类型 必选 类型 说明
grant_type query string 固定值,client_credentials
client_id query string app_key
client_secret query string app_secret

# 请求示例

post https://api.csign.cn/oauth2/tokens?grant_type=client_credentials&client_id=retwrtw34dfgbsdf&client_secret=2sdfgsdfgsdfg3245fsgdfgsdfg3
1

# 响应示例

{
    "code": 0,
    "datas": {
        "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50X2lkIjoiIiwiYXV0aG9yaXplZF9hY2NvdW50X2lkIjoiIiwiY2xpZW50X2lkIjoic1hpdGxvdFlEaGQ2Z0pLcCIsInRva2VuIjoiODdjZmQ3NTgtMGNjZi00NTcwLTgxNTItNTVjZTUxMTdmZGI2IiwidXNlcl9pZCI6IiJ9.fckdxFqhotsARXMq6csWVFmKLPrE98PtWgQnuZZTx2w",
        "expires_in": 7200,
        "token_type": "Bearer",
        "scope": "read"
    },
    "message": "认证成功"
}
1
2
3
4
5
6
7
8
9
10

# 个人账号创建

# 接口描述

对接方调用本接口在平台中创建个人账号,后续有关该用户的所有操作都需使用该用户的accountId

# 接口

/accountService/v1/users/createByThirdPartyId

# 请求方式

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数

参数名称 说明 参数类型 是否必填 类型
thirdPartyId 用户唯一标识,可传入第三方平台的个人用户id、证件号、手机号、邮箱等。(个人用户与机构的唯一标识不可重复) body true string
name 姓名 body true string
idType 证件类型,默认CRED_PSN_CH_IDCARD body true string
idNumber 证件号,默认为空,发起签署前需确保补齐证件号 body true string
mobile 手机号码,默认空,手机号为空时无法使用短信意愿认证 body true string
email 邮箱地址,默认空 body false string

# 证件类型

说明
CRED_PSN_CH_IDCARD 大陆身份证,默认值
CRED_PSN_CH_TWCARD 台湾来往大陆通行证
CRED_PSN_CH_MACAO 澳门来往大陆通行证
CRED_PSN_CH_HONGKONG 香港来往大陆通行证
CRED_PSN_FOREIGN 外籍证件
CRED_PSN_PASSPORT 护照
CRED_PSN_CH_SOLDIER_IDCARD 军官证
CRED_PSN_CH_SSCARD 社会保障卡
CRED_PSN_CH_ARMED_POLICE_IDCARD 武装警察身份证件
CRED_PSN_CH_RESIDENCE_BOOKLET 户口簿
CRED_PSN_CH_TEMPORARY_IDCARD 临时居民身份证
CRED_PSN_CH_GREEN_CARD 外国人永久居留证
CRED_PSN_SHAREHOLDER_CODE 股东代码证
CRED_PSN_POLICE_ID_CARD 警官证
CRED_PSN_UNKNOWN 未知类型

# 请求示例

POST https://api.csign.cn/accountService/v1/users/createByThirdPartId
{
    "email":"xx@qq.com",
    "idNumber":"311111111111111111",
    "idType":"CRED_PSN_CH_IDCARD",
    "mobile":"13777777777",
    "name":"测试用户",
    "thirdPartyUserId":"13777777777"
}
1
2
3
4
5
6
7
8
9

# 响应示例

{
    "code":0,
    "message":"成功",
    "datas":{
        "accountId":"0347602ABDCC44EEA4AF4DC243707BDB"
    }
}
1
2
3
4
5
6
7

# 返回码说明

错误码 错误信息 错误原因
402001 账号已存在 该thirdPartyId已创建用户
402002 身份证证件类型不支持 身份证证件类型不支持

# 机构账号创建

# 接口描述

  1. 对接方调用本接口在平台中创建机构账号,后续有关该机构的所有操作都需使用该机构的accountId。如提供机构证件信息,则将根据提供的机构证件信息申请数字证书。
  2. 创建机构账号前需要先创建一个个人账号并通过本接口传给服务器

# 接口

/accountService/v1/organizations/createByThirdPartyId

# 请求方式

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数

参数名称 说明 参数类型 是否必填 类型
thirdPartyId 机构唯一标识,可传入第三方平台机构id、企业证件号、企业邮箱等如果设置则作为账号唯一性字段,相同id不可重复创建。(个人用户与机构的唯一标识不可重复) body true string
creator 创建人个人账号id(调用个人账号创建接口返回的accountId) body true string
name 机构名称 body true string
idType 证件类型,默认CRED_ORG_USCC body true string
idNumber 证件号,默认为空,发起签署前需确保补齐证件号 body true string
orgLegalIdNumber 企业法人证件号 body false string
orgLegalName 企业法人名称 body false string

# 支持机构证件类型

说明
CRED_ORG_USCC 统一社会信用代码,默认值
CRED_ORG_CODE 组织机构代码证
CRED_ORG_REGCODE 工商注册号
CRED_ORG_BUSINESS_REGISTTATION_CODE 工商登记证
CRED_ORG_TAX_REGISTTATION_CODE 税务登记证
CRED_ORG_LEGAL_PERSON_CODE 法人代码证
CRED_ORG_ENT_LEGAL_PERSON_CODE 事业单位法人证书
CRED_ORG_SOCIAL_REG_CODE 社会团体登记证书
CRED_ORG_PRIVATE_NON_ENT_REG_CODE 民办非机构登记证书
CRED_ORG_FOREIGN_ENT_REG_CODE 外国机构常驻代表机构登记证
CRED_ORG_GOV_APPROVAL 政府批文
CODE_ORG_CUSTOM 自定义
CRED_ORG_UNKNOWN 未知证件类型

# 请求示例

POST https://api.csign.cn/accountService/v1/organizations/createByThirdPartyId
{
    "creator":"7b04a1e86d014a26858f69162d0e39d4",
    "idNumber":"12330100470104939U",
    "idType":"CRED_ORG_USCC",
    "name":"测试企业",
    "thirdPartyUserId":"B001",
    "orgLegalIdNumber":"",
    "orgLegalName":""
}
1
2
3
4
5
6
7
8
9
10

# 响应参数

参数名称 说明 参数类型 是否必填 类型
accountId 机构账号id body true string

# 响应示例

{
    "code":0,
    "message":"成功",
    "datas":{
        "accountId":"d406f301ee5349399dfc83f36a243fcd"
    }
}
1
2
3
4
5
6
7

# 返回码说明

错误码 错误信息 错误原因
402001 账号已存在 该thirdPartyId已创建账号
402002 证件类型不支持 证件类型(idType)不支持

# 文件上传

# 简要描述:

上传文件

# 接口地址:

/fileService/v1/files

# 请求方式:

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String multipart/form-data

# 请求参数

参数名称 说明 参数类型 是否必填 类型
convertToPdf 是否转换为pdf文件 body false string
file 上传文件 body true string

# 请求示例

post https://api.csign.cn/fileService/v1/files
1

# 响应参数

参数名 类型 说明
fileId string 文件id
downloadUrl string 文件上传地址(五分钟过期)

# 响应示例

{
    "code": 0,
    "datas": {
        "fileId": "D36CA1C3FB4E4427AD21D38970F5027B",
        "downloadUrl": "https://docu.csign.cn/uploads%2F20200710%2F021442_721DF1556CDF48E0A6BB0658B36F855F.pdf?Expires=1594348182&OSSAccessKeyId=LTAI4Fut1oWaGZso7z8tL9kJ&Signature=d%2BbwFWUOpMW4H9et9NX59BJ0cuU%3D"
    },
    "message": "上传成功"
}
1
2
3
4
5
6
7
8

# 文件详情

# 简要描述:

查询文件详情,包括文件名称、大小、下载地址等

# 接口地址:

/fileService/v1/files/{id}

# 请求方式:

GET

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求示例

get https://api.csign.cn/fileService/v1/files/BC020918F2674689BB6D89A2E000ED02
1

# 响应参数

参数名 类型 说明
id string 文件id
downloadUrl string 文件下载地址(五分钟过期)
fileName string 文件名称
isPdf bool 是否为pdf文件
status int 状态码
statusName string 状态码名称
size int 文件大小(byte)

# 响应示例

{ "code": 0, "datas": { "downloadUrl": "https://docu.csign.cn/uploads%2F20200710%2F021442_721DF1556CDF48E0A6BB0658B36F855F.pdf?Expires=1594348182&OSSAccessKeyId=LTAI4Fut1oWaGZso7z8tL9kJ&Signature=d%2BbwFWUOpMW4H9et9NX59BJ0cuU%3D", "fileName": "新建 Microsoft Word 文档.pdf", "id": "BC020918F2674689BB6D89A2E000ED02", "isPdf": true, "status": 2, "statusName": "文件已上传" }, "message": "" }

错误码 错误信息 错误原因
404001 文件不存在
400011 id不正确

# 添加模板

# 简要描述:

通过pdf文件创建模板

# 接口地址:

/templateService/v1/templates

# 请求方式:

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数:

参数名 参数类型 必选 类型 说明
name body string 模板名称(该名称唯一)
fileId body bool 模板文件id。

# 请求示例

post https://api.csign.cn/templateService/v1/templates
1

# 响应参数

参数名 类型 说明
templateId string 模板id

# 响应示例

{
    "code": 0,
    "datas": {
        "templateId": "6C4DB2928E60459DBE0E5C7281BA0B12"
    },
    "message": ""
}
1
2
3
4
5
6
7
错误码 错误信息 错误原因
400101 参数错误 参数格式错误或者缺少参数
405001 该文件不是pdf文件 仅支持pdf创建模板,非pdf文件需要经过文件服务上传转化未pdf文件
405002 模板名称已存在 模板文件名称不能重复
405003 模板创建错误 模板创建错误

# 删除模板

# 简要描述:

删除模板

# 接口地址:

/templateService/v1/templates/{id}

# 请求方式:

DELETE

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数:

参数名 参数类型 必选 类型 说明
id param string 模板id

# 请求示例

delete https://api.csign.cn/templateService/v1/templates/{id}
1

# 响应参数

参数名 类型 说明
templateId string 模板id

# 响应示例

{
    "code": 0,
    "message": "Success"
}
1
2
3
4
错误码 错误信息 错误原因
400011 id格式错误 id格式错误
404001 该文件不是pdf文件 仅支持pdf创建模板,非pdf文件需要经过文件服务上传转化未pdf文件
400100 删除失败 删除失败

# 模板添加输入框组件

# 简要描述:

模板添加输入框组件

# 接口地址:

/templateService/v1/templates/{id}/field

# 请求方式:

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数:

参数名 参数类型 必选 类型 说明
id path string 模板id
key body string 模板下输入项组件唯一标识,使用模板时也可用根据key值填充
label body string 输入项组件显示名称
required body bool 是否必填,默认true
width body float 输入项组件宽度
height body float 输入项组件高度
posx body float x轴坐标,左下角为原点
posy body float y轴坐标,左下角为原点
posPage body float 页码

# 请求示例

post https://api.csign.cn/templateService/v1/templates/{id}/field
1

# 响应参数

参数名 类型 说明
fieldIds array 组件id

# 响应示例

{
    "code": 0,
    "datas": {
        "fieldIds": [
            "EA8749CB4623426393A20068993E5F1F",
            "4A379446937B4E848B769621DB055865"
        ]
    },
    "message": "Success"
}
1
2
3
4
5
6
7
8
9
10
错误码 错误信息 错误原因
400011 id格式错误 id格式错误
404001 模板不存在 模板不存在
400106 pdf添加输入框失败 pdf添加输入框失败
400107 pdf添加输入框失败 pdf添加输入框失败

# 模板删除输入框组件

# 简要描述:

模板删除输入框组件

# 接口地址:

/templateService/v1/templates/{id}/field/{fieldIds}

# 请求方式:

DELETE

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数:

参数名 参数类型 必选 类型 说明
id path string 模板id
fieldIds path string 删除的输入框组件id,多个组件间用id间隔

# 请求示例

delete https://api.csign.cn/templateService/v1/templates/{id}/field
1

# 响应参数

参数名 类型 说明
fieldIds array 组件id

# 响应示例

{
    "code": 0,
    "datas": null,
    "message": "删除成功"
}
1
2
3
4
5
错误码 错误信息 错误原因
400011 id格式错误 id格式错误
404001 模板不存在 模板不存在
400106 pdf删除输入框失败 pdf删除输入框失败

# 模板创建合同文件

# 简要描述:

通过模板创建合同文件

# 接口地址:

/templateService/v1/templates/{id}/createFile

# 请求方式:

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数:

参数名 参数类型 必选 类型 说明
fileName body string 文件名称
fieldParams body object 填入模板参数

# 请求示例

post https://api.csign.cn/templateService/v1/templates/{id}/createFile
{
	"fileName":"合同文件",
	"fieldParams": {
		"name甲":"wangwagn",
		"name乙":"苟永勇"
	}
}
1
2
3
4
5
6
7
8

# 响应参数

参数名 类型 说明
fileId string 生成文件id
downloadUrl string 文件下载地址

# 响应示例

{
    "code": 0,
    "datas": {
        "downloadUrl": "https://docu.csign.cn/20200328%2FCCBFE859E28242C6849BA84F4B362E06.pdf?Expires=1585376195&OSSAccessKeyId=LTAI4Fut1oWaGZso7z8tL9kJ&Signature=7aCMW7y86zXcrispmW6l0WYSJ2o%3D",
        "fileId": "CCBFE859E28242C6849BA84F4B362E06"
    },
    "message": "Success"
}
1
2
3
4
5
6
7
8
错误码 错误信息 错误原因
400011 id格式错误 id格式错误
404001 模板不存在 模板不存在
405004 必填字段未填写 必填字段未填写
405005 文件创建失败 文件创建失败

# 模板详情

# 简要描述:

模板详情

# 接口地址:

/templateService/v1/templates/{id}

# 请求方式:

GET

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数:

参数名 参数类型 必选 类型 说明
id path string 模板id

# 请求示例

get https://api.csign.cn/templateService/v1/templates/{id}
1

# 响应参数

参数名 类型 说明
id string 模板id
templateName string 模板名称
downloadUrl string 模板下载地址
createTime string 模板创建时间
fields object 模板输入框信息
>id string 输入项组件id,使用时可用id填充,为空时表示添加,不为空时表示修改
>key string 模板下输入项组件唯一标识,使用模板时也可用根据key值填充
>label string 输入项组件显示名称
>required string 是否必填,默认true
>width float 输入项组件宽度
>height float 输入项组件高度
>page int 页码
>posx float x轴坐标,左下角为原点
>posy float y轴坐标,左下角为原点

# 响应示例

{
    "code": 0,
    "datas": {
        "createTime": "2020-03-26 02:15:19",
        "downloadUrl": "https://docu.csign.cn/20200326%2F4BAC654032804AB19FF4DB964A6D6C6E.pdf?Expires=1585377731&OSSAccessKeyId=LTAI4Fut1oWaGZso7z8tL9kJ&Signature=tkh%2Fqa%2FnZjlinZTWWCeSRTznfx4%3D",
        "fields": [
            {
                "id": "EA8749CB4623426393A20068993E5F1F",
                "key": "name11",
                "label": "姓名",
                "required": true,
                "width": 100,
                "height": 11,
                "page": 1,
                "posx": 130,
                "posy": 135
            }
        ],
        "id": "F00D292078914BD5AB46B9D68D691116",
        "templateName": "true123"
    },
    "message": "Success"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
错误码 错误信息 错误原因
400011 id格式错误 id格式错误
404001 模板不存在 模板不存在

# 发起合同

# 简要描述:

发起合同

# 接口地址:

/contractService/v1/contracts

# 请求方式:

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数:

参数名 参数类型 必选 类型 说明
autoArchive body bool 是否自动封签,默认是
businessScene body bool 合同名称。
signValidity body string 签署有效截止日期,如:2019-01-01 01:01:01
callbackUri body string 合同签署完成后的回调地址
initiatorAccountId body string 发起人账户id,即发起本次签署的操作人个人账号id;如不传,默认由对接平台发起
initiatorAuthorizedAccountId body string 发起方主体id,如存在个人代机构发起签约,则需传入机构id;如不传,则默认是对接平台

# 请求示例

post https://api.csign.cn/contractService/v1/contracts
1

# 响应参数

参数名 类型 说明
contractId string 合同id

# 响应示例

{
    "code": 0,
    "datas": {
        "contractId": "72101E2A514045D0A1DB7BAE12CD72C5"
    },
    "message": "Success"
}
1
2
3
4
5
6
7
错误码 错误信息 错误原因
400101 参数错误 参数格式错误或者缺少参数
403001 账号不存在 账号不存在
403002 账号非个人账号 账号非个人账号

# 合同添加附件

# 简要描述:

合同添加附件

# 接口地址:

/contractService/v1/contracts/{id}/attachments

# 请求方式:

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数:

参数名 参数类型 必选 类型 说明
files body object 是否自动封签,默认是
>fileId body string 文件id
>fileName body string 文件名称

# 请求示例

post https://api.csign.cn/contractService/v1/contracts/{id}/attachments
{
    "files":[
	    	{
	    		"fileId":"CCBFE859E28242C6849BA84F4B362E06",
	    		"fileName":"fileName"
	    	}
    	]
}
1
2
3
4
5
6
7
8
9

# 响应参数

参数名 类型 说明

# 响应示例

{
    "code": 0,
    "message": "Success"
}
1
2
3
4
错误码 错误信息 错误原因
400101 参数错误 参数格式错误或者缺少参数
403003 fileId重复 fileId重复
403004 文件已添加过 fileId文件已添加过
403005 fileId不存在 fileId错误

# 合同删除附件

# 简要描述:

合同删除附件

# 接口地址:

/contractService/v1/contracts/{id}/attachments

# 请求方式:

DELETE

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数

参数名 参数类型 必选 类型 说明
fileIds query string 删除附件id,多个id之间用,分隔

# 请求示例

delete https://api.csign.cn/contractService/v1/contracts/{id}/attachments?fieldIds=CCBFE859E28242C6849BA84F4B362E06

1
2

# 响应示例

{
    "code": 0,
    "datas": null,
    "message": "Success"
}
1
2
3
4
5
错误码 错误信息 错误原因
400101 参数错误 参数格式错误或者缺少参数
403007 fileIds不能为空 fileIds参数为空或不存在
403006 合同不在草稿状态 只有草稿状态的文件才能删除

# 合同附件列表

# 简要描述:

合同附件列表

# 接口地址:

/contractService/v1/contracts/{id}/attachments

# 请求方式:

GET

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求示例

get https://api.csign.cn/contractService/v1/contracts/{id}/attachments

1
2

# 响应参数

参数名 类型 说明
fileId string 附件id
fileName string 附件名称
downloadUrl string 下载地址
createdAt string 创建时间

# 响应示例

{
    "code": 0,
    "datas": [
        {
            "fileId": "CCBFE859E28242C6849BA84F4B362E06",
            "fileName": "合同文件",
            "downloadUrl": "https://docu.csign.cn/20200328%2FCCBFE859E28242C6849BA84F4B362E06.pdf?Expires=1585807441&OSSAccessKeyId=LTAI4Fut1oWaGZso7z8tL9kJ&Signature=Y1xPk9VrqUgMrg72%2BMbVerDaNd4%3D",
            "createdAt": "2020-04-02 01:54:24"
        }
    ],
    "message": "Success"
}
1
2
3
4
5
6
7
8
9
10
11
12
错误码 错误信息 错误原因
404001 合同不存在 合同id错误

# 合同添加签署文件

# 简要描述:

合同添加签署文件

# 接口地址:

/contractService/v1/contracts/{id}/signFiles

# 请求方式:

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数:

参数名 参数类型 必选 类型 说明
files body object 是否自动封签,默认是
>fileId body string 文件id
>fileName body string 文件名称

# 请求示例

post https://api.csign.cn/contractService/v1/contracts/{id}/signFiles
{
    "files":[
	    	{
	    		"fileId":"CCBFE859E28242C6849BA84F4B362E06",
	    		"fileName":"fileName"
	    	}
    	]
}
1
2
3
4
5
6
7
8
9

# 响应参数

参数名 类型 说明

# 响应示例

{
    "code": 0,
    "message": "Success"
}
1
2
3
4
错误码 错误信息 错误原因
400101 参数错误 参数格式错误或者缺少参数
403003 fileId重复 fileId重复
403004 文件已添加过 fileId文件已添加过
403005 fileId不存在 fileId错误
403008 文件不是pdf文件 签署文件仅能是pdf文件,可以通过文件服务接口将非pdf文件转换为pdf文件

# 合同删除签署文件

# 简要描述:

合同删除签署文件

# 接口地址:

/contractService/v1/contracts/{id}/signFiles

# 请求方式:

DELETE

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数

参数名 参数类型 必选 类型 说明
fileIds query string 删除文件id,多个id之间用,分隔

# 请求示例

delete https://api.csign.cn/contractService/v1/contracts/{id}/signFiles?fieldIds=CCBFE859E28242C6849BA84F4B362E06

1
2

# 响应示例

{
    "code": 0,
    "datas": null,
    "message": "Success"
}
1
2
3
4
5
错误码 错误信息 错误原因
400101 参数错误 参数格式错误或者缺少参数
403007 fileIds不能为空 fileIds参数为空或不存在
403006 合同不在草稿状态 只有草稿状态的文件才能删除

# 合同签署文件列表

# 简要描述:

合同签署文件列表

# 接口地址:

/contractService/v1/contracts/{id}/signFiles

# 请求方式:

GET

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求示例

get https://api.csign.cn/contractService/v1/contracts/{id}/signFiles

1
2

# 响应参数

参数名 类型 说明
fileId string 附件id
fileName string 附件名称
downloadUrl string 下载地址
createdAt string 创建时间

# 响应示例

{
    "code": 0,
    "datas": [
        {
            "fileId": "CCBFE859E28242C6849BA84F4B362E06",
            "fileName": "合同文件",
            "downloadUrl": "https://docu.csign.cn/20200328%2FCCBFE859E28242C6849BA84F4B362E06.pdf?Expires=1585807441&OSSAccessKeyId=LTAI4Fut1oWaGZso7z8tL9kJ&Signature=Y1xPk9VrqUgMrg72%2BMbVerDaNd4%3D",
            "createdAt": "2020-04-02 01:54:24"
        }
    ],
    "message": "Success"
}
1
2
3
4
5
6
7
8
9
10
11
12
错误码 错误信息 错误原因
404001 合同不存在 合同id错误

# 合同添加静默签署区

# 简要描述:

合同添加签署区

# 接口地址:

/contractService/v1/contracts/{id}/signFields/platformSign

# 请求方式:

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求示例

post https://api.csign.cn/contractService/v1/contracts/{id}/signFields/platformSign

1
2

# 请求参数

参数名称 类型 必选 长度 参数说明 示例值
id string 合同id
signfields array 签署区列表数据
>fileId string 文件file id
>order int 32 签署顺序,默认1,且不小于1,顺序越小越先处理
>posPage string 页码信息,当签署区signType为2时, 页码可以'-'分割, 其他情况只能是数字
>posX float x坐标,默认空
>posY float y坐标
>width float 签署区宽,默认印章宽度
>height float 签署区高,默认印章高度
>sealId string 印章id, 仅限企业公章,暂不支持指定企业法定代表人印章
>signType int 32 签署类型, 1-单页签署 默认1

# 响应参数

参数名 类型 说明
fields string 签署区id

# 响应示例

{
    "code": 0,
    "datas": {
        "fields": [
            "C5DF3B5936324BFE86227EFFE7737BD9"
        ]
    },
    "message": "Success"
}
1
2
3
4
5
6
7
8
9
错误码 错误信息 错误原因
404001 合同不存在 合同id错误
403008 签署文件仅能是pdf文件 签署文件仅能是pdf文件
403009 signType不支持 signType不支持
403010 actorIdentityType类型不支持 actorIdentityType类型不支持
403011 SealType不支持 SealType不支持
403012 位置信息错误 位置信息错误
403013 文件不存在 文件不存在
403014 文件不是签署文件 文件不是签署文件

# 合同添加手动签署区

# 简要描述:

合同添加手动签署区

# 接口地址:

/contractService/v1/contracts/{id}/signFields/handSign

# 请求方式:

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求示例

post https://api.csign.cn/contractService/v1/contracts/{id}/signFields/handSign

1
2

# 请求参数

参数名称 类型 必选 长度 参数说明 示例值
id string 合同id
signfields array 签署区列表数据
>fileId string 文件file id
>order int 32 签署顺序,默认1,且不小于1,顺序越小越先处理
>posPage string 页码信息,当签署区signType为2时, 页码可以'-'分割, 其他情况只能是数字
>posX float x坐标,默认空
>posY float y坐标
>width float 签署区宽,默认印章宽度
>height float 签署区高,默认印章高度
>sealId string 印章id, 仅限企业公章,暂不支持指定企业法定代表人印章
>signType int 32 签署类型, 1-单页签署,默认1
>assignedPosBean bool 32 是否指定签署区
>signerAccountId bool 32 签署人账号
>authorizedAccountId bool 32 签署人授权主体账号
>SealType int 32 签署方式,个人签署时支持多种签署方式,0-手绘签名 ,1-个人签章盖章,2不限制

# 响应参数

参数名 类型 说明
fields string 签署区id

# 响应示例

{
    "code": 0,
    "datas": {
        "fields": [
            "C5DF3B5936324BFE86227EFFE7737BD9"
        ]
    },
    "message": "Success"
}
1
2
3
4
5
6
7
8
9
错误码 错误信息 错误原因
404001 合同不存在 合同id错误
403008 签署文件仅能是pdf文件 签署文件仅能是pdf文件
403009 signType不支持 signType不支持
403010 actorIdentityType类型不支持 actorIdentityType类型不支持
403011 SealType不支持 SealType不支持
403012 位置信息错误 位置信息错误
403013 文件不存在 文件不存在
403014 文件不是签署文件 文件不是签署文件
403015 账号非机构账号 账号非机构账号

# 合同签署区列表

# 接口描述

查询合同签署区列表,可以查询指定指定id或者签署人所属的签署区

# 接口

/contractService/v1/contracts/{id}/signFields

# 请求方式

GET

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数

参数名称 类型 必选 长度 参数说明 示例值
id string 合同id
accountId string 账号id,默认所有签署人
signfieldIds string 指定签署区id列表,逗号分割,默认所有签署区

# 公共响应参数

参数名称 类型 必选 长度 参数说明 示例值
code int 业务码,0表示成功
message string 信息
datas object 业务信息

# 响应参数

参数名称 类型 必选 长度 参数说明 示例值
signfields** array 签署区列表数据
>actorIndentityType int 32 签约主体类别,0-个人,1-机构,2 是不限,默认0,
>addTime int 64 添加时间
>assignedPosbean boolean 是否指定位置,TRUE表示不允许更新位置,配置项,无默认值
>assignedSeal boolean 是否指定印章数据,TRUE表示不允许更新印章,配置项,无默认值
>authorizedAccountId string 签约主体账号标识,将使用该主体账号对应的数字证书完成本次签署,如:当存在签署操作人代某机构签署时,需要传入该机构的账号id
>autoExecute boolean 是否自动执行,TRUE需要静默授权,配置项,无默认值
>executeFailedReason string 执行失败原因
>fileId string 文件file id
>order int 32 签署区顺序,默认1,且不小于1,顺序越小越先处理
>posPage string 页码信息,可以','或'-'分割
>posX float x坐标
>posY float y坐标
>width float 签署区宽
>sealId string 印章id
>sealType string 印章类型,支持多种类型时逗号分割,0-手绘印章,1-模版印章,为空不限制
>signType int 32 签署类型,0-不限,1-单页签
>signerAccountId string 签署操作人个人账号标识,即操作本次签署的个人,如需e签宝通知用户签署,则系统向该账号下绑定的手机、邮箱发送签署链接
>signfieldId string 签署区Id
>status int 32 签署区状态(0:"等待执行,1:"执行中",2:"执行失败",3:"审批中",4: "执行完成")
>statusDescription string 状态描述

# 请求示例

GET  https://api.csign.cn/contractService/v1/contracts/{id}/signFields
1

# 响应示例

{
  "code": 0,
  "message": "成功",
  "data": {
    "signfields": [
      {
        "signfieldId": "b76b69d5b48d4f689cae997e42809ac4",
        "flowId": "b2cb74258a634179b0df3cc54791c8b6",
        "signerAccountId": "faea8237c61a4fdea864ee8d7621e14f",
        "authorizedAccountId": "2c7de24aff3340f5b944ebac49545b8e",
        "fileId": "fe7df2f477d649c18ebcfdfffeba253d",
        "status": 1,
        "statusDescription": "执行中",
        "executeFailedReason": null,
        "addTime": 1561473111450,
        "sealType": "",
        "signType": 0,
        "order": 1,
        "autoExecute": false,
        "assignedPosbean": false,
        "assignedSeal": false,
        "addSignTime": false,
        "actorIndentityType": 1,
        "sealId": "",
        "sealFileKey": "",
        "posBean": {
          "posPage": "1",
          "posX": 158.72531,
          "posY": 431.05658
        }
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

# 合同删除签署区

# 接口描述

删除指定id的签署区,只能删除未签署状态的签署区。

# 接口

/contractService/v1/contracts/{id}/signFields

# 请求方式

DELETE

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数

参数名称 类型 必选 长度 参数说明 示例值
signfieldIds string 签署区id列表,逗号分割

# 公共响应参数

参数名称 类型 必选 长度 参数说明 示例值
code int 业务码,0表示成功
message string 信息
data object 业务信息

# 响应参数

参数名称 类型 必选 长度 参数说明 示例值
deleteResults array 签署区删除结果集合
failedReason string 失败原因
signfieldId string 签署区id

# 请求示例

DELETE https://api.csign.cn/contractService/v1/contracts/{id}/signFields?signfieldIds=F73A8DE2ED694E149D8AF327D67C068D
1

# 响应示例

{
    "code": 0,
    "datas": [
        {
            "failReason": "",
            "id": "F73A8DE2ED694E149D8AF327D67C068D",
            "success": true
        }
    ],
    "message": "Success"
}
1
2
3
4
5
6
7
8
9
10
11

# 合同签署人列表

# 接口描述

查询合同所有签署人列表。

# 接口

/contractService/v1/contracts/{id}/signers

# 请求方式

GET

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数

参数名称 类型 必选 长度 参数说明 示例值
id string id

# 公共响应参数

参数名称 类型 必选 长度 参数说明 示例值
code int 业务码,0表示成功
message string 信息
datas object 业务信息

# 响应参数

参数名称 类型 必选 长度 参数说明 示例值
signOrder int 32 签署顺序
signStatus int 32 签署状态, 0-待签, 1-未签, 2-已签 3-待审批 4-拒签
signerAccountId string 签署人账号id
signerName string 签署人名称
signerRealName boolean 签署人是否已实名
signerAuthorizedAccountId string 签约主体的账号id(个人/企业);如签署人本签署,则返回签署人账号id;如签署人代机构签署,则返回机构账号id
signerAuthorizedAccountName string 签约主体名称
signerAuthorizedAccountType int 32 签署主体类型, 1-个人, 2-机构

# 请求示例

GET https://api.csign.cn/contractService/v1/contracts/{id}/signers
1

# 响应示例

{
    "code": 0,
    "datas": [
        {
            "signOrder": 1,
            "signStatus": 0,
            "signerAccountId": "4A785F8DAF9C4F5B8C807B4E7E49C848",
            "signerName": "张正版",
            "signerRealName": false,
            "authorizedAccountId": "4A785F8DAF9C4F5B8C807B4E7E49C848",
            "authorizedAccountName": "张正版",
            "authorizedAccountType": 1
        }
    ],
    "messages": "请求成功"
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 一步发起合同

# 接口

/contractService/v1/contractsCreateOneStep

# 请求方式

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数

参数名称 类型 必选 长度 参数说明 示例值
attachments array 附件信息
>fileId string 附件Id
>fileName string 附件名称
docs array 待签文档信息
>fileId string 文档id
>fileName string 文档名称,默认文件名称
contractInfo object 合同基本信息
>autoArchive boolean 是否自动归档,默认false。
>autoInitiate boolean 是否自动开启,默认false。
>callbackUri body 合同签署完成后的回调地址
>businessScene string 合同标题
>initiatorAccountId string 发起方账户id
>initiatorAuthorizedAccountId string 发起方主体id
>remark string 合同备注
>signValidity int 64 签署有效截止时间,毫秒,默认不失效
signers array 签署方信息
>platformSign boolean 是否平台静默签署,默认为对接平台的用户签署
>signOrder int 32 签署方签署顺序,默认1,且不小于1,顺序越小越先处理
>signerAccount object 签署方账号信息(平台静默签署时忽略本参数)
>>signerAccountId string 签署操作人个人账号标识,即操作本次签署的个人
>>authorizedAccountId string 签约主体账号标识,即本次签署对应任务的归属方,默认是签署操作人个人
>signFields array 签署区信息
>>autoExecute boolean 是否自动执行,默认false(如果静默签署,必须设置为true)
>>actorIdentityType string 机构签约类别,当签约主体为机构时必传:2-机构盖章;
>>fileId string 签署文件fileId
>>sealId string 签章文件fileId
>>sealType string 签署方式,个人签署时支持多种签署方式,0-手绘签名 ,1-签章文件,2-都可以, 静默签时只能为1
>>signType int 32 签署类型,0-不限,1-单页签署,默认1
>>posPage string 页码信息,当签署区signType为2时, 页码可以'-'分割指定页码范围, 其他情况只能是数字
>>posX float x坐标
>>posY float y坐标
>>width float 签署区的宽度
>>height float 签署区的高度

# 公共响应参数

参数名称 类型 必选 长度 参数说明 示例值
code int 业务码,0表示成功
message string 信息
datas object 业务信息

# 响应参数

参数名称 类型 必选 长度 参数说明 示例值
contractId string 合同id

# 请求示例

POST https://api.csign.cn/contractService/v1/contractsCreateOneStep
{
    "attachments": [],
    "docs": [
        {
            "fileId": "BEAAEB3E13A1444F83B758D47CDD670E",
            "fileName": "ceshi.pdf"
        }
    ],
    "contractInfo": {
        "autoArchive": true,
        "autoInitiate": true,
        "businessScene": "测试",
        "initiatorAccountId": "0AD9B294ED05454798F407A1FD9A966A",
        "initiatorAuthorizedAccountId": "0AD9B294ED05454798F407A1FD9A966A",
        "remark": "",
        "signValidity": "2020-08-16 00:00:00"
    },
    "signers": [
        {
            "platformSign": false,
            "signFields": [
                {
                    "autoExecute": false,
                    "fileId": "BEAAEB3E13A1444F83B758D47CDD670E",
                    "sealType": 1,
                    "posPage": "1",
                    "posX": 215,
                    "posY": 508,
                    "width": 100,
                    "height": 80,
                    "sealId": "6308544F900F4ACC8D1A7C23812B1F0A"
                }
            ]
        }
    ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# 响应示例

{
    "code": 0,
    "datas": {
        "contractId":"4A785F8DAF9C4F5B8C807B4E7E49C848",
    },
    "messages": "请求成功"
}

1
2
3
4
5
6
7
8
错误码 错误信息 错误原因
404001 合同不存在 合同id错误
403028 平台签署时autoExecute必须为true 平台签署时autoExecute必须为true
403029 平台签署时必须指定sealId 平台签署时必须指定sealId
403030 平台签署时签章类型只能为1 平台签署时签章类型只能为1

# 开启合同

# 接口描述

开启合同

# 接口

/contractService/v1/contracts/{id}/start

# 请求方式

PUT

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 公共响应参数

参数名称 类型 必选 长度 参数说明 示例值
code int 业务码,0表示成功
message string 信息
data object 业务信息

# 请求示例

PUT https://api.csign.cn/contractService/v1/contracts/{id}/start
1

# 响应示例

{
    "code": 0,
    "message": "Success"
}
1
2
3
4
错误码 错误信息 错误原因
404001 合同不存在 合同id错误
403017 只能开启草稿状态合同 只能开启草稿状态合同
403018 签署文件未添加 签署文件未添加
403019 签署区未添加,不能开启合同 签署区未添加,不能开启合同
403019 签署区未添加,不能开启合同 签署区未添加,不能开启合同

# 撤销合同

# 接口描述

撤销合同

# 接口

/contractService/v1/contracts/{id}/revoke

# 请求方式

PUT

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求参数

参数名称 类型 必选 长度 参数说明 示例值
reason string 撤销理由
operatorId string 撤销账号id

# 公共响应参数

参数名称 类型 必选 长度 参数说明 示例值
code int 业务码,0表示成功
message string 信息
data object 业务信息

# 请求示例

PUT https://api.csign.cn/contractService/v1/contracts/{id}/revoke
1

# 响应示例

{
    "code": 0,
    "message": "Success"
}
1
2
3
4
错误码 错误信息 错误原因
404001 合同不存在 合同id错误
403021 合同已完成或已撤销 合同已完成或已撤销
403018 只能撤销签署中的合同 只能撤销签署中的合同


# 合同下载

# 接口描述

合同下载,以流的形式返回zip压缩包

# 接口

/contractService/v1/contracts/{id}/download

# 请求方式

GET

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
X-CQ-APPKEY String 应用APP_KEY
X-CQ-APPTOKEN String 通过获取鉴权Token接口返回
Content-Type String application/json

# 请求示例

GET https://api.csign.cn/contractService/v1/contracts/{id}/download
1
错误码 错误信息 错误原因
404001 合同不存在 合同id错误

# 合同验真报告

# 接口描述

合同验真报告

# 接口

/contractService/v1/contracts/:id/realTestReport

# 请求方式

GET

# 响应参数

参数名称 类型 必选 长度 参数说明 示例值
downloadUrl string 验真下载地址

# 请求示例

GET https://api.csign.cn/contractService/v1/contracts/:id/realTestReport
1

# 响应示例

{
    "code": 0,
    "datas": {
        "downloadUrl": "https://docu.csign.cn/reports%2F9954DD73AD0D448CA52DF54AE3B14427.pdf?Expires=1612160001&OSSAccessKeyId=LTAI4Fut1oWaGZso7z8tL9kJ&Signature=VNQmmzrlnhP45q2zBzbSiuuKxK4%3D"
    },
    "message": "Success"
}
1
2
3
4
5
6
7

# 通知回调

# 简要描述:

合同签署成功,拒签,撤销,过期完成之后,主动向应用server端发送请求

# 接口地址:

saas后台配置应用callbackUri或合同创建时填写的callbackUri参数,合同创建添加地址优先

# 请求方式:

POST

# 公共请求参数

参数名称 类型 必选 长度 参数说明 示例值
Content-Type String application/json

# 请求参数

参数名称 说明 参数类型 类型
action 通知类型 body string
contractId 合同id body string
businessScene 合同标题 body string
status 状态 (2:完成,3:撤销,5:过期,6:拒签) body int
statusDescription 状态名称 body string
createdAt 创建时间 body string
endAt 完成时间 body string