接口描述
支持查询实名认证流程业务概要信息
接口
/v2/identity/auth/api/common/{flowId}/outline
请求方式
GET
请求头
提供两种安全接入方式，对应参数如何获取，参考文档【请点击】。
方式一：请求签名鉴权（优先推荐）
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 应用ID |
Content-Type | string | 是 | application/json;charset=UTF-8 |
X-Tsign-Open-Ca-Timestamp | string | 是 | API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击 |
Accept | string | 是 | 建议统一填写 */* |
X-Tsign-Open-Ca-Signature | string | 是 | 签名字符串 |
Content-MD5 | string | 是 | 当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。 |
X-Tsign-Open-Auth-Mode | string | 是 | 选择请求方式进行鉴权，固定值，Signature |
方式二：OAuth2.0鉴权（不推荐使用）
当安全接入选择OAuth2.0鉴权方式，请点击查阅详情。
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 |
flowId | string | 是 | path | 认证流程id |
响应参数
展开全部参数参数名称（点击左侧“+”一键展开） | 类型 | 必选 | 参数说明 | |||
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | |||
message | string | 是 | 错误信息 请根据 code 来判断错误情况，不应该依赖message匹配，因为 message 可能会调整。 | |||
data | object | 否 | 业务信息 | |||
flowId | string | 否 | 认证流程Id | |||
flowStatus | string | 否 | 流程状态 ： | |||
objectType | string | 否 | 认证流程主体: | |||
contextId | string | 否 | 认证业务流程发起时的上下文id | |||
failReason | string | 否 | 认证状态为失败时,失败的原因描述 | |||
createTime | long | 否 | 流程创建时间时间戳值 | |||
modifyTime | long | 否 | 流程最后一次状态更新时间时间戳值 | |||
subFlows | array | 否 | 认证流程关联的子认证流程的集合 | |||
subFlowId | string | 否 | 认证流程关联的子认证流程id,可用于查询子认证流程详情 | |||
subFlowType | string | 否 | 认证流程关联的子认证流程类型,可用于查询子认证流程详情： ORGANIZATION_ZMXY - 企业支付宝认证 FACEAUTH_TECENT_CLOUD - 腾讯云刷脸认证ORGANIZATION_LEGAL_REP_FACEAUTH - 企业法定代表人刷脸认证 FACEAUTH_WE_CHAT_FACE - 微信小程序刷脸 | |||
status | string | 否 | 认证流程关联的子认证流程状态: | |||
relatedFlows | array | 否 | 认证流程关联的附加业务流程的集合, 当objectType=ORGANIZATION（组织结构人认证）,可能附加个人认证流程,经办人个人身份认证 | |||
flowId | string | 否 | 经办人认证流程Id | |||
flowStatus | string | 否 | INIT (已发起)，该状态为初始状态，还未收费 | |||
objectType | string | 否 | 认证流程主体: | |||
contextId | string | 否 | 认证业务流程发起时的上下文id | |||
failReason | string | 否 | 认证状态为失败时,失败的原因描述 | |||
subFlows | array | 否 | 认证流程关联的子认证流程的集合 | |||
subFlowId | string | 否 | 认证流程关联的子认证流程id,可用于查询子认证流程详情 | |||
subFlowType | string | 否 | 认证流程关联的子认证流程类型,可用于查询子认证流程详情. FACEAUTH_TECENT_CLOUD - 微众刷脸认证 FACEAUTH_ESIGN - 快捷刷脸认证 FACEAUTH_WE_CHAT_FACE - 微信小程序刷脸认证 | |||
status | string | 否 | 认证流程关联的子认证流程状态： | |||
请求示例
GET /v2/identity/auth/api/common/{flowId}/outline响应示例
{
"code": 0,
"message": "成功",
"data": {
"flowId": "803719636976683872",
"flowStatus": "ING",
"objectType": "ORGANIZATION",
"failReason": null,
"createTime":1562656814273,
"modifyTime":1562656874000,
"contextId": "8ccce54b-4d40-4dcc-a7ac-464e41f2b468",
"subFlows": [
{
"subFlowId": "5ffbafb2-c3be-45ba-bfeb-fda1f8eb083d",
"subFlowType": "ORGANIZATION_TRANSFER_RANDOM_AMOUNT",
"status": "ING"
},
{
"subFlowId": "3bb55061-f98f-4c89-b236-96b3e7048839",
"subFlowType": "ORGANIZATION_INFO_AUTH",
"status": "ING"
}
],
"relatedFlows": [{
"flowId": "802965095964494307",
"flowStatus": "SUCCESS",
"objectType": "INDIVIDUAL",
"failReason": null,
"contextId": "8ccce54b-4d40-4dcc-a7ac-464e41f2b468",
"subFlows": [
{
"subFlowId": "84322b8a-5baf-4835-82a7-07dbd74c3365",
"subFlowType": "INDIVIDUAL_BANKCARD_4_FACTOR",
"status": "SUCCESS"
}
}]
],
}]
}
}错误码
错误码 | 错误描述 | 解决方案 |
30500001 | 认证流程不存在 | 要查询的flowId错误 |
我要纠错