查询签署人（按手机&邮箱）

更新时间：2022-02-17 18:16:52

接口描述

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

常见使用场景如下：

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

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

【重要提示】

区别于通过签署方账号ID方式发起的签署流程，本接口适用于查询通过账号（手机号/邮箱）发起的签署人信息。

注意：

本接口的请求参数signFlowId即为【发起签署流程（按手机&邮箱）】接口创建成功返回的flowId。

本接口响应参数中

operatorAccount对应【发起签署流程（按手机&邮箱）】参数signerAccount签署人账号（手机号/邮箱）、

signerAccount对应参数authorizedAccount签约主体账号信息（个人手机号/邮箱/机构名称）、

thirdPartyBizNum对应参数thirdOrderNo第三方流水号。

接口地址&请求方式

接口地址：/v3/sign-flow/{signFlowId}/signers

请求方式：GET

请求头格式

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

请求参数

参数名称	类型	必选	参数类型	参数说明
signFlowId	string	是	path	签署流程ID

响应参数

展开全部参数参数名称				类型	必选	参数说明
code				int	是	业务码，0表示成功
message				string	否	业务信息
data				object	否	业务数据
	signers			array	否	签署人列表
	signOrder		int	否	签署顺序
	signStatus		int	否	签署状态 0 - 等待签署 1 - 签署中 2 - 已签署 3 - 等待审批 4 - 拒绝签署
	operatorId		string	否	签署操作人账号ID
	operatorAccount		object	否	签署操作人账号信息
		mobile	string	否	手机号
		email	string	否	邮箱
		orgName	string	否	企业/机构名称
	operatorName		string	否	签署操作人名称
	operatorAuth		boolean	否	签署操作人是否实名 true - 已实名 false - 未实名
	signerId		string	否	签署主体的账号ID（个人/企业）签署人个人签署，则返回签署人账号ID；签署人代机构签署，则返回机构账号ID；
	signerAccount		object	否	签署主体账号信息
		mobile	string	否	手机号
email		string	否	邮箱
orgName		string	否	企业/机构名称
signerName		string	否	签署主体名称
signerAuth		boolean	否	签署主体是否已实名 true - 已实名 false - 未实名
signerType		int	否	签署主体类型 0-个人, 1-机构/企业
thirdPartyBizNum		string	否	发起签署时指定的第三方业务流水号，用于标识自己的业务及签署方。

请求示例

GET https://openapi.esign.cn/v3/sign-flow/XXX/signers

响应示例

//示例为企业员工代企业“esigntestxx企业”签署场景，签署操作人为张某某，签署时其账号是通过签署人的
手机号（183xxxx2635）发起的签署流程，签署主体账号信息为企业名称:esigntestxx企业。
{
    "code": 0,
    "message": "成功",
    "data": {
        "signers": [
            {
                "signOrder": 1,
                "signStatus": 1,
                "operatorId": "c7e0029472914ce4ab33deea31xxx",
                "operatorAccount": {
                    "mobile": "183xxxx2635",
                    "email": null,
                    "orgName": null
                },
                "operatorName": "张某某",
                "operatorAuth": true,
                "signerId": "0c5bd492486b47f58d4ba96d5648xxx",
                "signerAccount": {
                    "mobile": null,
                    "email": null,
                    "orgName": "esigntestxx企业"
                },
                "signerName": "esigntestxx企业",
                "signerAuth": true,
                "signerType": 1,
                "thirdPartyBizNum": "xxxx"
            }
        ]
    }
}

错误码

错误码	错误描述	排查方法
1437105	流程已删除	已经删除的流程不能查看签署人列表