接口描述
获取组织机构实名认证地址。该接口可结合电子签名场景使用。
【注】实名认证请提前为企业和办理人创建账号,【点击】前往创建账号;
认证方式选择对公打款请注意:
(1)沙箱环境下,选择对公打款中的平台方向贵司打款方式进行企业实名认证,默认不会执行打款动作,开发者只需在回填金额中写入0.01进行确认提交,即可完成企业实名认证;正式环境下对公打款流程不变。
(2)对公打款申请次数超过次数上限,当日会被限制,隔天可以重新申请打款,无须获取新的flowid。金额回填校验失败超过3次,页面上可以直接重新申请打款,无须获取新的flowid。
接口
/v2/identity/auth/web/{accountId}/orgIdentityUrl
请求方式
POST
请求头
提供两种安全接入方式,对应参数如何获取,参考文档【请点击】。
方式一:请求签名鉴权(优先推荐)
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 应用ID |
X-Tsign-Dns-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鉴权方式,请点击查阅详情。
请求参数
展开全部参数参数名称(点击左侧“+”一键展开) | 类型类型 | 必选 | 参数位置 | 参数说明 | |
accountId | string | 是 | path | 组织机构账号ID,通过创建机构账号接口获取 | |
agentAccountId | string | 是 | body | 办理人账号ID,通过创建个人账号接口获取 | |
authType | string | 否 | body | 指定默认认证方式(打开认证页面所展示的第一个认证方式)
| |
availableAuthTypes | list | 否 | body | 指定页面可选的认证方式
| |
agentAvailableAuthTypes | list | 否 | body | 指定页面可选的办理人认证方式
【注】当选择个人刷脸认证方式默认包含以下四种分项的刷脸方式。 如需指定一种或其中几种具体的刷脸方式可选值如下:
【注】微信小程序-人脸识别方式默认不开启,如需使用请联系e签宝交付顾问,提供appid配置后方可使用。 | |
agentAuthAdvancedEnabled | list | 否 | body | 指定办理人通过银行卡认证或运营商认证方式时,是否使用详情版,如指定则核验失败可返回具体不匹配信息,传空默认为普通版。
【注】详情版:针对个人认证失败返回不匹配信息,需要单独购买,具体购买方式请咨询e签宝工作人员; 普通版:信息比对核验失败,不会返回具体的不匹配信息。 | |
receiveUrlMobileNo | string | 否 | body | 接收实名认证链接短信通知的手机号。传入手机号会发送邀请实名认证短信通知到该用户,并收取一次短信费用,不传入则不发送,不产生短信费用 | |
repeatIdentity | boolean | 否 | body | 是否允许重复实名,默认允许 | |
orgEntity | object | 否 | body | 组织机构基本信息 | |
name | string | 否 | body | 组织机构名称 | |
certNo | string | 否 | body | 组织机构证件号 | |
legalRepCertType | string | 否 | body | 法人证件类型 INDIVIDUAL_CH_IDCARD - 中国大陆身份证(默认值) INDIVIDUAL_CH_TWCARD - 台湾来往大陆通行证(台胞证) INDIVIDUAL_CH_HONGKONG_MACAO - 港澳来往大陆通行证(回乡证) INDIVIDUAL_PASSPORT - 护照 | |
legalRepCertNo | string | 否 | body | 法定代表人身份证号 | |
legalRepName | string | 否 | body | 法定代表人姓名 | |
agentName | string | 否 | body | 当前实名认证办理人姓名 | |
agentIdNo | string | 否 | body | 当前实名认证办理人证件号 | |
configParams | object | 否 | body | 认证页面配置信息 | |
orgUneditableInfo | list | 否 | body | 指定页面上不可修改的信息属性。
| |
contextInfo | object | 否 | body | 业务方交互上下文信息 | |
contextId | string | 否 | body | 自定义业务标识,在异步通知时发送回发起方 | |
notifyUrl | string | 否 | body | 发起方接收实名认证状态变更通知的地址,异步通知参考【请点击】 | |
origin | string | 否 | body | 认证发起来源,默认值为BROWSER BROWSER - 浏览器,APP - 移动端APP | |
redirectUrl | string | 否 | body | 认证结束后页面跳转地址,【点击】查看如何跳转回APP | |
showResultPage | boolean | 否 | body | 实名完成是否显示结果页,默认显示 |
响应参数
展开全部参数参数名称(点击左侧“+”一键展开) | 类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |
message | string | 是 | 错误信息 请根据 code 来判断错误情况,不应该依赖message匹配,因为message 可能会调整。 | |
data | object | 否 | 业务信息 | |
flowId | string | 否 | 认证流程ID | |
shortLink | string | 否 | 组织机构实名认证短链接(链接有效期30天) | |
url | string | 否 | 组织机构实名认证长链接(链接有效期30天) |
请求示例
{
"authType":"ORG_BANK_TRANSFER",
"availableAuthTypes":["ORG_BANK_TRANSFER","LEGAL_REP_AUTH"],
"agentAvailableAuthTypes":["PSN_TELECOM_AUTHCODE","PSN_FACEAUTH_BYURL_WEIZHONG"],
"agentAuthAdvancedEnabled":["PSN_TELECOM_AUTHCODE","PSN_BANK4_AUTHCODE"],
"agentAccountId":"ca991b71dcxxxx",
"contextInfo":{
"contextId":"20190822135330888",
"notifyUrl":"http://172.xx.xx.10:8080/notify/msgRecive",
"origin":"BROWSER",
"redirectUrl":"https://www.xx.cn/",
"showResultPage":"true"
},
"orgEntity":{
"certNo":"91440xxxxxxx",
"organizationType":1,
"name":"天谷信息科技有限公司",
"legalRepCertNo":"37140xxxxx",
"legalRepName":"xxx"
},
"repeatIdentity":"true"
}
响应示例
{
"code": 0,
"message": "成功",
"data": {
"url": "https://smlfront.esign.cn:8890/identity/login?param=zdRzb4Wgsbo7lz6WRomxeyuw4mpTFhXkZ8iCVHRd0mAjhXF1mFKd%2Bn4uLG4U%2BQyGgwLcyZTGL8lMHLx6JZBOGpYPb2ce0eXauyZc9d5Q%2Fa701YbkRpybArSa0rk3tklpQ4z%2F0M%2Bxxg9MVHXEAkuKmwfSOvpCBU5QZu4SKjuvG4E5fqka0EQH%2B12FaUYjswJXiZp3kdxJX9iw%2BKQR9EiIlOikH%2FrWmwhZ%2FQ%2B3Pehuy0fbPIwg2FPZUXsgY5p5NK7Q&appId=4438765518&lang=zh-CN",
"shortLink": "https://smlt.esign.cn/qqEulrPLq9vl",
"flowId": "208529****8854000"
}
}
错误码
错误码 | 错误描述 | 解决方案 |
30500000 | 操作出错,请联系服务人员处理, ID:XXXX | 请核实入参格式是否正确 |
30500150 | 未找到个人用户基本信息 | 请核实传入的办理人账号是否真实存在 |
30500151 | 未找到企业组织用户基本信息 | 请核实传入的企业账号是否真实存在 |
30500152 | 当前账户已实名 | 请核实入参repeatIdentity是否允许企业重复实名 |
30500156 | 账号不存在,请检查accountId的正确性 | 请核实待认证企业账号accountId是否正确 |
30500101 | 参数错误:XXXX | 请核实企业信息是否传入正确 |