接口描述
当发起企业授权书签署任务后,平台可以根据授权ID查询授权的具体状态。
接口地址
点击下述蓝色字体{host}可跳转至API请求域名说明文档
https://{host}/v1/signAuthApi/queryAuthResult?authId=XXX
请求方式
GET
请求数据格式
application/json; charset=UTF-8
请求参数
参数名称 | 参数位置 | 参数类型 | 必选 | 参数说明 |
authId | query | string | 是 | 授权流程ID |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message 匹配,因为 message 可能会调整。 | |
data(点击“+”展开详情) | object | 否 | 业务数据 | |
authId | string | 否 | 授权流程ID | |
status | int | 否 | 授权状态 1 - 进行中 2 - 授权成功 3 - 授权失败 4 - 取消授权 | |
failReason | string | 否 | 授权说明(授权失败时返回原因) | |
effectiveStartTime | long | 否 | 授权生效时间(格式为yyyyMMdd 列如 "20260101") | |
effectiveEndTime | long | 否 | 授权失效时间(格式为yyyyMMdd 列如 "20260101") |
请求示例
GET https://{host}/v1/signAuthApi/queryAuthResult?authId=5ab3d62ce9***f3712505
响应示例
{
"code": 0,
"message": "成功",
"data": {
"authId": "5ab3d62ce9b8******afbf3712505",
"effectiveStartTime": "20250307",
"effectiveEndTime": "20260221",
"status": 1,
"failReason": null
}
}