查询签署人

更新时间：2022-01-24 10:25:55

文档变更

2022年时，流程签署人列表变为查询签署人，以便开发者更容易理解，仅中文名称变更，其功能保持不变。

无特殊说明时，文档其他地方及参数中的【签署人】字样等同于【签署方】。

接口描述

查询签署流程中所有签署人信息，签署方信息包含签署人名称、签署状态、签署顺序、实名状态等信息。

常见使用场景如下：

（1）需要查询签署流程中各签署人的当前签署状态。

（2）需要查询签署流程中各签署人的当前实名状态。

接口地址&请求方式

接口地址：/v1/signflows/{flowId}/signers

请求方式：GET

请求头格式

具体请求头格式结构，请点击查看公共参数说明。

请求参数

参数名称

类型

必选

参数类型

参数说明

（左右拖动查看完整描述）

flowId

string

是

path

签署流程ID

响应参数

展开全部参数参数名称			类型	必选	参数说明（左右拖动查看完整描述）
code			int	是	业务码，0表示成功
message			string	否	业务信息
data			object	否	业务数据
	signers		array	否	签字人列表
	signOrder	int	否	签署顺序
	signStatus	int	否	签署状态 0 - 等待签署 1 - 签署中 2 - 已签署 3 - 等待审批 4 - 拒绝签署
	signerAccountId	string	否	签署人账号ID
	signerName	string	否	签署人名称
	signerRealName	boolean	否	签署人是否已实名 true - 已实名 false - 未实名
	signerAuthorizedAccountId	string	否	签约主体的账号id（个人/企业）；如签署人本签署，则返回签署人账号id；如签署人代机构签署，则返回机构账号id；
	signerAuthorizedAccountName	string	否	签约主体名称
	signerAuthorizedAccountRealName	string	否	签署主体是否已实名
	signerAuthorizedAccountType	int	否	签署主体类型 0-个人, 1-机构
	thirdOrderNo	string	否	发起签署时指定的第三方业务流水号，用于标识自己的业务及签署方。

请求示例

GET https://openapi.esign.cn/v1/signflows/a017ba10bc3b4af197d63941ab4a7838/signers

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "signers": [
            {
                "signerAccountId": "01fcaed8c1b146c3aaca1d8f0ef0a8f6",
                "signerAuthorizedAccountType": 0,
                "signerAuthorizedAccountId": "01fcaed8c1b146c3aaca1d8f0ef0a8f6",
                "signerAuthorizedAccountName": "张三",
                "signerName": "张三",
                "signerRoleLabel": "",
                "mobiles": null,
                "emails": null,
                "signerRealName": true,
                "signerAccountDeleted": false,
                "signerAuthorizedAccountRealName": true,
                "signerAuthorizedAccountDeleted": false,
                "signerAuthorizedAccountCanCert": true,
                "signStatus": 2,
                "signOrder": 1,
                "needAgentSign": false,
                "thirdOrderNo": "N001-15300001111",
                "signerSignRoles": "0",
                "allowedUploadAttachment": false,
                "sealType": null,
                "handDrawnWay": null
            },
            {
                "signerAccountId": "01fcaed8c1b146c3aaca1d8f0ef0a8f6",
                "signerAuthorizedAccountType": 1,
                "signerAuthorizedAccountId": "237892a76f394b4f9fb2229e84105f0a",
                "signerAuthorizedAccountName": "esigntest啦啦啦测试企业",
                "signerName": "张三",
                "signerRoleLabel": "",
                "mobiles": null,
                "emails": null,
                "signerRealName": true,
                "signerAccountDeleted": false,
                "signerAuthorizedAccountRealName": true,
                "signerAuthorizedAccountDeleted": false,
                "signerAuthorizedAccountCanCert": true,
                "signStatus": 2,
                "signOrder": 1,
                "needAgentSign": false,
                "thirdOrderNo": "N001-esigntest啦啦啦测试企业",
                "signerSignRoles": "1",
                "allowedUploadAttachment": false,
                "sealType": null,
                "handDrawnWay": null
            }
        ]
    }
}

错误码

错误码

错误描述

排查方法

（左右拖动查看完整描述）

1437105

流程已删除

已经删除的流程不能查看签署人列表