可信数据身份平台(B-Trust)API接口说明

Overview

数字建筑全流程的可信数据身份平台服务

可信平台相关问题请联系:kangxh@hsifue.cn

认证鉴权token获取请访问304永利集团中台及相关文档:

测试环境:http://aecore-test.hsifue.cn

生产环境:http://aecore.hsifue.cn

304永利集团中台网关的访问base url:

测试环境:http://apigate-test.hsifue.cn/b-trust/

生产环境:http://apigate.hsifue.cn/b-trust/

接口返回code与message对应关系:

10000:成功

10001:异常

10002:参数错误

10003:认证字段不合法,认证字段均不可为空,请检查认证参数是否符合规范

10004:签名不合法

10005:第三方服务错误

10010:签名的请求时间与服务时间相差大于%d分钟,签名失效

10020:根据appName的值已经生成过appId

10030:参数不为JSON格式

10040:不存在的appId

10050:认证信息不存在

10055:认证信息错误

10060:接口权限认证错误

20010:用户已注册

20010:用户已注册(相同的手机号)

20010:用户已注册(相同的邮箱)

20020:用户已实名

20021:用户未实名

20030:用户不存在

20035:账户ID、手机号、邮箱不能都为空

20040:用户创建失败

20045:手机号或邮箱不能为空

20050:不存在的账户类型

20060:实名证书申请失败

20065:实名证书已申请,请勿重复申请

20070:实名证书获取失败

20075:未查询到用户实名证书

20078:实名证书未申请

20080:数据验签-证书解析失败

20090:数据验签失败

20110:实名证书已过期

20210:企业用户不存在

20220:企业账户类型不匹配

20230:企业用户未实名

20240:企业实名证书未申请

20260:个人用户不存在

20270:个人账户类型不匹配

20280:个人用户未实名

20290:个人实名证书未申请

20250:印章授权失败

20310:不存在已授权的记录

20320:重复的授权/取消授权操作

40010:未通过一致性校验

40011:实名认证失败

40012:实名认证异常

40020:企业认证失败

40030:验证码错误

40031:验证码申请失败

40032:验证码未空

40040:验证码和key需要绑定使用

40050:OCR识别失败

40060:人脸识别失败

40065:获取实名认证URL失败

40070:账户未完成实名认证或未申请证书

40080:账户类型不匹配

50010:印章未查询到

50015:非自定义印章不可删除

50020:印章已创建过

50030:印章创建失败

50040:第三方印章查询失败

60010:文件不存在或为空

60014:文件名称格式不对或包含了空格

60011:生成合同模板失败

60012:合同模板文件不存在

60015:合同下载失败

60020:不支持的文件类型

60025:印章图片太大了,不能大于200KB

60030:文件读取异常

60032:文件写入异常

60033:文件未查询到

60035:文件太大了,不能大于

60040:此合同未查询到

60042:多个合同ID中存在不正确的ID

60045:合同创建失败

60048:合同合并失败

60050:合同签署流程还未启动

60051:合同签署流程正在签署中

60052:合同签署流程已完成

60053:合同签署流程已撤销

60059:合同签署流程异常

60060:无此签署人

60061:签署人签署方式不正确,此签署人不能静默签署此合同

60062:签署人签署方式不正确,此签署人不能页面签署此合同

60063:如果用签署坐标定位,则该参数可为空或包含三个信息:“页面,x轴坐标,y轴坐标”(如20,30,49)

60064:如果静默签署,则签署位置不能为空

60065:签署坐标大于合同区域

60065:签署人列表不能为空

60080:签署人已经签署过合同

60090:合同签署时异常

60095:合同手动签署回调签名不符

60100:签署者状态不为已签署等待真实意愿表达状态

60140:合同不为签署状态,不可存证

60150:合同已存证,不可重复存证

60155:合同已存证,不可重复存证

60160:合同签署真实意愿验证码错误

60170:不支持的签署类型

60080:企业授权个人签署时印章id不能为空

60090:新建页面添加table时从第几页开始不能为空,关键字后添加table时查找关键字不能为空

60095:表格宽度的比例只能为100以下数字

60098:待填充字段不为Json格式

70010:数据预签名提交失败

70020:数据预签名提交失败

70030:数据预签名未找到

70035:短信验证码比对密钥不正确

70040:数据签名确认失败

70050:数据签名失败

99999:未知错误

Resources

1.用户管理

包括个人和企业用户的创建,证书申请及证书查询,证书申请时请先实名认证

证书申请

POST localhost:8080/api/v2/account/apply/cert
Description

证书申请

Parameters
Type Name Description Schema
Body req
*optional*
JSON格式参数 以账户ID申请证书请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«申请证书响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

企业用户创建

POST localhost:8080/api/v2/account/org
Description

企业用户创建

Parameters
Type Name Description Schema
Body req
*optional*
JSON格式参数 创建企业用户请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«创建企业账户响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

个人用户创建

POST localhost:8080/api/v2/account/person
Description

个人用户创建

Parameters
Type Name Description Schema
Body req
*optional*
JSON格式参数 创建个人用户请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«创建个人账户响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

证书详情查询

POST localhost:8080/api/v2/account/query/cert/info
Description

证书详情查询

Parameters
Type Name Description Schema
Body req
*optional*
JSON格式参数 查询证书信息请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«查询证书信息响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

企业用户信息查询

POST localhost:8080/api/v2/account/query/org
Description

企业用户信息查询

Parameters
Type Name Description Schema
Body req
*optional*
JSON格式参数 查询企业用户信息请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«查询企业用户信息响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

个人用户信息查询

POST localhost:8080/api/v2/account/query/person
Description

个人用户信息查询

Parameters
Type Name Description Schema
Body req
*optional*
JSON格式参数 查询个人用户信息请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«查询个人用户信息响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

2.实名认证

包括企业和个人三要素实名认证,个人人脸实名认证接口

人脸识别+三要素个人实名认证api

POST localhost:8080/api/v2/identify/face
Description

获取人脸实名+三要素个人实名认证URL,认证结果需要回调通知的可以在请求header里notify字段里放入使用方的回调地址

Parameters
Type Name Description Schema
Body req
*optional*
JSON格式参数 异步认证方式请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«异步认证方式响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

实名认证异步通知回调api

POST localhost:8080/api/v2/identify/notify
Description

非使用方调用,使用方需创建类似这个的回调接口,可信平台调用此接口通知平台使用方是实名认证结果!数据样例:{

“accountId”:“acct63583954912935944”,//账户ID

“accountType”:“0”,//0是个人账户,1为企业账户

“status”:“0”,//0为未实名认证状态,1为实名认证状态

“option”:"",//identify为实名认证回调 esignature为电子签章回调

“nonce”:"",//随机生成字符串

“digest”:"",//校验签名 SP私钥加密(nonce + accountId)

}

Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

企业对公打款实名认证api

POST localhost:8080/api/v2/identify/org/pay/async
Description

获取企业实名认证URL,认证结果需要回调通知的可以在请求header里notify字段里放入使用方的回调地址

Parameters
Type Name Description Schema
Body req
*optional*
JSON格式参数 企业实名认证异步请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«异步认证方式响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

个人3要素实名认证api

POST localhost:8080/api/v2/identify/person/3/async
Description

获取三要素个人实名认证URL,认证结果需要回调通知的可以在请求header里notify字段里放入使用方的回调地址

Parameters
Type Name Description Schema
Body req
*optional*
JSON格式参数 异步认证方式请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«异步认证方式响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

3.印章管理

印章管理相关接口,个人与企业印章创建查询,自定义印章创建等

创建自定义印章

POST localhost:8080/api/v2/esignature/seal/
Description

账户需完成实名认证,注意: 1.图片的正确性和图片的大小需要自己控制好,我们这边是直接盖上你们传的图片,不做压缩。[企业默认章大小是166*166,个人章的默认大小是134*60,且图片为透明的]。

2.base64的值不能加上前缀data:image/png;base64,加上后图片会无法显示。

Parameters
Type Name Description Schema
Body customerSealReqModel
*optional*
JSON格式参数 自定义印章请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«印章管理通用响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

印章授权

POST localhost:8080/api/v2/esignature/seal/authorize
Description

印章授权接口

Parameters
Type Name Description Schema
Query companyId
*required*
企业账户id string
Query operateType
*required*
授权操作类型,0=取消授权,1=授权 string
Query personId
*required*
被授权个人账户id string
Query sealId
*required*
印章ID string
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

查询授权印章列表

POST localhost:8080/api/v2/esignature/seal/authorize/list
Description

查询印章授权列表接口

Parameters
Type Name Description Schema
Query accountId
*required*
账户id string
Query currentPage
*required*
当前页数 string
Query pageSize
*required*
每页记录数 string
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«查询授权印章列表返回MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

删除印章

DELETE localhost:8080/api/v2/esignature/seal/delete
Description

删除印章

Parameters
Type Name Description Schema Default
Query accountId
*required*
账户id string "acct1155782836133822465"
Query sealId
*required*
印章ID string "seal51312959317606400"
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

查询印章列表

GET localhost:8080/api/v2/esignature/seal/list
Description

查询印章列表

Parameters
Type Name Description Schema
Query accountId
*required*
账户id string
Query currentPage
*required*
当前页数 string
Query pageSize
*required*
每页记录数 string
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«查询印章列表返回MODEL»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

创建企业印章

POST localhost:8080/api/v2/esignature/seal/org
Description

创建企业印章,系统自动生成的印章,只能创建一个且账户需完成实名认证。

Parameters
Type Name Description Schema
Body enterpriseSealReqModel
*required*
JSON格式参数 创建企业印章请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«印章管理通用响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

创建个人印章

POST localhost:8080/api/v2/esignature/seal/person
Description

创建个人印章,系统自动生成的印章,只能创建一个且账户需完成实名认证。

Parameters
Type Name Description Schema
Body individualSealReqModel
*required*
JSON格式参数 创建个人印章请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«印章管理通用响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

查询印章

POST localhost:8080/api/v2/esignature/seal/query
Description

查询印章

Parameters
Type Name Description Schema
Body commonSealReqModel
*optional*
JSON格式参数 印章管理通用请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«自定义印章响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

4.合同及合同签署

合同及合同签署相应流程相关接口

撤销合同api

POST localhost:8080/api/v2/esignature/contract/cancel
Description

撤销合同接口

Parameters
Type Name Description Schema
Body commonContractReqModel
*optional*
JSON格式参数 合同ID做请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«合同生成响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

获取合同列表api

GET localhost:8080/api/v2/esignature/contract/contract/list
Description

获取合同列表接口

Parameters
Type Name Description Schema
Query accountId
*required*
账户id string
Query currentPage
*required*
当前页数 string
Query pageSize
*required*
每页记录数 string
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«合同列表响应MODEL»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

合并多个合同api

POST localhost:8080/api/v2/esignature/contract/contract/merge
Description

根据多个合同id合并成一个合同接口

Parameters
Type Name Description Schema
Body mergeContractReqModel
*optional*
JSON格式参数 合并合同请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«合同生成响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

根据合同模板文件创建合同api

POST localhost:8080/api/v2/esignature/contract/create
Description

根据合同模板文件创建合同接口

Parameters
Type Name Description Schema
Body addContractReqModel
*optional*
JSON格式参数 生成合同请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«合同生成响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

获取合同详情api

POST localhost:8080/api/v2/esignature/contract/details
Description

获取合同详情接口

Parameters
Type Name Description Schema
Body commonContractReqModel
*optional*
JSON格式参数 合同ID做请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«合同详情MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

合同下载api

GET localhost:8080/api/v2/esignature/contract/download
Description

合同下载接口

Parameters
Type Name Description Schema Default
Query contractId
*required*
合同ID string "ctct1153902852045799424"
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Produces
  • application/octet-stream
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

合同归档api

POST localhost:8080/api/v2/esignature/contract/evidence
Description

合同归档接口

Parameters
Type Name Description Schema
Body commonContractReqModel
*optional*
JSON格式参数 合同ID做请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«存证响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

删除上传的合同模板api

DELETE localhost:8080/api/v2/esignature/contract/file/delete
Description

删除上传的合同模板

Parameters
Type Name Description Schema Default
Query accountId
*required*
账户id string "acct1155782836133822465"
Query fileId
*required*
文件ID string "file1153469558326034432"
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

获取上传合同模板列表api

GET localhost:8080/api/v2/esignature/contract/file/list
Description

获取上传合同列表模板接口

Parameters
Type Name Description Schema
Query accountId
*required*
账户id string
Query currentPage
*required*
当前页数 string
Query pageSize
*required*
每页记录数 string
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«查询上传合同文件列表返回MODEL»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

合同模板文件上传api

POST localhost:8080/api/v2/esignature/contract/fileupload
Description

上传PDF格式的合同模板文件,以便生成系统合同。

Parameters
Type Name Description Schema Default
Query accountId
*required*
账户id string "acct1155782836133822465"
FormData file
*required*
上传的模板文件 file
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«上传文件响应MODEl»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • multipart/form-data
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

异步通知回调api

POST localhost:8080/api/v2/esignature/contract/notify
Description

非使用方调用,使用方需创建类似这个的回调接口,可信平台调用此接口通知平台使用方是电子签名结果与合同状态!数据样例:{

“contractId”:“ctct63583954912935944”,//账户ID

“signerId”:“sgnr81696268623020002”,//0是个人账户,1为企业账户

“signerStatus”:“0”,//0为签名者未签名,2为签名者已签名状态

“contractStatus”:“1”,//1为合同签署中状态,2为合同已签署完成状态

“option”:"",//identify为实名认证回调 esignature为电子签章回调

“nonce”:"",//随机生成字符串

“digest”:"",//校验签名 SP私钥加密(nonce + signerId)

}

Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

获取签署人accountId

POST localhost:8080/api/v2/esignature/contract/preAddsigners
Description

获取签署人accountId!

Parameters
Type Name Description Schema
Body makeSignersReqModel
*optional*
JSON格式参数 检查签署者请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

获取手动签署地址api

POST localhost:8080/api/v2/esignature/contract/sign/url
Description

获取手动签署地址接口,调用手动签署!签署结果需要回调通知的可以在请求header里notify字段里放入使用方的回调地址

Parameters
Type Name Description Schema
Body signUrlReqModel
*optional*
JSON格式参数 获取手动签署请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«启动合同流程响应URL参数MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

获取签署人列表api

GET localhost:8080/api/v2/esignature/contract/signer/list
Description

获取签署人列表接口

Parameters
Type Name Description Schema
Query contractId
*required*
合同ID string
Query currentPage
*required*
当前页数 string
Query pageSize
*required*
每页记录数 string
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«签署人列表响应MODEL»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

获取签署管理列表api

GET localhost:8080/api/v2/esignature/contract/signer/mng/list
Description

获取签署管理列表接口

Parameters
Type Name Description Schema
Query accountId
*required*
账户id string
Query currentPage
*required*
当前页数 string
Query pageSize
*required*
每页记录数 string
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«签署列表管理响应MODEL»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

添加签署者api

POST localhost:8080/api/v2/esignature/contract/signers
Description

添加签署者api,每次调用此接口将会覆盖之前的签署人信息!

Parameters
Type Name Description Schema
Body contractSignersReqModel
*optional*
JSON格式参数 添加签署者请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«添加签署者返回MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

静默签署api

POST localhost:8080/api/v2/esignature/contract/silence
Description

静默签署接口3,调用静默签署接口!

Parameters
Type Name Description Schema
Body silenceSignReqModel
*optional*
JSON格式参数 静默签署接口请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

启动合同签署流程api

POST localhost:8080/api/v2/esignature/contract/start
Description

启动合同签署流程!

Parameters
Type Name Description Schema
Body commonContractReqModel
*optional*
JSON格式参数 合同ID做请求参数MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

上传文件并生成合同api

POST localhost:8080/api/v2/esignature/contract/uploadAndCreate
Description

上传合同文件并根据文件生成合同。

Parameters
Type Name Description Schema Default
Query accountId
*required*
账户id string "acct1155782836133822465"
Query contractTitle
*required*
合同名称 string "XX合同"
FormData file
*required*
上传的合同文件 file
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«合同生成响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • multipart/form-data
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

5.数据签署

数据签署及验证相关接口

确认数据签名接口

POST localhost:8080/api/v2/esignature/data/sign
Description

提供签署信息,请求参数一律用字符串表示

Parameters
Type Name Description Schema
Body dataSignSmsCodeReq
*required*
JSON格式参数 获取数据签署验证码MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«数据签署响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

数据签名信息提交接口

POST localhost:8080/api/v2/esignature/data/sign/preSignData
Description

提供混合云客户端提交数据签名接口功能,请求参数一律用字符串表示

Parameters
Type Name Description Schema
Body preDataSignReq
*required*
JSON格式参数 数据签署意愿表达请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«数据签署意愿表达返回MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

发送验证码接口

POST localhost:8080/api/v2/esignature/data/sign/smsCode
Description

提供签署信息,请求参数一律用字符串表示

Parameters
Type Name Description Schema
Body dataSignSmsSendReq
*required*
JSON格式参数 发送数据签署验证码MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

数据签(静默)

POST localhost:8080/api/v2/esignature/data/signSilent
Description

提供混合云客户端提交数据签名接口功能,请求参数一律用字符串表示

Parameters
Type Name Description Schema
Body dataSignReq
*required*
JSON格式参数 数据签署请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«数据签署响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

数据签署验证

POST localhost:8080/api/v2/esignature/data/verify
Description

对签署数据结果进行校验

Parameters
Type Name Description Schema
Body dataSignVerifyReq
*required*
JSON格式参数 数据签署验证请求MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«数据签署验签接口响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

6.通用存证

通用存证相关接口V2(兼容历史版本存证相关接口)

存证存储api

POST localhost:8080/api/v2/attestation/data
Description

通用存证存储接口

Parameters
Type Name Description Schema
Query data
*required*
上链数据(base64编码) string
Query key
*optional*
查询主键key string
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«通用存证响应»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

根据Key查询存证api

GET localhost:8080/api/v2/attestation/dataByKey
Description

根据Key查询存证数据接口

Parameters
Type Name Description Schema
Query key
*required*
查询主键key string
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«string»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

交易信息查询api

GET localhost:8080/api/v2/attestation/fabricTxById
Description

根据交易ID查询交易接口

Parameters
Type Name Description Schema
Query txId
*required*
区块链交易ID string
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«区块链交易信息»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

7.业务系统接入接口

业务系统接入相关接口(兼容历史版本存证相关接口)

业务系统注册证书

POST localhost:8080/api/biz
Description

通过注册证书,业务系统接入存证平台,注册成功返回业务平台ID

Parameters
Type Name Description Schema
Body biz
*required*
biz 业务系统注册MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!成功:CODE.SUCCESS 统一结果返回MODEL«string»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

查询业务证书信息

GET localhost:8080/api/biz
Description

根据业务ID查询证书信息

Parameters
Type Name Description Schema
Query bizId
*required*
业务ID string
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!成功:CODE.SUCCESS 统一结果返回MODEL«string»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

8.工具接口

工具类及测试类接口,辅助swagger接口测试用

生成appid与appsecret的api

POST localhost:8080/api/v2/util/appinfo/create
Description

输入代表业务方的一串字符,生成appid与appsecret参与接口调用与校验。

Parameters
Type Name Description Schema Default
Query appName
*required*
app名称 string "304永利集团新金融产品"
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«JSONObject»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

生成authorization的api

POST localhost:8080/api/v2/util/appinfo/encode
Description

根据appId及appSecret加密json格式参数,生成签名,并构建authorization,放入请求头部

Parameters
Type Name Description Schema Default
Query appId
*required*
appId string "Njlnb285MzdvOTUxb2Q2MzI"
Query appSecret
*required*
appSecret string "5bm/6IGU6L6+5paw6YeR6J6N5Lqn5ZOBOjdvZ28xNWU4M242NTI5MDBlMWc2ODlkZ24zMDk2MTE4bmcwbzgzMDA="
Query jsonParams
*required*
请求参数JSON格式 string "{\"name\":\"1234\"}"
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«JSONObject»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

Base64编码转图片api

POST localhost:8080/api/v2/util/download
Description

Base64编码转图片接口

Parameters
Type Name Description Schema
Body customerSealRespModel
*required*
customerSealRespModel 自定义印章响应MODEL
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 No Content
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • application/json;charset=UTF-8
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

测试用接口

GET localhost:8080/api/v2/util/test
Description

测试用接口

Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

图片转Base64编码api

POST localhost:8080/api/v2/util/upload
Description

上传图片,返回base64编码。

Parameters
Type Name Description Schema
FormData file
*required*
上传的文件 file
Responses
HTTP Code Description Schema
200 均为返回成功,以返回值中code为准!分别为10000,10001,10002 统一结果返回MODEL«自定义印章响应MODEL»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • multipart/form-data
Produces
  • \*/*
Security
Type Name Scopes
apiKey 认证参数 global
apiKey 回调地址Url global
apiKey 调用方AppId global
apiKey 模拟权限 global

Definitions

JSONObject

Type : < string, object > map

ReadInfo

Name Schema
key
*optional*
string
version
*optional*
Version

ReadSet

Name Schema
namespace
*optional*
string
readInfos
*optional*
< ReadInfo > array

Version

Name Schema
blockNum
*optional*
string
txNum
*optional*
string

WriteInfo

Name Schema
key
*optional*
string
value
*optional*
string

WriteSet

Name Schema
namespace
*optional*
string
writeInfos
*optional*
< WriteInfo > array

上传合同文件返回MODEL

上传合同文件返回模型

Name Description Schema
createTime
*optional*
创建时间
**Example** : "2019-07-22 17:24:07"
string
fileId
*optional*
文件ID
**Example** : "file1153469558326034432"
string
name
*optional*
文件名称
**Example** : "a.pdf"
string
path
*optional*
文件路径
**Example** : "/path/a.pdf"
string
remark
*optional*
备注
**Example** : "备注"
string

上传文件响应MODEl

上传文件响应模型

Name Description Schema
fileId
*required*
文件ID
**Example** : "file1153469558326034432"
string
fileName
*required*
文件名称
**Example** : "a.pdf"
string
filePath
*required*
文件路径
**Example** : "/path/a.pdf"
string

业务系统注册MODEL

业务系统注册MODEL

Name Description Schema
algo
*required*
签名算法
**Example** : "SHA256withECDSA"
string
cert
*required*
DER编码字节
**Pattern** : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"
**Example** : "示例DER"
string (byte)
domain
*required*
业务系统域名
**Example** : "示例域名"
string
name
*required*
业务系统名
**Example** : "示例名称"
string
nonce
*required*
随机数
**Example** : "示例随机数"
string
signature
*required*
签名值
**Example** : "XXXXXXXXXXXXXXXX"
string
timestamp
*required*
时间戳long
**Example** : "示例时间戳"
string

以账户ID申请证书请求MODEL

以账户ID申请证书请求模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string

企业实名认证异步请求MODEL

企业实名认证异步请求模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
companyPrincipalType
*optional*
企业负责人身份:1=法人,2=代理人
**Example** : "1"
string
idNum
*required*
企业统一社会信用代码
**Example** : "12100000400000624D"
string
legalPersonId
*optional*
法人/代理人证件号码,目前只支持身份证
**Example** : "430103199904052952"
string
legalPersonMobile
*optional*
电话
**Example** : "010-5645679"
string
legalPersonName
*optional*
法人/代理人姓名
**Example** : "张三"
string
name
*required*
企业名称
**Example** : "中国电信集团北京公司"
string
returnUrl
*required*
操作完成后返回的URL
**Example** : "http:///114.115.148.211:8900/swagger-ui.html"
string

列表印章返回MODEL

列表印章返回模型

Name Description Schema
createTime
*optional*
创建时间
**Example** : "2019-07-22 17:24:07"
string
imageData
*optional*
图片经Base64编码
**Example** : "iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAeKSURBVGhD1Zp1qBVPFMe/79mtYGC3ohjYga34bFFUFBtbEUwQAwwM7EDBwMcTFLG7/rADEzFQVOxnK3br+e33nhn36s97d/cpPv3AsHNmZvfO2TNzZubshZDr10X69BGBIzLFxPzdyfZz4ECR27dDKkBu3RLJmNGt/NdS5swhZWKkXz/B4sUI0aYNUKkS8OmTyn8rqVIBp08DGzeqPGCAo5LVrG3bkIn+KVq00L7HxkqsquRAS/xr1Kih169fEYuYGBWCDifnZjx4ABw7Buzdawr/MLbPjg6uRby4dAkYORIYOxbo2xeoWBEoVQqoWRNo2BD48ME0TCa+ubPx483Ai0BCguspwlP9+iIXL5pGfxj2mX1wdPBvkS5dgKZNgbg4U+Bw4oQOq9KlTUFAODyPHFEPdOAAMHcuMGwYULQokDJlaMigY0fT2APfFgnHrjujR4u0aSNSubJIsWIiJUuKfP1qGvng5UvXspHS2LGm8U8IbBGO/1WrgEGD9C29fq3lFy6oL3/4ELh6Fbh8GYh1Hrlpk9Z7kSkTUK6cEcLgb7Rrp5aaNMkUeuBpEb7hnj3dNzRjhkiFCrpVIJky6fyxLFum7fyyYYPIggUi69e7vzF0qKn0IMwi0RVZt04kLk7z586J5Myp+W7dRLJm1TwV4YRfs0Zk3jyR/Pn1ebVra30QrCJ8Djl8WOTDB83/DF9Da/9+NS+HC3n/Hnj0SPNp0qj5SbVqwL59QK9ewKlTQMGCQIsWQP78wMeP2iYS794Bd+/qfQcPmkKH4cOB1KmBWrWAZs1MoQcRLbJnj77V5s1VzpFD2xFayeY5YadPF7l5U+UgbN6sz4mWfE52f17r9WuRESOM4DBrlkh8vMjJkyK7dukx4O1bUxmQ8E7bVKaMyKJFpkEUAiti4URu0kSkSBGRAgVEUqUSKV8+tGmT7NlFmjYVefXKNPYJ59bKlSL377uKrF5tKj0IrMiwYe6PjBolUry45hMTtX7TJrd++XItSwr2GZcvmwIPwhTxt46wOdm2DZg6FWjeXOWyZYEZM4BWrXT9ID176jUI3PydOWMEB+7nZs4Epk0Dhg7VvVy2bOpEIuHLIjt3apsTJ/Qano4cEbl715X9cvasWpfOJG/e758ZLa1dax7gENgiTZro9eVLYPt2oHFjlfkY7n7XrVN53jy9RmLHDnXbTFWrAkePArlyAR06AKNHAwMHAhMnqjtOTARu3gQOH1ar8xSYOTNw/bp52A/4sgjhQb9cOQmd8du103vSpRM5eFBdJGV6sWhwcevcWV07PWFQnj4VefHCCA5hFgnmteip2NbcHPJUVq5UyTT6gwQeWpYlS4CEBODzZ52gjx/r1jtLFh0SyUkgi0SCq3tykGSLWH4833M7/qvQtdIJzJ9vCoIRTJFr14C6ddVTvXljCn8T3GSSli31GhD/inTqBBQvrrtUuscpU0zFb4LzjoG3DBlMQTC8FdmyRX396tUq584NTJ8OjBun8u+CilgfmASiKzJnDtC6tXsO4daBCxLDQmnTalk4N27oIpYU3r51zzhJILIiPPQwomHhm+L5mQrYt8b4FvdA7EC6dECVKkDhwiozEhKEe/f0wMbVm/C8zliaTyIrwo59+aLzwsKNXe3aumZMmAAsXQo8fw507aqKP3liGjpwQxkE3psiBRAfD9SvD1SuDMyebSq9iT60uKPNk0fzGTNqfJh7H1phzBgtJ1TKUqKEXqtX16sfGKGhR3zxQiM1PGYTvhy/eC6IpUvbKShSr57I6dOmwoFlqVMbwWDb3rtnCn4Cd9OMlDRurIcze49NpUqJbN9uGkchbEH0VsQG444fNwUODAkR+8MfP6q8davKhQqpHIkePdx7f0yNGplGPgi0sjMYt2KFbrs5H7Jndycy84QRD05wu5hNnqzXSHAekCJF9EhgvVXWrO6RICDeipCFC1WZvHl1TeGXLWLDQjwV2s4wZlunjuajwQjl8ePA7t3qWAhfVHhsOQieQyttWtfsBQuKfPliKhwYjGPEgzAiuXSpyIoVKvvFhoRq1HB/h3FkPwQaWtymkwIF9O3ZsznhYypU0Dwt0ru3uuIg9O+vVuZpkcOYm0d6MJZxLfGJtyLdu+tCeP48ULKkKTTws0C+fEZIAuPHA/fvq/sl3Gdt3QqsXau7Ca4lV65onQfeinAl59bErrjhcMHknEgKjANw/WGnGzQwhQaGamltHg/48hiWXb8eePbMNPg//iZ7JBgPDh9q0eBe6vZtDfFwOHKYctiy05HgPo/wgxLb8VMfr+fOabl1MMRzskeD9zGk4wd+PtD3rGnbNlMRBbYJvyc8DRkiMneu5h0dfl2RmjWN4AN6NkZS3rwxBT749EkXXMbPGF5lXMsGzCdO/KbIrw0tcueOyfiAQ4GLZ/r0psAHnIM8cPFU2r69Di1+uiB0NoZYRx/NsXFQDh3SHXBywZdCHB1ci3CVDQo/xCR1Jf4d8IswcYzw/Z9qGIymq/P60pTc0BI8TuzcqfKQIY5VGALlX4VCBvoHE79lJiY6Xovwz1uDB+sHG1bSk/3NiX1MkUL7fOeOo4DIf+1Z72+BsooLAAAAAElFTkSuQmCC"
string
remark
*optional*
备注
**Example** : "备注"
string
sealId
*optional*
印章ID
**Example** : "seal51312959317606400"
string
type
*optional*
印章类型,0=个人印章 1=公司印章 2=自定义印章
**Example** : 0
integer (int32)

创建个人印章请求参数MODEL

创建个人印章请求参数模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
remark
*required*
备注
**Example** : "备注"
string

创建个人用户请求MODEL

创建个人用户请求模型

Name Description Schema
email
*optional*
E-mail
**Example** : "123456@qq.com"
string
idNum
*optional*
身份证号码
**Example** : "430103199904052952"
string
mobile
*optional*
账户手机号码
**Example** : "13912345678"
string
name
*required*
姓名
**Example** : "张三"
string

创建个人账户响应MODEL

创建个人账户响应模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string

创建企业印章请求参数MODEL

创建企业印章请求参数模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
remark
*required*
备注
**Example** : "备注"
string

创建企业用户请求MODEL

创建企业用户请求模型

Name Description Schema
email
*optional*
E-mail
**Example** : "123456@qq.com"
string
idNum
*optional*
企业统一社会信用代码
**Example** : "12100000400000624D"
string
legalPersonId
*optional*
法人/代理人证件号码,目前只支持身份证
**Example** : "430103199904052952"
string
legalPersonMobile
*optional*
法人/代理人手机号
**Example** : "13912345678"
string
legalPersonName
*optional*
法人/代理人姓名
**Example** : "张三"
string
mobile
*optional*
账户手机号码
**Example** : "13912345678"
string
name
*required*
企业名称
**Example** : "中国电信集团北京公司"
string

创建企业账户响应MODEL

创建企业账户响应模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string

区块链交易信息

区块链交易详细信息

Name Description Schema
blockId
*required*
区块数
**Example** : "13438954434"
string
chainCodeName
*required*
合约名
**Example** : "13438954434"
string
creationTime
*required*
创建时间
**Example** : "13438954434"
string
creatorMspId
*required*
创建者MSP
**Example** : "13438954434"
string
endorseMsdId
*required*
背书者所属MSP
**Example** : "13438954434"
string
readSets
*required*
交易读集合
**Example** : 13438954434
< ReadSet > array
status
*required*
交易ID
**Example** : "13438954434"
string
txId
*required*
交易ID
**Example** : "13438954434"
string
type
*required*
交易类型
**Example** : "ENDORSER_TRANSACTION"
string
verifyCode
*required*
验证码
**Example** : "13438954434"
string
writeSets
*required*
交易写集合
**Example** : 13438954434
< WriteSet > array

印章授权情况返回MODEL

印章授权情况返回模型

Name Description Schema
companyId
*required*
企业账户id
**Example** : "acct1155782836133822465"
string
createTime
*optional*
创建时间
**Example** : "2019-07-22 17:24:07"
string
operateType
*required*
授权操作类型,0=取消授权,1=授权
**Example** : "1"
string
personId
*required*
被授权个人账户id
**Example** : "acct1155782836133822465"
string
sealId
*required*
印章ID
**Example** : "seal51312959317606400"
string
updateTime
*optional*
更新时间
**Example** : "2019-07-22 17:24:07"
string

印章管理通用响应MODEL

印章管理通用响应模型

Name Description Schema
sealId
*required*
sealId
**Example** : "13438954434"
string

印章管理通用请求参数MODEL

印章管理通用请求参数模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
sealId
*required*
印章ID
**Example** : "seal51312959317606400"
string

发送数据签署验证码MODEL

发送数据签署验证码模型

Name Description Schema
resourceId
*required*
资源ID
**Example** : "data1153902852045799424"
string
smsCodeKey
*required*
短信验证码比对密钥
**Example** : "zd3y5b3g"
string
smsType
*required*
短信验证码类型 1=文本 2=语音
**Example** : "1"
string

发送签署验证码请求参数MODEL

发送签署验证码请求参数模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
contractId
*required*
合同ID
**Example** : "ctct1153902852045799424"
string

合同ID做请求参数MODEL

合同ID做请求参数模型

Name Description Schema
contractId
*required*
合同ID
**Example** : "ctct1153902852045799424"
string

合同列表响应MODEL

合同列表响应模型

Name Description Schema
currentPage
*optional*
当前页数
**Example** : "1"
string
dataCount
*optional*
最大记录数
**Example** : "10"
string
list
*required*
合同详情列表 < 合同列表详情MODEL > array
pageSize
*optional*
每页记录数
**Example** : "10"
string

合同列表详情MODEL

合同列表详情模型

Name Description Schema
accountId
*optional*
账户id
**Example** : "acct1155782836133822465"
string
contractId
*optional*
合同ID
**Example** : "ctct1153902852045799424"
string
contractTitle
*optional*
合同名称
**Example** : "XX合同"
string
czId
*optional*
合同存证ID
**Example** : "1153469558326034433"
string
fileHeight
*optional*
合同文件高度
**Example** : 909
integer (int32)
filePage
*optional*
合同页数
**Example** : 10
integer (int32)
filePath
*optional*
文件路径
**Example** : "/path/a.pdf"
string
fileSize
*optional*
合同文件大小
**Example** : 200
integer (int32)
fileWidth
*optional*
合同文件宽度
**Example** : 595
integer (int32)
gmtCreate
*optional*
创建时间
**Example** : "2019-07-22 17:24:07"
string
remark
*optional*
备注
**Example** : "备注"
string
signOffTime
*optional*
合同签署完成时间
**Example** : "2019-07-22 17:24:07"
string
signatureCount
*optional*
签名数量
**Example** : 2
integer (int32)
status
*optional*
合同状态0 待签署,1签署中,2已完成
**Example** : 1
integer (int32)

合同生成响应MODEL

合同生成响应模型

Name Description Schema
contractId
*required*
合同ID
**Example** : "123123123"
string

合同详情MODEL

合同详情模型

Name Description Schema
accountId
*optional*
账户id
**Example** : "acct1155782836133822465"
string
contractId
*optional*
合同ID
**Example** : "ctct1153902852045799424"
string
contractTitle
*optional*
合同名称
**Example** : "XX合同"
string
czId
*optional*
合同存证ID
**Example** : "1153469558326034433"
string
fileHeight
*required*
合同文件高度
**Example** : 909
integer (int32)
filePage
*optional*
合同页数
**Example** : 10
integer (int32)
filePath
*optional*
文件路径
**Example** : "/path/a.pdf"
string
fileSize
*required*
合同文件大小
**Example** : 200
integer (int32)
fileWidth
*required*
合同文件宽度
**Example** : 595
integer (int32)
gmtCreate
*optional*
创建时间
**Example** : "2019-07-22 17:24:07"
string
remark
*optional*
备注
**Example** : "备注"
string
shape
*required*
合同板式:0竖版,1横版
**Example** : 1
integer (int32)
signOffTime
*optional*
合同签署完成时间
**Example** : "2019-07-22 17:24:07"
string
signatureCount
*optional*
签名数量
**Example** : 2
integer (int32)
signers
*required*
当前合同签署者信息,如果当前用户不是合同签署者该值为null < 签署者信息MODEL > array
status
*optional*
合同状态0 待签署,1签署中,2已完成
**Example** : 1
integer (int32)

合并合同请求参数MODEL

合并合同请求参数模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
contractIds
*required*
多个合同ID,用逗号分割
**Example** : "ctct1153902852045799424,ctct1153902852045799423"
string
contractTitle
*required*
合同名称
**Example** : "XX合同"
string
remark
*required*
备注
**Example** : "备注"
string

启动合同流程响应URL参数MODEL

启动合同流程响应URL参数模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
signer
*required*
签署者ID
**Example** : "sgnr51313369172410368"
string
url
*required*
操作完成后返回的URL
**Example** : "http://56.22.68.54/375TSE"
string

存证响应MODEL

存证响应模型

Name Description Schema
czId
*required*
合同存证ID
**Example** : "1153469558326034433"
string

异步认证方式响应MODEL

异步方式返回模型

Name Description Schema
url
*required*
用于认证的url
**Example** : "http://api.hsifue.cn/web/login?orderNo=2149099326188558339&sign=88E9EB76219A4C148A3&from=browser&webankAppId=TIDA4BmI&userId=154502750001&h5faceId=197f1cc4c4af28eab5"
string

异步认证方式请求MODEL

异步认证方式请求模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
idNum
*optional*
身份证号码
**Example** : "430103199904052952"
string
mobile
*optional*
账户手机号码
**Example** : "13912345678"
string
name
*optional*
姓名
**Example** : "张三"
string
returnUrl
*required*
操作完成后返回的URL
**Example** : "http:///114.115.148.211:8900/swagger-ui.html"
string

数据签署响应MODEL

数据签署响应模型

Name Description Schema
resourceId
*required*
资源ID
**Example** : "data1153902852045799424"
string
signData
*required*
签名后数据
**Example** : "uiB0NoZYRx/NsXFQDh3SHXBywZdCHB1ci3CVDQo/xCR1Jf4d8IswcYzw/Z9qGIymq/P60pTc0BI8TuzcqfKQIY5VGALlX4VCBvoHE79lJiY6Xovwz1uDB+sHG1bSk/3NiX1MkUL7fOeOo4DIf+1Z72+BsooLAAAAAElFTkSuQmCC"
string

数据签署意愿表达请求MODEL

数据签署意愿表达请求模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
smsFlag
*required*
是否发送短信验证码 0=不发送 1=发送
**Example** : "0"
string
sourceData
*required*
待签署原数据Base64编码
**Example** : "iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAeKSURBVGhD1Zp1qBVPFMe/79mtYGC3ohjYga34bFFUFBtbEUwQAwwM7EDBwMcTFLG7/rADEzFQVOxnK3br+e33nhn36s97d/cpPv3AsHNmZvfO2TNzZubshZDr10X69BGBIzLFxPzdyfZz4ECR27dDKkBu3RLJmNGt/NdS5swhZWKkXz/B4sUI0aYNUKkS8OmTyn8rqVIBp08DGzeqPGCAo5LVrG3bkIn+KVq00L7HxkqsquRAS/xr1Kih169fEYuYGBWCDifnZjx4ABw7Buzdawr/MLbPjg6uRby4dAkYORIYOxbo2xeoWBEoVQqoWRNo2BD48ME0TCa+ubPx483Ai0BCguspwlP9+iIXL5pGfxj2mX1wdPBvkS5dgKZNgbg4U+Bw4oQOq9KlTUFAODyPHFEPdOAAMHcuMGwYULQokDJlaMigY0fT2APfFgnHrjujR4u0aSNSubJIsWIiJUuKfP1qGvng5UvXspHS2LGm8U8IbBGO/1WrgEGD9C29fq3lFy6oL3/4ELh6Fbh8GYh1Hrlpk9Z7kSkTUK6cEcLgb7Rrp5aaNMkUeuBpEb7hnj3dNzRjhkiFCrpVIJky6fyxLFum7fyyYYPIggUi69e7vzF0qKn0IMwi0RVZt04kLk7z586J5Myp+W7dRLJm1TwV4YRfs0Zk3jyR/Pn1ebVra30QrCJ8Djl8WOTDB83/DF9Da/9+NS+HC3n/Hnj0SPNp0qj5SbVqwL59QK9ewKlTQMGCQIsWQP78wMeP2iYS794Bd+/qfQcPmkKH4cOB1KmBWrWAZs1MoQcRLbJnj77V5s1VzpFD2xFayeY5YadPF7l5U+UgbN6sz4mWfE52f17r9WuRESOM4DBrlkh8vMjJkyK7dukx4O1bUxmQ8E7bVKaMyKJFpkEUAiti4URu0kSkSBGRAgVEUqUSKV8+tGmT7NlFmjYVefXKNPYJ59bKlSL377uKrF5tKj0IrMiwYe6PjBolUry45hMTtX7TJrd++XItSwr2GZcvmwIPwhTxt46wOdm2DZg6FWjeXOWyZYEZM4BWrXT9ID176jUI3PydOWMEB+7nZs4Epk0Dhg7VvVy2bOpEIuHLIjt3apsTJ/Qano4cEbl715X9cvasWpfOJG/e758ZLa1dax7gENgiTZro9eVLYPt2oHFjlfkY7n7XrVN53jy9RmLHDnXbTFWrAkePArlyAR06AKNHAwMHAhMnqjtOTARu3gQOH1ar8xSYOTNw/bp52A/4sgjhQb9cOQmd8du103vSpRM5eFBdJGV6sWhwcevcWV07PWFQnj4VefHCCA5hFgnmteip2NbcHPJUVq5UyTT6gwQeWpYlS4CEBODzZ52gjx/r1jtLFh0SyUkgi0SCq3tykGSLWH4833M7/qvQtdIJzJ9vCoIRTJFr14C6ddVTvXljCn8T3GSSli31GhD/inTqBBQvrrtUuscpU0zFb4LzjoG3DBlMQTC8FdmyRX396tUq584NTJ8OjBun8u+CilgfmASiKzJnDtC6tXsO4daBCxLDQmnTalk4N27oIpYU3r51zzhJILIiPPQwomHhm+L5mQrYt8b4FvdA7EC6dECVKkDhwiozEhKEe/f0wMbVm/C8zliaTyIrwo59+aLzwsKNXe3aumZMmAAsXQo8fw507aqKP3liGjpwQxkE3psiBRAfD9SvD1SuDMyebSq9iT60uKPNk0fzGTNqfJh7H1phzBgtJ1TKUqKEXqtX16sfGKGhR3zxQiM1PGYTvhy/eC6IpUvbKShSr57I6dOmwoFlqVMbwWDb3rtnCn4Cd9OMlDRurIcze49NpUqJbN9uGkchbEH0VsQG444fNwUODAkR+8MfP6q8davKhQqpHIkePdx7f0yNGplGPgi0sjMYt2KFbrs5H7Jndycy84QRD05wu5hNnqzXSHAekCJF9EhgvVXWrO6RICDeipCFC1WZvHl1TeGXLWLDQjwV2s4wZlunjuajwQjl8ePA7t3qWAhfVHhsOQieQyttWtfsBQuKfPliKhwYjGPEgzAiuXSpyIoVKvvFhoRq1HB/h3FkPwQaWtymkwIF9O3ZsznhYypU0Dwt0ru3uuIg9O+vVuZpkcOYm0d6MJZxLfGJtyLdu+tCeP48ULKkKTTws0C+fEZIAuPHA/fvq/sl3Gdt3QqsXau7Ca4lV65onQfeinAl59bErrjhcMHknEgKjANw/WGnGzQwhQaGamltHg/48hiWXb8eePbMNPg//iZ7JBgPDh9q0eBe6vZtDfFwOHKYctiy05HgPo/wgxLb8VMfr+fOabl1MMRzskeD9zGk4wd+PtD3rGnbNlMRBbYJvyc8DRkiMneu5h0dfl2RmjWN4AN6NkZS3rwxBT749EkXXMbPGF5lXMsGzCdO/KbIrw0tcueOyfiAQ4GLZ/r0psAHnIM8cPFU2r69Di1+uiB0NoZYRx/NsXFQDh3SHXBywZdCHB1ci3CVDQo/xCR1Jf4d8IswcYzw/Z9qGIymq/P60pTc0BI8TuzcqfKQIY5VGALlX4VCBvoHE79lJiY6Xovwz1uDB+sHG1bSk/3NiX1MkUL7fOeOo4DIf+1Z72+BsooLAAAAAElFTkSuQmCC"
string

数据签署意愿表达返回MODEL

数据签署意愿表达返回模型

Name Description Schema
resourceId
*required*
资源ID
**Example** : "data1153902852045799424"
string
smsCodeKey
*required*
短信验证码比对密钥
**Example** : "zd3y5b3g"
string

数据签署请求MODEL

数据签署请求模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
sourceData
*required*
待签署原数据Base64编码
**Example** : "iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAeKSURBVGhD1Zp1qBVPFMe/79mtYGC3ohjYga34bFFUFBtbEUwQAwwM7EDBwMcTFLG7/rADEzFQVOxnK3br+e33nhn36s97d/cpPv3AsHNmZvfO2TNzZubshZDr10X69BGBIzLFxPzdyfZz4ECR27dDKkBu3RLJmNGt/NdS5swhZWKkXz/B4sUI0aYNUKkS8OmTyn8rqVIBp08DGzeqPGCAo5LVrG3bkIn+KVq00L7HxkqsquRAS/xr1Kih169fEYuYGBWCDifnZjx4ABw7Buzdawr/MLbPjg6uRby4dAkYORIYOxbo2xeoWBEoVQqoWRNo2BD48ME0TCa+ubPx483Ai0BCguspwlP9+iIXL5pGfxj2mX1wdPBvkS5dgKZNgbg4U+Bw4oQOq9KlTUFAODyPHFEPdOAAMHcuMGwYULQokDJlaMigY0fT2APfFgnHrjujR4u0aSNSubJIsWIiJUuKfP1qGvng5UvXspHS2LGm8U8IbBGO/1WrgEGD9C29fq3lFy6oL3/4ELh6Fbh8GYh1Hrlpk9Z7kSkTUK6cEcLgb7Rrp5aaNMkUeuBpEb7hnj3dNzRjhkiFCrpVIJky6fyxLFum7fyyYYPIggUi69e7vzF0qKn0IMwi0RVZt04kLk7z586J5Myp+W7dRLJm1TwV4YRfs0Zk3jyR/Pn1ebVra30QrCJ8Djl8WOTDB83/DF9Da/9+NS+HC3n/Hnj0SPNp0qj5SbVqwL59QK9ewKlTQMGCQIsWQP78wMeP2iYS794Bd+/qfQcPmkKH4cOB1KmBWrWAZs1MoQcRLbJnj77V5s1VzpFD2xFayeY5YadPF7l5U+UgbN6sz4mWfE52f17r9WuRESOM4DBrlkh8vMjJkyK7dukx4O1bUxmQ8E7bVKaMyKJFpkEUAiti4URu0kSkSBGRAgVEUqUSKV8+tGmT7NlFmjYVefXKNPYJ59bKlSL377uKrF5tKj0IrMiwYe6PjBolUry45hMTtX7TJrd++XItSwr2GZcvmwIPwhTxt46wOdm2DZg6FWjeXOWyZYEZM4BWrXT9ID176jUI3PydOWMEB+7nZs4Epk0Dhg7VvVy2bOpEIuHLIjt3apsTJ/Qano4cEbl715X9cvasWpfOJG/e758ZLa1dax7gENgiTZro9eVLYPt2oHFjlfkY7n7XrVN53jy9RmLHDnXbTFWrAkePArlyAR06AKNHAwMHAhMnqjtOTARu3gQOH1ar8xSYOTNw/bp52A/4sgjhQb9cOQmd8du103vSpRM5eFBdJGV6sWhwcevcWV07PWFQnj4VefHCCA5hFgnmteip2NbcHPJUVq5UyTT6gwQeWpYlS4CEBODzZ52gjx/r1jtLFh0SyUkgi0SCq3tykGSLWH4833M7/qvQtdIJzJ9vCoIRTJFr14C6ddVTvXljCn8T3GSSli31GhD/inTqBBQvrrtUuscpU0zFb4LzjoG3DBlMQTC8FdmyRX396tUq584NTJ8OjBun8u+CilgfmASiKzJnDtC6tXsO4daBCxLDQmnTalk4N27oIpYU3r51zzhJILIiPPQwomHhm+L5mQrYt8b4FvdA7EC6dECVKkDhwiozEhKEe/f0wMbVm/C8zliaTyIrwo59+aLzwsKNXe3aumZMmAAsXQo8fw507aqKP3liGjpwQxkE3psiBRAfD9SvD1SuDMyebSq9iT60uKPNk0fzGTNqfJh7H1phzBgtJ1TKUqKEXqtX16sfGKGhR3zxQiM1PGYTvhy/eC6IpUvbKShSr57I6dOmwoFlqVMbwWDb3rtnCn4Cd9OMlDRurIcze49NpUqJbN9uGkchbEH0VsQG444fNwUODAkR+8MfP6q8davKhQqpHIkePdx7f0yNGplGPgi0sjMYt2KFbrs5H7Jndycy84QRD05wu5hNnqzXSHAekCJF9EhgvVXWrO6RICDeipCFC1WZvHl1TeGXLWLDQjwV2s4wZlunjuajwQjl8ePA7t3qWAhfVHhsOQieQyttWtfsBQuKfPliKhwYjGPEgzAiuXSpyIoVKvvFhoRq1HB/h3FkPwQaWtymkwIF9O3ZsznhYypU0Dwt0ru3uuIg9O+vVuZpkcOYm0d6MJZxLfGJtyLdu+tCeP48ULKkKTTws0C+fEZIAuPHA/fvq/sl3Gdt3QqsXau7Ca4lV65onQfeinAl59bErrjhcMHknEgKjANw/WGnGzQwhQaGamltHg/48hiWXb8eePbMNPg//iZ7JBgPDh9q0eBe6vZtDfFwOHKYctiy05HgPo/wgxLb8VMfr+fOabl1MMRzskeD9zGk4wd+PtD3rGnbNlMRBbYJvyc8DRkiMneu5h0dfl2RmjWN4AN6NkZS3rwxBT749EkXXMbPGF5lXMsGzCdO/KbIrw0tcueOyfiAQ4GLZ/r0psAHnIM8cPFU2r69Di1+uiB0NoZYRx/NsXFQDh3SHXBywZdCHB1ci3CVDQo/xCR1Jf4d8IswcYzw/Z9qGIymq/P60pTc0BI8TuzcqfKQIY5VGALlX4VCBvoHE79lJiY6Xovwz1uDB+sHG1bSk/3NiX1MkUL7fOeOo4DIf+1Z72+BsooLAAAAAElFTkSuQmCC"
string

数据签署验签接口响应MODEL

数据签署验签接口响应模型

Name Description Schema
issuer
*optional*
签署证书颁发者
**Example** : "CN=CFCA ACS TEST OCA33, O=China Financial Certification Authority, C=CN"
string
result
*required*
验证结果
**Example** : true
boolean
serialNumber
*optional*
签署证书序列号
**Example** : "3300000002747006"
string
sourceData
*required*
待签名验证数据
**Example** : "1243"
string
subject
*optional*
签署证书拥有者
**Example** : "CN=051@小看@0110101199003077619@1, OU=Individual-1, OU=BestSign, O=BestSign, C=CN"
string
validityBegin
*optional*
签署证书起始时间
**Example** : "2019-07-02 10:41:02"
string
validityEnd
*optional*
签署证书失效时间
**Example** : "2024-07-02 10:41:02"
string

数据签署验证请求MODEL

数据签署验证请求模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
signData
*required*
签名后数据
**Example** : "uiB0NoZYRx/NsXFQDh3SHXBywZdCHB1ci3CVDQo/xCR1Jf4d8IswcYzw/Z9qGIymq/P60pTc0BI8TuzcqfKQIY5VGALlX4VCBvoHE79lJiY6Xovwz1uDB+sHG1bSk/3NiX1MkUL7fOeOo4DIf+1Z72+BsooLAAAAAElFTkSuQmCC"
string
sourceData
*required*
待签署原数据Base64编码
**Example** : "iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAeKSURBVGhD1Zp1qBVPFMe/79mtYGC3ohjYga34bFFUFBtbEUwQAwwM7EDBwMcTFLG7/rADEzFQVOxnK3br+e33nhn36s97d/cpPv3AsHNmZvfO2TNzZubshZDr10X69BGBIzLFxPzdyfZz4ECR27dDKkBu3RLJmNGt/NdS5swhZWKkXz/B4sUI0aYNUKkS8OmTyn8rqVIBp08DGzeqPGCAo5LVrG3bkIn+KVq00L7HxkqsquRAS/xr1Kih169fEYuYGBWCDifnZjx4ABw7Buzdawr/MLbPjg6uRby4dAkYORIYOxbo2xeoWBEoVQqoWRNo2BD48ME0TCa+ubPx483Ai0BCguspwlP9+iIXL5pGfxj2mX1wdPBvkS5dgKZNgbg4U+Bw4oQOq9KlTUFAODyPHFEPdOAAMHcuMGwYULQokDJlaMigY0fT2APfFgnHrjujR4u0aSNSubJIsWIiJUuKfP1qGvng5UvXspHS2LGm8U8IbBGO/1WrgEGD9C29fq3lFy6oL3/4ELh6Fbh8GYh1Hrlpk9Z7kSkTUK6cEcLgb7Rrp5aaNMkUeuBpEb7hnj3dNzRjhkiFCrpVIJky6fyxLFum7fyyYYPIggUi69e7vzF0qKn0IMwi0RVZt04kLk7z586J5Myp+W7dRLJm1TwV4YRfs0Zk3jyR/Pn1ebVra30QrCJ8Djl8WOTDB83/DF9Da/9+NS+HC3n/Hnj0SPNp0qj5SbVqwL59QK9ewKlTQMGCQIsWQP78wMeP2iYS794Bd+/qfQcPmkKH4cOB1KmBWrWAZs1MoQcRLbJnj77V5s1VzpFD2xFayeY5YadPF7l5U+UgbN6sz4mWfE52f17r9WuRESOM4DBrlkh8vMjJkyK7dukx4O1bUxmQ8E7bVKaMyKJFpkEUAiti4URu0kSkSBGRAgVEUqUSKV8+tGmT7NlFmjYVefXKNPYJ59bKlSL377uKrF5tKj0IrMiwYe6PjBolUry45hMTtX7TJrd++XItSwr2GZcvmwIPwhTxt46wOdm2DZg6FWjeXOWyZYEZM4BWrXT9ID176jUI3PydOWMEB+7nZs4Epk0Dhg7VvVy2bOpEIuHLIjt3apsTJ/Qano4cEbl715X9cvasWpfOJG/e758ZLa1dax7gENgiTZro9eVLYPt2oHFjlfkY7n7XrVN53jy9RmLHDnXbTFWrAkePArlyAR06AKNHAwMHAhMnqjtOTARu3gQOH1ar8xSYOTNw/bp52A/4sgjhQb9cOQmd8du103vSpRM5eFBdJGV6sWhwcevcWV07PWFQnj4VefHCCA5hFgnmteip2NbcHPJUVq5UyTT6gwQeWpYlS4CEBODzZ52gjx/r1jtLFh0SyUkgi0SCq3tykGSLWH4833M7/qvQtdIJzJ9vCoIRTJFr14C6ddVTvXljCn8T3GSSli31GhD/inTqBBQvrrtUuscpU0zFb4LzjoG3DBlMQTC8FdmyRX396tUq584NTJ8OjBun8u+CilgfmASiKzJnDtC6tXsO4daBCxLDQmnTalk4N27oIpYU3r51zzhJILIiPPQwomHhm+L5mQrYt8b4FvdA7EC6dECVKkDhwiozEhKEe/f0wMbVm/C8zliaTyIrwo59+aLzwsKNXe3aumZMmAAsXQo8fw507aqKP3liGjpwQxkE3psiBRAfD9SvD1SuDMyebSq9iT60uKPNk0fzGTNqfJh7H1phzBgtJ1TKUqKEXqtX16sfGKGhR3zxQiM1PGYTvhy/eC6IpUvbKShSr57I6dOmwoFlqVMbwWDb3rtnCn4Cd9OMlDRurIcze49NpUqJbN9uGkchbEH0VsQG444fNwUODAkR+8MfP6q8davKhQqpHIkePdx7f0yNGplGPgi0sjMYt2KFbrs5H7Jndycy84QRD05wu5hNnqzXSHAekCJF9EhgvVXWrO6RICDeipCFC1WZvHl1TeGXLWLDQjwV2s4wZlunjuajwQjl8ePA7t3qWAhfVHhsOQieQyttWtfsBQuKfPliKhwYjGPEgzAiuXSpyIoVKvvFhoRq1HB/h3FkPwQaWtymkwIF9O3ZsznhYypU0Dwt0ru3uuIg9O+vVuZpkcOYm0d6MJZxLfGJtyLdu+tCeP48ULKkKTTws0C+fEZIAuPHA/fvq/sl3Gdt3QqsXau7Ca4lV65onQfeinAl59bErrjhcMHknEgKjANw/WGnGzQwhQaGamltHg/48hiWXb8eePbMNPg//iZ7JBgPDh9q0eBe6vZtDfFwOHKYctiy05HgPo/wgxLb8VMfr+fOabl1MMRzskeD9zGk4wd+PtD3rGnbNlMRBbYJvyc8DRkiMneu5h0dfl2RmjWN4AN6NkZS3rwxBT749EkXXMbPGF5lXMsGzCdO/KbIrw0tcueOyfiAQ4GLZ/r0psAHnIM8cPFU2r69Di1+uiB0NoZYRx/NsXFQDh3SHXBywZdCHB1ci3CVDQo/xCR1Jf4d8IswcYzw/Z9qGIymq/P60pTc0BI8TuzcqfKQIY5VGALlX4VCBvoHE79lJiY6Xovwz1uDB+sHG1bSk/3NiX1MkUL7fOeOo4DIf+1Z72+BsooLAAAAAElFTkSuQmCC"
string

查看签署者MODEL

查看签署者模型

Name Description Schema
account
*required*
账户:有效手机号、邮箱或账号ID
**Example** : "acct54875801392250880"
string
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
accountName
*required*
账户名称
**Example** : "王大雷"
string
accountType
*required*
企业/个人 0个人,1企业
**Example** : "1"
string
positionContent
*required*
对应定位方式的内容,关键字定位则为6-32个关键字;如果用签署坐标定位,则该参数可为空或包含三个信息:“页面,x轴坐标,y轴坐标”(如20,30,49)
**Example** : "20,30,49"
string
signForm
*required*
签署形态,0=静默签署,1=页面签署
**Example** : "1"
string
signPositionType
*required*
签署的定位方式:0=关键字定位,1=签署坐标
**Example** : "1"
string
signTime
*optional*
合同签署时间
**Example** : "2019-07-22 17:24:07"
string
status
*optional*
签署状态 0待签署,1待校验,2已完成
**Example** : "1"
string

查询上传合同文件列表返回MODEL

查询上传合同文件列表返回模型

Name Description Schema
currentPage
*required*
当前页数
**Example** : "1"
string
dataCount
*required*
最大记录数
**Example** : "10"
string
list
*optional*
印章列表 < 上传合同文件返回MODEL > array
pageSize
*required*
每页记录数
**Example** : "10"
string

查询个人用户信息响应MODEL

查询个人用户信息响应模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
certId
*required*
数字证书ID
**Example** : "cert3456783650364543"
string
createTime
*required*
创建时间
**Example** : "2019-07-22 17:24:07"
string
email
*required*
E-mail
**Example** : "123456@qq.com"
string
idNum
*required*
身份证号码
**Example** : "430103199904052952"
string
identifyMobile
*required*
实名认证手机号码
**Example** : "13912345678"
string
identifyStatus
*required*
是否实名认证,0=非实名认证,1=实名认证
**Example** : false
boolean
mobile
*required*
账户手机号码
**Example** : "13912345678"
string
name
*required*
姓名
**Example** : "张三"
string
nation
*required*
国籍与地址
**Example** : "南京路一号"
string
updateTime
*required*
更新时间
**Example** : "2019-07-22 17:24:07"
string

查询个人用户信息请求MODEL

查询个人用户信息请求模型

Name Description Schema
account
*required*
账户:有效手机号、邮箱或账号ID
**Example** : "acct54875801392250880"
string

查询企业用户信息响应MODEL

查询企业用户信息响应模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
certId
*required*
数字证书ID
**Example** : "cert3456783650364543"
string
companyPrincipalType
*required*
企业负责人身份:1=法人,2=代理人
**Example** : "1"
string
createTime
*required*
创建时间
**Example** : "2019-07-22 17:24:07"
string
email
*required*
E-mail
**Example** : "123456@qq.com"
string
idNum
*required*
企业统一社会信用代码
**Example** : "12100000400000624D"
string
identifyStatus
*required*
是否实名认证,0=非实名认证,1=实名认证
**Example** : false
boolean
legalPersonId
*required*
法人/代理人证件号码,目前只支持身份证
**Example** : "430103199904052952"
string
legalPersonMobile
*required*
法人/代理人手机号
**Example** : "13912345678"
string
legalPersonName
*required*
法人/代理人姓名
**Example** : "张三"
string
mobile
*required*
账户手机号码
**Example** : "13912345678"
string
name
*required*
企业名称
**Example** : "中国电信集团北京公司"
string
updateTime
*required*
更新时间
**Example** : "2019-07-22 17:24:07"
string

查询企业用户信息请求MODEL

查询企业用户信息请求模型

Name Description Schema
account
*required*
账户:有效手机号、邮箱或账号ID
**Example** : "acct54875801392250880"
string

查询印章列表返回MODEL

查询印章列表返回模型

Name Description Schema
currentPage
*required*
当前页数
**Example** : "1"
string
dataCount
*required*
最大记录数
**Example** : "10"
string
list
*optional*
印章列表 < 列表印章返回MODEL > array
pageSize
*required*
每页记录数
**Example** : "10"
string

查询授权印章列表返回MODEL

查询授权印章列表返回模型

Name Description Schema
currentPage
*required*
当前页数
**Example** : "1"
string
dataCount
*required*
最大记录数
**Example** : "10"
string
list
*optional*
印章列表 < 印章授权情况返回MODEL > array
pageSize
*required*
每页记录数
**Example** : "10"
string

查询证书信息响应MODEL

查询证书信息响应模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
certId
*required*
证书标识
**Example** : "CFCA-33-20171010142326279-12345"
string
endTime
*optional*
string
issuerDN
*optional*
string
serialNumber
*optional*
string
startTime
*optional*
string
status
*optional*
string
subjectDN
*optional*
string

查询证书信息请求MODEL

查询证书信息请求模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string

校验签署验证码请求参数MODEL

校验签署验证码请求参数模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
contractId
*required*
合同ID
**Example** : "ctct1153902852045799424"
string
verificationCode
*required*
短信验证码
**Example** : "1234"
string

检查签署者子MODEL

检查签署者子模型

Name Description Schema
account
*required*
账户:有效手机号、邮箱或账号ID
**Example** : "acct54875801392250880"
string
accountType
*required*
企业/个人 0个人,1企业
**Example** : "1"
string

检查签署者请求MODEL

检查签署者请求模型

Name Description Schema
signers
*required*
签署人信息 < 检查签署者子MODEL > array

添加签署者请求MODEL

签署者请求模型

Name Description Schema
contractId
*required*
合同ID
**Example** : "ctct1153902852045799424"
string
signers
*required*
签署者列表 < 签署者MODEL > array

添加签署者返回MODEL

签署者返回模型

Name Description Schema
contractId
*required*
合同ID
**Example** : "ctct1153902852045799424"
string
signers
*required*
签署者列表 < 签署者返回MODEL > array

生成合同填充模板信息MODEL

生成合同填充模板信息模型

Name Description Schema
fontType
*optional*
字体类型: 1=仿宋;2=黑体;3=楷体;1:微软雅黑。不传则按照默认字体仿宋。
**Example** : "1"
string
fontsize
*optional*
字体大小:若不传入字体大小,则按照默认大小
**Example** : "12"
string
nametovalues
*required*
Json格式的待填充字段key-value
**Example** : ""
string
pdfPTableReqs
*optional*
签署者列表 < 生成合同表头信息与表格内容数据MODEL > array

生成合同表头信息与表格内容数据MODEL

表头信息与表格内容数据模型

Name Description Schema
borderFlag
*optional*
是否需要显示边框:1=需要边框 0=不需要边框
**Example** : "0"
string
cellHeight
*optional*
table中每个单元格的高度(每一个单元格高度一致)
**Example** : "16"
string
cellHorizontalAlignment
*optional*
水平对齐方式:0=居左;1=居中;2=居右,默认为 0
**Example** : "0"
string
cellVerticalAlignment
*optional*
垂直对齐方式:4=居左;5=居中;6=居右,默认为 4
**Example** : "4"
string
colWidthPercent
*optional*
表格宽度的比例(每列表格宽度的百分比)List
**Example** : [ "30", "20", "50" ]
< string > array
dataFont
*optional*
表的内容数据字体样式 注:dataFont的size不可大于cellHeight,否则无法显示内容 生成合同表格字体样式MODEL
datas
*optional*
表的内容数据List<List>
**Example** : [ [ "序号1", "名称1", "成绩1" ], [ "序号2", "名称2", "成绩2" ] ]
< < string > array > array
headers
*optional*
表头信息List
**Example** : [ "序号", "名称", "成绩" ]
< string > array
headersFont
*optional*
表头字体样式 生成合同表格字体样式MODEL
insertWay
*required*
表格table添加方式:0=新建页面添加table(默认)1=在某个关键字后添加table
**Example** : "0"
string
keyword
*optional*
表格插入关键字下方insertWay=1,不能为空
**Example** : "keyword"
string
pageBegin
*optional*
从第几页开始insertWay=0,不能为空
**Example** : "1"
string
theFirstHeader
*optional*
表头信息上方的一级标题
**Example** : "表头信息上方的一级标题"
string
theFirstHeaderFont
*optional*
一级标题字体样式 生成合同表格字体样式MODEL

生成合同表格字体样式MODEL

生成合同表格字体样式模型

Name Description Schema
size
*optional*
字体大小:若不传入字体大小,则按照默认大小
**Example** : "12"
string
style
*optional*
表格字体样式,默认值为0:0=正常;1=加粗2=斜体;4=下划线;
**Example** : "1"
string

生成合同请求参数MODEL

生成合同请求参数模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
contractTitle
*required*
合同名称
**Example** : "XX合同"
string
fileId
*required*
文件ID
**Example** : "file1153469558326034432"
string
remark
*required*
备注
**Example** : "备注"
string
templateInfoModel
*optional*
合同模板填充信息 生成合同填充模板信息MODEL

申请证书响应MODEL

申请证书响应模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
certId
*required*
数字证书ID
**Example** : "cert3456783650364543"
string

签署人列表响应MODEL

签署人列表响应模型

Name Description Schema
currentPage
*optional*
当前页数
**Example** : "1"
string
dataCount
*optional*
最大记录数
**Example** : "10"
string
list
*required*
合同详情列表 < 查看签署者MODEL > array
pageSize
*optional*
每页记录数
**Example** : "10"
string

签署列表管理响应MODEL

签署列表管理响应模型

Name Description Schema
currentPage
*optional*
当前页数
**Example** : "1"
string
dataCount
*optional*
最大记录数
**Example** : "10"
string
list
*required*
合同详情列表 < 签署管理列表响应MODEL > array
pageSize
*optional*
每页记录数
**Example** : "10"
string

签署管理列表响应MODEL

签署管理列表模型

Name Description Schema
account
*optional*
账户:有效手机号、邮箱或账号ID
**Example** : "acct54875801392250880"
string
accountId
*optional*
账户id
**Example** : "acct1155782836133822465"
string
accountName
*optional*
账户名称
**Example** : "王大雷"
string
accountType
*optional*
企业/个人 0个人,1企业
**Example** : 1
integer (int32)
contractId
*optional*
合同ID
**Example** : "ctct1153902852045799424"
string
contractTitle
*optional*
合同名称
**Example** : "XX合同"
string
fileHeight
*optional*
合同文件高度
**Example** : 909
integer (int32)
filePage
*optional*
当前页数
**Example** : 1
integer (int32)
filePath
*optional*
文件路径
**Example** : "/path/a.pdf"
string
fileSize
*optional*
合同文件大小
**Example** : 200
integer (int32)
fileWidth
*optional*
合同文件宽度
**Example** : 595
integer (int32)
gmtCreate
*optional*
创建时间
**Example** : "2019-07-22 17:24:07"
string
positionContent
*optional*
对应定位方式的内容,关键字定位则为6-32个关键字;如果用签署坐标定位,则该参数可为空或包含三个信息:“页面,x轴坐标,y轴坐标”(如20,30,49)
**Example** : "20,30,49"
string
remark
*optional*
合同签署备注
**Example** : "备注"
string
signForm
*optional*
签署形态,0=静默签署,1=页面签署
**Example** : "1"
string
signPositionType
*optional*
签署的定位方式:0=关键字定位,1=签署坐标
**Example** : "1"
string
signTime
*optional*
合同签署时间
**Example** : "2019-07-22 17:24:07"
string
signerId
*optional*
签署者ID
**Example** : "sgnr51313369172410368"
string
status
*optional*
合同状态0 待签署,1签署中,2已完成
**Example** : 1
integer (int32)

签署者MODEL

签署者模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
positionContent
*required*
对应定位方式的内容,关键字定位则为6-32个关键字;如果用签署坐标定位,则该参数可为空或包含三个信息:“页面,x轴坐标,y轴坐标”(如20,30,49)
**Example** : "20,30,49"
string
signForm
*required*
签署形态,0=静默签署,1=页面签署
**Example** : "1"
string
signPositionType
*required*
签署的定位方式:0=关键字定位,1=签署坐标
**Example** : "1"
string

签署者信息MODEL

签署者信息模型

Name Description Schema
account
*optional*
账户:有效手机号、邮箱或账号ID
**Example** : "acct54875801392250880"
string
accountId
*optional*
账户id
**Example** : "acct1155782836133822465"
string
accountName
*optional*
账户名称
**Example** : "王大雷"
string
accountType
*required*
企业/个人 0个人,1企业
**Example** : "1"
string
positionContent
*required*
对应定位方式的内容,关键字定位则为6-32个关键字;如果用签署坐标定位,则该参数可为空或包含三个信息:“页面,x轴坐标,y轴坐标”(如20,30,49)
**Example** : "20,30,49"
string
signForm
*optional*
签署形态,0=静默签署,1=页面签署
**Example** : "1"
string
signPositionType
*required*
签署的定位方式:0=关键字定位,1=签署坐标
**Example** : "1"
string
signTime
*optional*
合同签署时间
**Example** : "2019-07-22 17:24:07"
string
status
*optional*
签署状态 0待签署,1待校验,2已完成
**Example** : "1"
string

签署者返回MODEL

签署者返回模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
signerId
*required*
签署者ID
**Example** : "sgnr51313369172410368"
string

统一结果返回MODEL

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) object
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«JSONObject»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) < string, object > map
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«string»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) string
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«上传文件响应MODEl»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 上传文件响应MODEl
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«创建个人账户响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 创建个人账户响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«创建企业账户响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 创建企业账户响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«区块链交易信息»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 区块链交易信息
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«印章管理通用响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 印章管理通用响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«合同列表响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 合同列表响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«合同生成响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 合同生成响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«合同详情MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 合同详情MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«启动合同流程响应URL参数MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 启动合同流程响应URL参数MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«存证响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 存证响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«异步认证方式响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 异步认证方式响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«数据签署响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 数据签署响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«数据签署意愿表达返回MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 数据签署意愿表达返回MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«数据签署验签接口响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 数据签署验签接口响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«查询上传合同文件列表返回MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 查询上传合同文件列表返回MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«查询个人用户信息响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 查询个人用户信息响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«查询企业用户信息响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 查询企业用户信息响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«查询印章列表返回MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 查询印章列表返回MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«查询授权印章列表返回MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 查询授权印章列表返回MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«查询证书信息响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 查询证书信息响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«添加签署者返回MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 添加签署者返回MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«申请证书响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 申请证书响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«签署人列表响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 签署人列表响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«签署列表管理响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 签署列表管理响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«自定义印章响应MODEL»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 自定义印章响应MODEL
message
*required*
返回说明信息
**Example** : "成功"
string

统一结果返回MODEL«通用存证响应»

统一返回数据格式

Name Description Schema
code
*required*
返回编码
**Example** : "10000"
string
data
*optional*
返回数据,默认为空(null) 通用存证响应
message
*required*
返回说明信息
**Example** : "成功"
string

自定义印章响应MODEL

自定义印章响应模型

Name Description Schema
imageData
*required*
图片经Base64编码
**Example** : "iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAeKSURBVGhD1Zp1qBVPFMe/79mtYGC3ohjYga34bFFUFBtbEUwQAwwM7EDBwMcTFLG7/rADEzFQVOxnK3br+e33nhn36s97d/cpPv3AsHNmZvfO2TNzZubshZDr10X69BGBIzLFxPzdyfZz4ECR27dDKkBu3RLJmNGt/NdS5swhZWKkXz/B4sUI0aYNUKkS8OmTyn8rqVIBp08DGzeqPGCAo5LVrG3bkIn+KVq00L7HxkqsquRAS/xr1Kih169fEYuYGBWCDifnZjx4ABw7Buzdawr/MLbPjg6uRby4dAkYORIYOxbo2xeoWBEoVQqoWRNo2BD48ME0TCa+ubPx483Ai0BCguspwlP9+iIXL5pGfxj2mX1wdPBvkS5dgKZNgbg4U+Bw4oQOq9KlTUFAODyPHFEPdOAAMHcuMGwYULQokDJlaMigY0fT2APfFgnHrjujR4u0aSNSubJIsWIiJUuKfP1qGvng5UvXspHS2LGm8U8IbBGO/1WrgEGD9C29fq3lFy6oL3/4ELh6Fbh8GYh1Hrlpk9Z7kSkTUK6cEcLgb7Rrp5aaNMkUeuBpEb7hnj3dNzRjhkiFCrpVIJky6fyxLFum7fyyYYPIggUi69e7vzF0qKn0IMwi0RVZt04kLk7z586J5Myp+W7dRLJm1TwV4YRfs0Zk3jyR/Pn1ebVra30QrCJ8Djl8WOTDB83/DF9Da/9+NS+HC3n/Hnj0SPNp0qj5SbVqwL59QK9ewKlTQMGCQIsWQP78wMeP2iYS794Bd+/qfQcPmkKH4cOB1KmBWrWAZs1MoQcRLbJnj77V5s1VzpFD2xFayeY5YadPF7l5U+UgbN6sz4mWfE52f17r9WuRESOM4DBrlkh8vMjJkyK7dukx4O1bUxmQ8E7bVKaMyKJFpkEUAiti4URu0kSkSBGRAgVEUqUSKV8+tGmT7NlFmjYVefXKNPYJ59bKlSL377uKrF5tKj0IrMiwYe6PjBolUry45hMTtX7TJrd++XItSwr2GZcvmwIPwhTxt46wOdm2DZg6FWjeXOWyZYEZM4BWrXT9ID176jUI3PydOWMEB+7nZs4Epk0Dhg7VvVy2bOpEIuHLIjt3apsTJ/Qano4cEbl715X9cvasWpfOJG/e758ZLa1dax7gENgiTZro9eVLYPt2oHFjlfkY7n7XrVN53jy9RmLHDnXbTFWrAkePArlyAR06AKNHAwMHAhMnqjtOTARu3gQOH1ar8xSYOTNw/bp52A/4sgjhQb9cOQmd8du103vSpRM5eFBdJGV6sWhwcevcWV07PWFQnj4VefHCCA5hFgnmteip2NbcHPJUVq5UyTT6gwQeWpYlS4CEBODzZ52gjx/r1jtLFh0SyUkgi0SCq3tykGSLWH4833M7/qvQtdIJzJ9vCoIRTJFr14C6ddVTvXljCn8T3GSSli31GhD/inTqBBQvrrtUuscpU0zFb4LzjoG3DBlMQTC8FdmyRX396tUq584NTJ8OjBun8u+CilgfmASiKzJnDtC6tXsO4daBCxLDQmnTalk4N27oIpYU3r51zzhJILIiPPQwomHhm+L5mQrYt8b4FvdA7EC6dECVKkDhwiozEhKEe/f0wMbVm/C8zliaTyIrwo59+aLzwsKNXe3aumZMmAAsXQo8fw507aqKP3liGjpwQxkE3psiBRAfD9SvD1SuDMyebSq9iT60uKPNk0fzGTNqfJh7H1phzBgtJ1TKUqKEXqtX16sfGKGhR3zxQiM1PGYTvhy/eC6IpUvbKShSr57I6dOmwoFlqVMbwWDb3rtnCn4Cd9OMlDRurIcze49NpUqJbN9uGkchbEH0VsQG444fNwUODAkR+8MfP6q8davKhQqpHIkePdx7f0yNGplGPgi0sjMYt2KFbrs5H7Jndycy84QRD05wu5hNnqzXSHAekCJF9EhgvVXWrO6RICDeipCFC1WZvHl1TeGXLWLDQjwV2s4wZlunjuajwQjl8ePA7t3qWAhfVHhsOQieQyttWtfsBQuKfPliKhwYjGPEgzAiuXSpyIoVKvvFhoRq1HB/h3FkPwQaWtymkwIF9O3ZsznhYypU0Dwt0ru3uuIg9O+vVuZpkcOYm0d6MJZxLfGJtyLdu+tCeP48ULKkKTTws0C+fEZIAuPHA/fvq/sl3Gdt3QqsXau7Ca4lV65onQfeinAl59bErrjhcMHknEgKjANw/WGnGzQwhQaGamltHg/48hiWXb8eePbMNPg//iZ7JBgPDh9q0eBe6vZtDfFwOHKYctiy05HgPo/wgxLb8VMfr+fOabl1MMRzskeD9zGk4wd+PtD3rGnbNlMRBbYJvyc8DRkiMneu5h0dfl2RmjWN4AN6NkZS3rwxBT749EkXXMbPGF5lXMsGzCdO/KbIrw0tcueOyfiAQ4GLZ/r0psAHnIM8cPFU2r69Di1+uiB0NoZYRx/NsXFQDh3SHXBywZdCHB1ci3CVDQo/xCR1Jf4d8IswcYzw/Z9qGIymq/P60pTc0BI8TuzcqfKQIY5VGALlX4VCBvoHE79lJiY6Xovwz1uDB+sHG1bSk/3NiX1MkUL7fOeOo4DIf+1Z72+BsooLAAAAAElFTkSuQmCC"
string

自定义印章请求参数MODEL

自定义印章请求参数模型

Name Description Schema
accountId
*required*
账户id
**Example** : "acct1155782836133822465"
string
imageData
*required*
图片经Base64编码
**Example** : "iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAeKSURBVGhD1Zp1qBVPFMe/79mtYGC3ohjYga34bFFUFBtbEUwQAwwM7EDBwMcTFLG7/rADEzFQVOxnK3br+e33nhn36s97d/cpPv3AsHNmZvfO2TNzZubshZDr10X69BGBIzLFxPzdyfZz4ECR27dDKkBu3RLJmNGt/NdS5swhZWKkXz/B4sUI0aYNUKkS8OmTyn8rqVIBp08DGzeqPGCAo5LVrG3bkIn+KVq00L7HxkqsquRAS/xr1Kih169fEYuYGBWCDifnZjx4ABw7Buzdawr/MLbPjg6uRby4dAkYORIYOxbo2xeoWBEoVQqoWRNo2BD48ME0TCa+ubPx483Ai0BCguspwlP9+iIXL5pGfxj2mX1wdPBvkS5dgKZNgbg4U+Bw4oQOq9KlTUFAODyPHFEPdOAAMHcuMGwYULQokDJlaMigY0fT2APfFgnHrjujR4u0aSNSubJIsWIiJUuKfP1qGvng5UvXspHS2LGm8U8IbBGO/1WrgEGD9C29fq3lFy6oL3/4ELh6Fbh8GYh1Hrlpk9Z7kSkTUK6cEcLgb7Rrp5aaNMkUeuBpEb7hnj3dNzRjhkiFCrpVIJky6fyxLFum7fyyYYPIggUi69e7vzF0qKn0IMwi0RVZt04kLk7z586J5Myp+W7dRLJm1TwV4YRfs0Zk3jyR/Pn1ebVra30QrCJ8Djl8WOTDB83/DF9Da/9+NS+HC3n/Hnj0SPNp0qj5SbVqwL59QK9ewKlTQMGCQIsWQP78wMeP2iYS794Bd+/qfQcPmkKH4cOB1KmBWrWAZs1MoQcRLbJnj77V5s1VzpFD2xFayeY5YadPF7l5U+UgbN6sz4mWfE52f17r9WuRESOM4DBrlkh8vMjJkyK7dukx4O1bUxmQ8E7bVKaMyKJFpkEUAiti4URu0kSkSBGRAgVEUqUSKV8+tGmT7NlFmjYVefXKNPYJ59bKlSL377uKrF5tKj0IrMiwYe6PjBolUry45hMTtX7TJrd++XItSwr2GZcvmwIPwhTxt46wOdm2DZg6FWjeXOWyZYEZM4BWrXT9ID176jUI3PydOWMEB+7nZs4Epk0Dhg7VvVy2bOpEIuHLIjt3apsTJ/Qano4cEbl715X9cvasWpfOJG/e758ZLa1dax7gENgiTZro9eVLYPt2oHFjlfkY7n7XrVN53jy9RmLHDnXbTFWrAkePArlyAR06AKNHAwMHAhMnqjtOTARu3gQOH1ar8xSYOTNw/bp52A/4sgjhQb9cOQmd8du103vSpRM5eFBdJGV6sWhwcevcWV07PWFQnj4VefHCCA5hFgnmteip2NbcHPJUVq5UyTT6gwQeWpYlS4CEBODzZ52gjx/r1jtLFh0SyUkgi0SCq3tykGSLWH4833M7/qvQtdIJzJ9vCoIRTJFr14C6ddVTvXljCn8T3GSSli31GhD/inTqBBQvrrtUuscpU0zFb4LzjoG3DBlMQTC8FdmyRX396tUq584NTJ8OjBun8u+CilgfmASiKzJnDtC6tXsO4daBCxLDQmnTalk4N27oIpYU3r51zzhJILIiPPQwomHhm+L5mQrYt8b4FvdA7EC6dECVKkDhwiozEhKEe/f0wMbVm/C8zliaTyIrwo59+aLzwsKNXe3aumZMmAAsXQo8fw507aqKP3liGjpwQxkE3psiBRAfD9SvD1SuDMyebSq9iT60uKPNk0fzGTNqfJh7H1phzBgtJ1TKUqKEXqtX16sfGKGhR3zxQiM1PGYTvhy/eC6IpUvbKShSr57I6dOmwoFlqVMbwWDb3rtnCn4Cd9OMlDRurIcze49NpUqJbN9uGkchbEH0VsQG444fNwUODAkR+8MfP6q8davKhQqpHIkePdx7f0yNGplGPgi0sjMYt2KFbrs5H7Jndycy84QRD05wu5hNnqzXSHAekCJF9EhgvVXWrO6RICDeipCFC1WZvHl1TeGXLWLDQjwV2s4wZlunjuajwQjl8ePA7t3qWAhfVHhsOQieQyttWtfsBQuKfPliKhwYjGPEgzAiuXSpyIoVKvvFhoRq1HB/h3FkPwQaWtymkwIF9O3ZsznhYypU0Dwt0ru3uuIg9O+vVuZpkcOYm0d6MJZxLfGJtyLdu+tCeP48ULKkKTTws0C+fEZIAuPHA/fvq/sl3Gdt3QqsXau7Ca4lV65onQfeinAl59bErrjhcMHknEgKjANw/WGnGzQwhQaGamltHg/48hiWXb8eePbMNPg//iZ7JBgPDh9q0eBe6vZtDfFwOHKYctiy05HgPo/wgxLb8VMfr+fOabl1MMRzskeD9zGk4wd+PtD3rGnbNlMRBbYJvyc8DRkiMneu5h0dfl2RmjWN4AN6NkZS3rwxBT749EkXXMbPGF5lXMsGzCdO/KbIrw0tcueOyfiAQ4GLZ/r0psAHnIM8cPFU2r69Di1+uiB0NoZYRx/NsXFQDh3SHXBywZdCHB1ci3CVDQo/xCR1Jf4d8IswcYzw/Z9qGIymq/P60pTc0BI8TuzcqfKQIY5VGALlX4VCBvoHE79lJiY6Xovwz1uDB+sHG1bSk/3NiX1MkUL7fOeOo4DIf+1Z72+BsooLAAAAAElFTkSuQmCC"
string
remark
*required*
备注
**Example** : "备注"
string

获取手动签署请求参数MODEL

获取手动签署请求参数模型

Name Description Schema
personId
*optional*
被授权个人账户id
**Example** : "acct1155782836133822465"
string
remark
*required*
备注
**Example** : "备注"
string
returnUrl
*required*
操作完成后返回的URL
**Example** : "http:///114.115.148.211:8900/swagger-ui.html"
string
sealId
*required*
印章ID,可以为空字符串,为空字符串表示默认印章
**Example** : "seal51312959317606400"
string
signerId
*required*
签署者ID
**Example** : "sgnr51313369172410368"
string

获取数据签署验证码MODEL

获取数据签署验证码模型

Name Description Schema
resourceId
*required*
资源ID
**Example** : "data1153902852045799424"
string
smsCode
*required*
短信验证码
**Example** : "8392"
string
smsCodeKey
*required*
短信验证码比对密钥
**Example** : "zd3y5b3g"
string

通用存证响应

通用存证响应模型

Name Description Schema
key
*optional*
存储与查询主键key
**Example** : "12xNoju0X23XSLyWmt23AXCRxSY9qf"
string
txId
*optional*
区块链交易ID
**Example** : "5Lqn5ZOBOjdvZ28xNWU4M242NTI5MDBlMWc2OD"
string

静默签署接口请求参数MODEL

静默签署接口请求参数模型

Name Description Schema
remark
*required*
备注
**Example** : "备注"
string
sealId
*required*
印章ID,可以为空字符串,为空字符串表示默认印章
**Example** : "seal51312959317606400"
string
signerId
*required*
签署者ID
**Example** : "sgnr51313369172410368"
string

Security

回调地址Url

Type : apiKey
Name : notify
In : HEADER

模拟权限

Type : apiKey
Name : x-token-info
In : HEADER

认证参数

Type : apiKey
Name : authorization
In : HEADER

调用方AppId

Type : apiKey
Name : appid
In : HEADER