合同签署服务API V3

更新时间:2024-02-02 16:34:26

注:

错误信息描述中的 %s:代表具体的参数值。例如:“参数错误: 发起方机构账号不存在,%s”,其中 %s 实际会返回请求参数中传入的具体发起方机构账号值。

签署流程-发起类

基于文件发起签署

POST /v3/sign-flow/create-by-file

code 错误码

message 错误信息

401

INVALID_SIGNATURE

401

SIMPLE_MODE_CANT_PASS

401

TOKEN_CANT_BE_NULL

401

TOKEN错误

401

缺少参数

401

无效的应用

403

IP白名单不匹配

1435002

参数错误: acrossPageMode无对应枚举值

1435002

参数错误: fileId不能为空

1435002

参数错误: normalSignFieldConfig不能为空

1435002

参数错误: redirectUrl为空时,不允许传入redirectDelayTime

1435002

参数错误: remarkSignFieldConfig不能为空

1435002

参数错误: signerType不能为空

1435002

参数错误: signerType只支持0或1

1435002

参数错误: signFieldStyle无对应枚举值

1435002

参数错误: signFields不能为空

1435002

参数错误: signFieldType无对应枚举值

1435002

参数错误: signFlowConfig不能为空

1435002

参数错误: signFlowTitle不能为空

1435002

参数错误: 备注签署区必须是个人签署方

1435002

参数错误: 抄送人psnId、psnAccount不能同时传值或同时为空

1435002

参数错误: 单页签章区,positionX、positionY、positionPage不能为空

1435002

参数错误: 发起方机构账号不存在,%s

1435002

参数错误: 非自动签签署机构签署方经办人transactorInfo不能为空

1435002

参数错误: 非自由模式signFieldPosition不能为空

1435002

参数错误: 个人抄送方标准签账号未注册,psnId:%s

1435002

参数错误: 个人抄送方账号不存在,%s

1435002

参数错误: 个人发起方标准签账号未注册,psnId:%s

1435002

参数错误: 个人签署不支持自动签署

1435002

参数错误: 个人签署方psnAccount必须是手机号或邮箱

1435002

参数错误: 个人签署方psnId和psnAccount不能同时为空或同时传值

1435002

参数错误: 个人签署方psnSignerInfo不能为空

1435002

参数错误: 个人签署方账号不存在,%s

1435002

参数错误: 机构发起方orgId与transactor不能为空

1435002

参数错误: 机构发起方标准签账号未注册,%s

1435002

参数错误: 机构发起方经办人账号不存在,%s

1435002

参数错误: 机构发起方账号不存在,%s

1435002

参数错误: 机构签署方orgId和OrgName不能同时为空或同时传值

1435002

参数错误: 机构签署方orgSignerInfo不能为空

1435002

参数错误: 机构签署方transactorInfos中psnId和psnAccount不能同时为空或同时传值

1435002

参数错误: 机构签署方与机构签署经办人传入必须为orgId与psnId或orgName与psnAccount

1435002

参数错误: 机构签署方账号不存在,%s

1435002

参数错误: 机构签署经办人psnAccount必须是手机号或邮箱

1435002

参数错误: 机构签署经办人账号不存在,%s

1435002

参数错误: 平台方发起不支持发起方付费

1435002

参数错误: 签署截止时间signFlowExpireTime不能超过发起后90天

1435002

参数错误: 手写备注签署区-remarkContent不能为空或超过50个字

1435002

参数错误: 同一个签署方,个人和机构不能同时为空或同时传值

1435002

参数错误: 文件id不在签署流程中,请先添加文件到流程中,即可添加签署区,fileId:%s

1435002

参数错误: 无效的印章,sealId:%s

1435002

参数错误: 印章和签署主体不匹配

1435002

参数错误: 暂不支持个人发起方付费

1435002

参数错误: 指定印章id或指定印章列表场景orgSealBizTypes不能传值

1435002

参数错误: 自动签署不支持传入transactorInfo

1435002

参数错误: 自动签署机构账号只允许传orgId

1435002

参数错误: 自由模式不支持自动签署

1435002

参数错误: signMode为中国大陆签时,不可设置globalWillingness

1435002

参数错误: signMode为中国大陆签时,不可设置globalAuthModes

1435002

参数错误: signMode为中国大陆签时,不可设置globalAccessCode

1435002

参数错误: globalAuthModes为访问口令时,globalAccessCode参数必传

1435002

参数错误: globalAccessCode仅支持字母和数字

1435002

参数错误: accessToken长度范围6-45

1435002

参数错误: 海外签身份验证方式为无需验证或访问口令时,不可设置个人/企业实名认证可选项

1435002

参数错误: globalWillingness=false时,不可设置意愿认证可选项willingnessAuthMode

1435002

参数错误: 签署方身份验证方式为无/访问口令时,签署方类型必须为个人或经办人

1435011

查询账号授权状态失败, accountId: %s

1435011

机构签署账号:%s 不允许自动签署

1435011

流程自动开启的场景文档和签署人信息不能为空

1435203

账号不存在: %s

1435320

注册账号失败: 证件格式异常. type:%s, value:%s

1435322

校验账号失败: 登录账号不存在. uid:%s

1435404

企业账户中电子合同份数不足,请购买套餐后再操作

1435405

企业账户中电子合同份数不足,请联系e签宝客服400-087-8198

1435405

企业账户中电子合同份数不足,请联系管理员%s购买套餐后再操作

1436116

用户:%s未授权:org_initiate_sign

1436116

用户:%s未授权:psn_initiate_sign

1436116

用户:%s未授权:use_org_order

1437169

流程已过期

1437182

未获取该企业有效的印章授权

1437306

单页签署: 签署页码超出文档页数

1437306

骑缝签署: 签署页码超出文档页数

1437328

传入的签署人用户信息与e签宝用户信息不一致,请先确认信息是否准确:%s

1437328

该签署人账号:%s对应用户已实名,传入的指定签署人信息与实名信息不一致,请先确认信息是否准确:姓名%s

1437511

文档不存在:%s

1437513

文档未成功转换成pdf, 请稍后重试

1437608

流程创建签署人或签署主体个数%s超过数量限制,最多允许创建10个。

通过页面发起签署

POST /v3/sign-flow/sign-flow-initiate-url/by-file

code 错误码

message 错误信息

1436116

用户:%s未授权:org_initiate_sign

1437513

文档未成功转换成pdf, 请稍后重试

1437511

文档不存在:%s

1435405

企业账户中电子合同份数不足,请联系管理员%s购买套餐后再操作

1435404

企业账户中电子合同份数不足,请购买套餐后再操作

1437328

该签署人账号:18856496789对应用户已实名,传入的指定签署人信息与实名信息不一致,请先确认信息是否准确:%s

1435002

参数错误: 自动签署不支持传入transactorInfo

1435002

参数错误: 机构签署方transactorInfos中psnId和psnAccount不能同时为空或同时传值

1435002

参数错误: 机构发起方经办人账号不存在,%s

1435002

参数错误: 机构发起方orgId与transactor不能为空

1435002

参数错误: 个人发起方账号不能为企业账号,%s

1435002

参数错误: 个人发起方账号不存在,%s

1435002

参数错误: 非自由模式signFieldPosition不能为空

1435002

参数错误: 非自动签签署机构签署方经办人transactorInfo不能为空

1435002

参数错误: 单页签章区,positionX、positionY、positionPage不能为空

1435002

参数错误: signFlowConfig不能为空

1435002

参数错误: signFields不能为空

1435002

参数错误: signFieldStyle无对应枚举值

1435002

参数错误: normalSignFieldConfig不能为空

1435002

参数错误: fileId不能为空

1435002

参数错误: 不允许存在相同顺序相同主体

1435002

参数错误: 自由模式不支持自动签署

获取签署页面链接

POST /v3/sign-flow/{signFlowId}/sign-url

code 错误码

message 错误信息

1435203

用户账号不存在或已注销

1437114

当前用户不是流程参与人, 无权查看流程

1435002

参数错误: 该appId没有权限获取该流程的签署链接

1435011

流程不存在:%s

1436116

用户:%s 未授权:org_initiate_sign

1435002

参数错误: 用户账户不存在

1435322

校验账号失败: open user不存在. ouid:%s

1435323

查询标准签账号失败: 缺少参数: %s

1437103

流程未开启

1435002

参数错误: 未传redirectUrl不允许设置redirectDelayTime

获取批量签页面链接(多流程)

POST /v3/sign-flow/batch-sign-url

code 错误码

message 错误信息

1437199

获取批量签署链接失败: 没有签署任务

1437199

获取批量签署链接失败: 当前流程不是“签署中”的状态

1437199

获取批量签署链接失败: 未查询到对应流程或签署区信息. 运行时关键参数:未查询到对应流程或签署区信息

1435012

服务异常

1437199

获取批量签署链接失败: 暂不支持同一个经办人在单流程内的多主体签署任务

1435002

参数错误: 签署人id不能为空

1437199

获取批量签署链接失败: 流程:%s存在自由备注签任务或手写输入备注签任务

1437199

获取批量签署链接失败: 印章指定类型不一致,暂不支持仅模板印章和仅手绘印章组合的流程,请确认后再发起批量任务

1437199

获取批量签署链接失败: 批量签署流程个数不能超过10个

1437199

获取批量签署链接失败: 查询流程列表失败. 运行时关键参数:查询流程列表失败

1437199

获取批量签署链接失败: 流程中存在非SaaS Api免登版发起的流程

1437199

获取批量签署链接失败: 印章类型仅指定手绘不支持批量签

1435002

参数错误: 当前项目下,签署流程不存在,flowId: %s

签署流程-下载类

下载已签署文件及附属材料

GET /v3/sign-flow/{signFlowId}/file-download-url

code 错误码

message 错误信息

1437518

流程非签署完成状态,不允许下载文档

1436116

用户:%s未授权:org_initiate_sign

1435002

参数错误: 该接口仅能查询SaaS Api3.0发起的流程信息,请确认后重试!

1435002

参数错误: 当前项目下,签署流程不存在,flowId: %s

1435011

流程不存在:%s

下载签署中文件

GET /v3/sign-flow/{signFlowId}/preview-file-download-url

code 错误码

message 错误信息

1435002

参数错误: 传入的fileId非当前流程中的签署文件

1436116

用户:%s未授权:org_initiate_sign

1435002

参数错误: 该接口仅能查询SaaS Api3.0发起的流程信息,请确认后重试!

1435002

参数错误: 当前项目下,签署流程不存在,flowId: %s

1435011

流程不存在:%s

签署流程-变更类

开启签署流程

POST /v3/sign-flow/{signFlowId}/start

code 错误码

message 错误信息

1437169

流程已过期

1435405

企业账户中电子合同份数不足,请联系管理员购买套餐后再操作

完结签署流程

POST /v3/sign-flow/{signFlowId}/finish

code 错误码

message 错误信息

1437136

流程已归档

1437113

签署区没有全部完成

1439007

归档失败,请稍后重试

1437170

没有签署,无需归档

1437112

非开启状态不允许归档流程

撤销签署流程

POST /v3/sign-flow/{signFlowId}/revoke

code 错误码

message 错误信息

1437203

非签署中的流程不允许撤销

1435011

流程不存在:%s

1435011

数据版本不一致

1437168

流程已撤销

延长签署截止时间

POST /v3/sign-flow/{signFlowId}/delay

code 错误码

message 错误信息

1435011

流程不存在:%s

1437201

非签署中的流程不能延期

1435002

参数错误: signFlowExpireTime不能为空

1435002

参数错误: 该接口仅能查询SaaS Api免登版发起的流程信息,请确认后重试!

1435011

流程只能延期一次

催签流程中签署人

POST /v3/sign-flow/{signFlowId}/urge

code 错误码

message 错误信息

1437137

您刚刚催办过了,发起后半小时内不能催办

1437138

您刚刚催办过,发起半小时后每十分钟仅可催办一次

1439002

当前流程无可催签的签署区

1435002

参数错误: 该接口仅能查询SaaS Api免登版发起的流程信息,请确认后重试!

1437126

流程未发起或已完结, 不能执行催签操作

签署流程-查询类

查询签署流程详情

GET /v3/sign-flow/{signFlowId}/detail

code 错误码

message 错误信息

1435011

流程不存在:%s

1435002

参数错误: 该接口仅能查询SaaS Api免登版发起的流程信息,请确认后重试!

1435002

参数错误: 当前项目下,签署流程不存在,flowId: %s

1436116

用户:%s未授权:org_initiate_sign

查询签署流程列表

POST /v3/sign-flow/sign-flow-list

code 错误码

message 错误信息

1435002

参数错误: 开始时间(流程发起时间)、结束时间(流程发起时间)查询时间段需在一年内

1435002

参数错误: 开始时间(流程完结时间)、结束时间(流程完结时间)查询时间段需在一年内

1435002

参数错误: 开始时间(流程完结时间)过早,仅能查询近5年完结的流程

1435002

参数错误: 开始时间(流程发起时间)过早,仅能查询近5年发起的流程

1435002

参数错误: 流程状态不合法

1435002

参数错误: pageNum不能为空

1435002

参数错误: 结束时间不能为空

1435002

参数错误: 开始时间不能为空

1435002

参数错误: pageSize不能为空

询集成方企业流程列表

POST /v3/organizations/sign-flow-list

code 错误码

message 错误信息

1435002

参数错误: 开始时间(流程发起时间)、结束时间(流程发起时间)查询时间段需在一年内

1435002

参数错误: 开始时间(流程完结时间)、结束时间(流程完结时间)查询时间段需在一年内

1435002

参数错误: 开始时间(流程完结时间)过早,仅能查询近5年完结的流程

1435002

参数错误: 开始时间(流程发起时间)过早,仅能查询近5年发起的流程

1435002

参数错误: 流程状态不合法

1435002

参数错误: pageNum不能为空

1435002

参数错误: 结束时间不能为空

1435002

参数错误: 开始时间不能为空

1435002

参数错误: pageSize不能为空

签署流程-审批类

获取用印审批页面链接

POST /v3/approval/approval-url

code 错误码

message 错误信息

1453000

参数错误:指定重定向倒计时redirectDelayTime时必须传入重定向地址redirectUrl

1453001

用户:%s未授权:org_approval_info

1453002

审批流程不存在或非当前appid下的审批流程

1453004

指定的审批人无审批权限

查询审批流程详情

GET /v3/approval/{approvalFlowId}/detail

code 错误码

message 错误信息

1453001

用户:%s未授权:org_approval_info

1453002

审批流程不存在或非当前appid下的审批流程

查询审批流程列表

POST /v3/approval/approval-task-list

code 错误码

message 错误信息

1453000

参数错误:指定查询方式queryType时必须传入审批操作人operatorPsnId

1453001

用户:%s未授权:org_approval_info

1453002

审批流程不存在或非当前appid下的审批流程

1453003

审批操作人非该企业员工

签署区-变更类

追加签署区

POST /v3/sign-flow/{signFlowId}/signers/sign-fields

code 错误码

message 错误信息

1437328

该签署人账号:%s对应用户已实名,传入的指定签署人信息与实名信息不一致,请先确认信息是否准确:姓名%s

1435320

注册账号失败: 证件格式异常. type:%s, value:%s

1437325

签署区添加失败,签名域节点信息列表不能为空

1435002

参数错误: 机构签署方orgId和OrgName不能同时为空或同时传值

1435002

参数错误: 骑缝签署:必须指定y

1435002

参数错误: 个人签署方psnSignerInfo不能为空

1435002

参数错误: signers不能为空

1435002

参数错误: 流程已经结束

删除签署区

DELETE /v3/sign-flow/{signFlowId}/signers/sign-fields?signFieldIds=xxx1,xxx2

code 错误码

message 错误信息

1437102

流程已完结

待签文件及附属材料-变更类

追加待签文件

POST /v3/sign-flow/{signFlowId}/unsigned-files

code 错误码

message 错误信息

1435011

流程不存在:%s

1436116

用户:用户id*未授权:*权限名*

1437502

流程非草稿状态,不允许添加文档

1435608

查询合同信息失败: 合同不存在

删除待签署文件

DELETE /v3/sign-flow/{signFlowId}/unsigned-files?fileIds=xxx1,xxx2

code 错误码

message 错误信息

1435011

流程不存在:%s

1436116

用户:用户id*未授权:*权限名*

1435002

参数错误: 当前流程下,文档不存在, fileId: %s

追加附属材料

POST /v3/sign-flow/{signFlowId}/attachments

code 错误码

message 错误信息

1435011

流程不存在:%s

1436116

用户:用户id*未授权:*权限名*

1435002

参数错误: 附件列表不能为空

1435002

参数错误: fileId不能为空

1435608

查询合同信息失败: 合同不存在

1437402

流程已完结,不允许添加附件

删除附属材料

DELETE /v3/sign-flow/{signFlowId}/attachments?fileIds=xxx1,xxx2

code 错误码

message 错误信息

1435011

流程不存在:%s

1436116

用户:用户id*未授权:*权限名*

1435002

参数错误: 当前流程下,附件不存在, fileId: %s

抄送方-变更类

添加抄送方

POST /v3/sign-flow/{signFlowId}/copiers

code 错误码

message 错误信息

1435002

追加抄送人之流程权限校验失败, appId: {}, flowId: {}, flowAppId: {}

1435002

当前项目下,签署流程不存在,flowId: %s

1435002

该接口仅能查询SaaS Api免登版发起的流程信息,请确认后重试!

1435002

流程已经结束

1435002

自动归档流程开启后,不允许添加抄送人

1435002

个人抄送方账号不存在,%s

1435002

个人抄送方账号不能为企业账号,%s

1435002

个人抄送方标准签账号未注册,psnId:%s"

1435002

机构抄送方账号不存在,%s

1435002

机构抄送方账号不能为个人账号,%s

1435002

机构抄送方标准签账号未注册,orgId:%s

1435011

当前流程已有此抄送方信息. {0}

1435002

追加抄送人后数量超过限制

删除抄送方

POST /v3/sign-flow/{signFlowId}/copiers/delete

code 错误码

message 错误信息

1435002

删除抄送人之流程权限校验失败, appId: {}, flowId: {}, flowAppId: {}

1435002

当前项目下,签署流程不存在,flowId: %s

1435002

该接口仅能查询SaaS Api免登版发起的流程信息,请确认后重试!

1435002

流程已经结束

1435002

自动归档流程开启后,不允许删除抄送人

1435002

企业账户不存在: %s

1435002

个人账户不存在: %s

1435011

当前流程无此抄送方信息

1435002

删除抄送人的个数超过限制

核验已签文件

核验合同文件签名有效性

POST /v3/files/{fileId}/verify

code 错误码

message 错误信息

1435002

参数错误: flowId和fileId不匹配

1435511

该文件中未发现签章

1438403

流程未结束,请归档后重试

获取区块链存证信息

POST /v3/antchain-file-info

code 错误码

message 错误信息

1480001

参数错误

1480011

查询记录不存在

1480013

该记录尚未推送

核验区块链存证文件

POST /v3/antchain-file-info/verify

code 错误码

message 错误信息

1480001

参数错误

合同解约服务

通过页面发起合同解约

POST /v3/sign-flow/{signFlowId}/rescission-url

code 错误码

message 错误信息

1439107

发起方没有可以解约的文档,不允许解约

1439106

发起方主体非原流程签署主体,不允许解约

1439100

当前流程非完结状态,不允许解约

1435011

流程不存在:%s

1435002

参数错误: 平台方发起不支持发起方付费

1435002

参数错误: 暂不支持个人发起方付费

1437610

发起方【%s】账号未实名授权,请先进行认证授权免登

发起合同解约

POST /v3/sign-flow/{signFlowId}/initiate-rescission

code 错误码

message 错误信息

1439107

发起方没有可以解约的文档,不允许解约

1439106

发起方主体非原流程签署主体,不允许解约

1439100

当前流程非完结状态,不允许解约

1435011

流程不存在:%s

1435002

参数错误: 平台方发起不支持发起方付费

1435002

参数错误: 暂不支持个人发起方付费

1437610

发起方【%s】账号未实名授权,请先进行认证授权免登

合同出证服务

申请出证

POST /v3/evidence-report/apply

code 错误码

message 错误信息

1480201

余额不足

1480203

经校验,您无权出证

1480205

签署过程存在不可信,需要线下联系客服人工办理,联系电话:400-087-8198

1480207

获取签署流程信息失败

查询出证流程详情

GET /v3/evidence-report/query

code 错误码

message 错误信息

1480209

出证记录不存在


我要纠错