接口描述
查询实名认证流程的流程详情,含认证状态、认证主体信息等
接口
/v2/identity/auth/api/common/{flowId}/detail
请求方式
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 | int | 是 | 错误码 | ||
message | string | 是 | 错误信息 | ||
data | object | 否 | 业务信息 | ||
flowId | string | 否 | 认证流程ID | ||
status | string | 否 | 认证流程状态 INIT 已发起,该状态下e签宝不会计费 ING 进行中 SUCCESS 已成功 FAIL 已失败 | ||
objectType | string | 否 | 认证主体类型 INDIVIDUAL 个人 ORGANIZATION 组织机构 | ||
startTime | int64 | 否 | 流程创建时间(unix毫秒时间戳) | ||
endTime | int64 | 否 | 流程最后更新时间(unix毫秒时间戳) | ||
failReason | string | 否 | 认证失败的原因 | ||
authType | string | 否 | 实名认证所使用的认证类型 个人实名认证场景: INDIVIDUAL_TELECOM_3_FACTOR 个人运营商三要素 INDIVIDUAL_BANKCARD_4_FACTOR 个人银行卡四要素 INDIVIDUAL_ARTIFICIAL 个人人工实名 FACEAUTH_ZMXY 个人人脸识别:支付宝刷脸 FACEAUTH_TECENT_CLOUD 个人人脸识别:微众刷脸 FACEAUTH_ESIGN 个人人脸识别:快捷刷脸 FACEAUTH_WE_CHAT_FACE 个人人脸识别:微信小程序刷脸 企业实名认证场景: ORGANIZATION_INFO_AUTH 企业信息比对(企业三要素或四要素) ORGANIZATION_TRANSFER_RANDOM_AMOUNT 随机金额打款校验 ORGANIZATION_REVERSE_PAYMENT 企业反向打款 ORGANIZATION_ZMXY 企业芝麻信用认证 LEGAL_REP_SIGN_AUTHORIZE 企业法定代表人签署授权认证 ORGANIZATION_ARTIFICIAL 企业人工实名 LEGAL_REP_AUTH 法定代表人实名认证 ORGANIZATION_LEGAL_WILL_AUTH 法定代表人意愿认证(法定代表人账号已经实名的情况是做意愿认证) | ||
agentAuthType | string | 否 | 企业实名认证中,经办人所使用的认证类型(只有企业认证流程才会返回) 经办人实名认证场景: INDIVIDUAL_TELECOM_3_FACTOR 个人运营商三要素 INDIVIDUAL_BANKCARD_4_FACTOR 个人银行卡四要素 INDIVIDUAL_ARTIFICIAL 个人人工实名 FACEAUTH_ZMXY 个人人脸识别:支付宝刷脸 FACEAUTH_TECENT_CLOUD 个人人脸识别:微众刷脸 FACEAUTH_ESIGN 个人人脸识别:快捷刷脸 FACEAUTH_WE_CHAT_FACE 个人人脸识别:微信小程序刷脸 经办人意愿认证场景: WILL_AUTHCODE 意愿短信验证码 WILL_FACEAUTH_ZMXY 意愿人脸识别:支付宝刷脸 WILL_FACEAUTH_TECENT_CLOUD 意愿人脸识别:微众刷脸 WILL_FACEAUTH_ESIGN 意愿人脸识别:快捷刷脸 WILL_FACEAUTH_WE_CHAT_FACE 意愿人脸识别:微信小程序刷脸 | ||
url | string | 是 | 认证长链接,链接永久有效 | ||
shortlink | string | 是 | 认证短链接,有效期30天 | ||
organInfo | object | 否 | 企业组织基本信息 | ||
accountId | string | 否 | 组织用户id | ||
name | string | 否 | 组织机构名称 | ||
certNo | string | 否 | 组织机构证件号 | ||
certType | string | 否 | 组织机构证件类型 ORGANIZATION_USC_CODE 统一社会信用代码 ORGANIZATION_REG_CODE 企业工商注册号 | ||
legalRepName | string | 否 | 法定代表人姓名 | ||
legalRepNationality | string | 否 | 法定代表人国籍/地区 MAINLAND 中国大陆 FOREIGN 非中国地区 HONGKONG_MACAO 中国香港/澳门地区 TAIWAN 中国台湾省地区 | ||
legalRepCertNo | string | 否 | 法定代表人证件号 | ||
legalRepCertType | string | 否 | 法定代表人证件类型 | ||
indivInfo | object | 否 | 个人基本信息对象 | ||
accountId | string | 否 | 用户id | ||
name | string | 否 | 姓名 | ||
certNo | string | 否 | 证件号 | ||
certType | string | 否 | 证件类型, INDIVIDUAL_CH_IDCARD 中国大陆居民身份证 INDIVIDUAL_CH_TWCARD 台湾来往大陆通行证 INDIVIDUAL_CH_HONGKONG_MACAO 港澳来往大陆通行证 INDIVIDUAL_PASSPORT 护照 | ||
nationality | string | 否 | 国籍/地区 | ||
mobileNo | string | 否 | 手机号 | ||
bankCardNo | string | 否 | 银行卡号 | ||
facePhotoUrl | string | 否 | 刷脸认证时的刷脸照片(base64编码照片图片数据),有效期默认1个小时(过期可重新获取) 注: 1.此字段默认不返回任何信息,需联系e签宝沟通业务场景通过后才可开通 2.认证方式选择腾讯云人脸识别和快捷人脸识别时,才会返回该字段 | ||
facePhotoAllUrl | list | 否 | 腾讯云人脸识别时的多张刷脸照片(最多返回3张照片,base64编码照片图片数据),有效期默认1个小时(过期可重新获取) 注:此字段默认不返回任何信息,需联系e签宝沟通业务场景通过后才可开通 | ||
similarity | string | 否 | 刷脸照片相似度得分 注:认证方式选择腾讯云人脸识别和快捷人脸识别时,才会返回该字段 | ||
livingScore | string | 否 | 刷脸活体检测得分 注:认证方式选择腾讯云人脸识别和快捷人脸识别时,才会返回该字段 | ||
faceVideoUrl | string | 否 | 刷脸认证时刷脸视频(base64编码的mp4视频数据),有效期默认1个小时(过期可重新获取) 注: 1.此字段默认不返回任何信息,需联系e签宝沟通业务场景通过后才可开通 2.认证方式选择腾讯云人脸识别和快捷人脸识别时,才会返回该字段 | ||
faceType | string | 否 | 腾讯云刷脸时的刷脸模式(仅使用腾讯云刷脸时返回):
| ||
idCardFrontPicUrl | string | 否 | 微信小程序刷脸认证时上传的身份证正面照片(base64编码照片图片数据),有效期默认1个小时(过期可重新获取) 注: 1.此字段默认不返回任何信息,需联系e签宝沟通业务场景通过后才可开通 2.认证方式仅限微信小程序使用e签宝微信小程序刷脸时,才会返回该字段 | ||
idCardBackPicUrl | string | 否 | 微信小程序刷脸认证时上传的身份证反面照片(base64编码照片图片数据),有效期默认1个小时(过期可重新获取) 注: 1.此字段默认不返回任何信息,需联系e签宝沟通业务场景通过后才可开通 2.认证方式仅限微信小程序使用e签宝微信小程序刷脸时,才会返回该字段 |
请求示例
GET /v2/identity/auth/api/common/{flowId}/detail
响应示例
{
"code": 0,
"message": "成功",
"data": {
"flowId": "3127********8945",
"status": "SUCCESS",
"objectType": "INDIVIDUAL",
"startTime": 1701139998000,
"endTime": 1701140087000,
"authType": "FACEAUTH_TECENT_CLOUD",
"agentAuthType": null,
"failReason": null,
"url": "",
"shortLink": "",
"appId": "******4954",
"organInfo": null,
"indivInfo": {
"accountId": null,
"name": "张三",
"certNo": "231********29",
"certType": "INDIVIDUAL_CH_IDCARD",
"nationality": "UNKNOWN",
"mobileNo": null,
"bankCardNo": null,
"facePhotoUrl": "https://upload-pre.esign.cn/eproxy/1111564182/6f781361-16f9-42c5-9fe5-12facc027edf/31b71cb17d8147f996488c574ffa6817?signature=252%2BnjuOgcQE0q7g1z%2FDY61HWvc%3D&expire=1701143700594&bucket=esignoss",
"facePhotoAllUrl": null,
"livingScore": "89.0",
"similarity": "92.37",
"faceVideoUrl": "",
"faceType": "Action_Liveness_Detection",
"idCardFrontPicUrl": null,
"idCardBackPicUrl": null
}
}
}
错误码
错误码 | 错误描述 | 解决方案 |
30500004 | 认证流程不存在 | 在服务器端查不到有效的flowId |