接口描述
查询本次认证授权流程的详细信息。
接口地址&请求方法
接口地址:https://{host}/v3/auth-flow/{authFlowId}
请求方法:GET
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
authFlowId | string | 是 | path | 认证授权流程ID 通过【获取个人认证&授权页面链接】或【获取机构认证&授权页面链接】接口获取。 |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明(请左右滑动查看完整参数说明) | ||||
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message 匹配,因为 message 可能会调整。 | ||||
data(点击“+”展开详情) | object | 否 | 业务数据 | ||||
authFlowId | string | 否 | 认证授权流程ID | ||||
authType | string | 否 | 认证授权主体类型 ORG - 机构实名认证,PSN - 个人实名认证 | ||||
realNameOrWillingness | string | 否 | 流程中使用的认证类型 realName - 实名认证 willingness - 意愿认证 none - 都没使用 | ||||
realNameStatus | int32 | 否 | 认证流程状态 0 - 未实名,1 - 已实名 | ||||
authorizedStatus | int32 | 否 | 授权流程状态 0 - 流程过期失效 1 - 已授权 2 - 授权中 3 - 审批未通过 | ||||
authUrl | string | 否 | 认证授权长链接 | ||||
authInfo(点击“+”展开详情) | object | 否 | 认证详情 | ||||
willingnessAuthModes | string | 否 | 流程中使用的意愿认证方式 CODE_SMS - 短信验证码 CODE_EMAIL - 邮箱验证码 PSN_FACE_ALIPAY - 支付宝刷脸 PSN_FACE_TECENT - 腾讯云刷脸 PSN_FACE_ESIGN - 快捷刷脸 PSN_FACE_WECHAT - 微信小程序刷脸 | ||||
psnAuthMode | string | 否 | 本次流程中使用的个人/经办人认证方式 PSN_BANKCARD4 - 个人银行卡四要素认证 PSN_MOBILE3 - 手机运营商三要素认证 PSN_BANKCARD4_DETAILS - 个人银行卡四要素认证(详情版) PSN_MOBILE3_DETAILS - 个人运营商三要素认证(详情版) PSN_FACE - 刷脸认证 | ||||
orgAuthMode | string | 否 | 本次流程中机构实名认证使用的认证方式 ORG_BANK_TRANSFER - 对公账户打款认证 ORG_ALIPAY_CREDIT - 企业支付宝认证 ORG_LEGALREP_AUTHORIZATION - 授权委托书认证 ORG_LEGALREP - 法定代表人本人实名认证 ORG_LEGALREP_WILLINGNESS - 法定代表人本人意愿认证 | ||||
authFlowCreateTime | int64 | 否 | 流程创建时间(Unix时间戳格式,单位:毫秒) | ||||
authFlowUpdateTime | int64 | 否 | 流程最后更新时间(Unix时间戳格式,单位:毫秒) | ||||
person(点击“+”展开详情) | object | 否 | 个人以及机构经办人信息
| ||||
psnId | string | 否 | 个人账号ID | ||||
psnAccount | object | 否 | 个人账号标识(手机号/邮箱) | ||||
accountMobile | string | 否 | 手机号(个人账号标识) | ||||
accountEmail | string | 否 | 邮箱(个人账号标识) | ||||
psnInfo | object | 否 | 个人身份信息 | ||||
psnName | string | 否 | 个人姓名 | ||||
psnNationality | string | 否 | 个人用户已认证的国籍/地区(默认不返回值) | ||||
psnIDCardNum | string | 否 | 个人用户已认证的证件号 | ||||
psnIDCardType | string | 否 | 个人证件类型 CRED_PSN_CH_IDCARD - 中国大陆居民身份证 CRED_PSN_CH_HONGKONG - 香港来往大陆通行证(回乡证) CRED_PSN_CH_MACAO - 澳门来往大陆通行证(回乡证) CRED_PSN_CH_TWCARD - 台湾来往大陆通行证(台胞证) CRED_PSN_PASSPORT - 护照 | ||||
bankCardNum | string | 否 | 个人用户已认证的银行卡号 | ||||
psnMobile | string | 否 | 个人用户已认证的运营商实名登记手机号或银行卡预留手机号 【注】如果用户使用刷脸方式进行的认证,是不会有该实名手机号返回的 | ||||
faceRecognitionInfo | object | 否 | 人脸识别信息 | ||||
facePhotoUrl | string | 否 | 刷脸认证时刷脸照片(base64编码照片图片数据) 补充说明:
| ||||
similarityScore | string | 否 | 刷脸照片相似度得分 补充说明:
| ||||
livingScore | string | 否 | 刷脸活体检测得分 补充说明:
| ||||
idCardFront | string | 否 | 刷脸认证时上传的身份证正面照片(base64编码照片图片数据) 补充说明:
| ||||
idCardBack | string | 否 | 刷脸认证时上传的身份证反面照片(base64编码照片图片数据) 补充说明:
| ||||
organization(点击“+”展开详情) | object | 否 | 实名认证的机构信息 | ||||
orgId | string | 否 | 机构账号ID | ||||
orgName | string | 否 | 组织机构名称(账号标识) | ||||
orgInfo | object | 否 | 组织机构信息 | ||||
orgIDCardNum | string | 否 | 组织机构证件号 | ||||
orgIDCardType | string | 否 | 组织机构证件类型 CRED_ORG_USCC - 统一社会信用代码 CRED_ORG_REGCODE - 工商注册号 | ||||
legalRepName | string | 否 | 法定代表人姓名 | ||||
legalRepIDCardNum | string | 否 | 法定代表人证件号 | ||||
legalRepIDCardType | string | 否 | 法定代表人证件类型 CRED_PSN_CH_IDCARD - 中国大陆居民身份证 CRED_PSN_CH_HONGKONG - 香港来往大陆通行证 CRED_PSN_CH_MACAO - 澳门来往大陆通行证 CRED_PSN_CH_TWCARD - 台湾来往大陆通行证 CRED_PSN_PASSPORT - 护照 | ||||
authorizedInfo(点击“+”展开详情) | array | 否 | 本次授权详情 | ||||
authorizedScope | string | 否 | 用户授权范围
| ||||
effectiveTime | int64 | 否 | 授权生效时间(unix时间戳格式,单位:毫秒) | ||||
expireTime | int64 | 否 | 授权失效时间(unix时间戳格式,单位:毫秒) |
请求示例
GET https://openapi.esign.cn/v3/auth-flow/OF-1f7f8****608004f
响应示例
查询企业认证授权流程详情:
{
"code": 0,
"message": "成功",
"data": {
"authFlowId": "OF-1f7f8****608004f",
"authType": "ORG",
"realNameOrWillingness": "realName",
"realNameStatus": 1,
"authorizedStatus": 1,
"authInfo": {
"willingnessAuthModes": null,
"psnAuthMode": null,
"orgAuthMode": null,
"authFlowCreateTime": 1650020055000,
"authFlowUpdateTime": 1650020055000,
"person": {
"psnId": "c7e002947291**eea310541e7",
"psnAccount": {
"accountMobile": "183****0101",
"accountEmail": null
},
"psnInfo": {
"psnName": "赵四",
"psnNationality": null,
"psnIDCardNum": "130204********1001",
"psnIDCardType": "CRED_PSN_CH_IDCARD",
"bankCardNum": null,
"psnMobile": "183****0101"
},
"faceRecognitionInfo": {
"facePhotoUrl": null,
"similarityScore": null,
"livingScore": null
}
},
"organization": {
"orgId": "0c5bd492486b47f58d4ba96d5648bfbf",
"orgName": "esign企业",
"orgInfo": {
"orgType": null,
"orgIDCardNum": "913301******110212",
"orgIDCardType": "CRED_ORG_USCC",
"legalRepName": "这里是法定代表人的姓名",
"legalRepIDCardNum": "130204********1001",
"legalRepIDCardType": "CRED_PSN_CH_IDCARD"
}
}
},
"authorizedInfo": null
}
}
错误码
点击查看错误码