获取个人实名认证地址
接口描述
- 获取个人实名认证地址
接口地址
/v2/identity/auth/web/{accountId}/indivIdentityUrl
请求方式
POST
- 请求报文体采用Json数据格式,编码方式采用UTF-8编码
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
accountId | 待认证账号Id 个人账号创建详见:创建e签宝个人账号(电子签名场景专用) |
path | 是 | string |
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
authType | 指定默认认证类型, 详见:个人认证类型对照表 注:请先联系实施事先配置可用的认证类型 |
body | 否 | string |
availableAuthTypes | 指定页面可选择的认证方式, 详见:个人认证类型对照表 注:请先联系实施事先配置可用的认证类型 |
body | 否 | list |
contextInfo | 业务方交互上下文信息,有统计需求或者分账需求必填部分参数 | body | 否 | object |
indivInfo | 个人基本信息 | body | 否 | object |
configParams | 认证配置信息 | body | 否 | object |
repeatIdentity | 是否允许重复实名,默认允许 | body | 否 | boolean |
receiveUrlMobileNo | 接收实名认证邀请链接短信手机号。传入手机号会发送邀请短信到该用户,并收取一次短信费用,不传入则不发送,不产生短信费用 | body | 否 | string |
业务方交互上下文信息
参数名称 | 说明 | 参数类型 | 是否必须 | 类型 |
---|---|---|---|---|
contextId | 发起方业务上下文标识 在异步通知时发送回发起方 直接对接客户建议上传相关订单Id或会员Id 渠道分销商建议上传客户唯一Id |
body | 否 | string |
notifyUrl | 发起方接收实名认证状态变更通知的地址 | body | 否 | string |
origin | 认证发起来源,BROWSER - 浏览器;APP - 移动端APP。不填默认为为BROWSER | body | 否 | string |
redirectUrl | 认证结束后页面跳转地址.如果origin=APP,则需在该url参数中以key为esignAppScheme设置APP Scheme参数 | body | 是 | string |
showResultPage | 认证完成是否显示结果页,默认显示 | body | 否 | boolean |
个人认证基本信息
参数名称 | 说明 | 参数类型 | 是否必须 | 类型 |
---|---|---|---|---|
name | 个人姓名 | body | 否 | string |
nationality | 个人证件号所属地区/国籍 | body | 否 | string |
certType | 个人证件类型, 详见:个人认证证件类型对照表 |
body | 否 | string |
certNo | 个人证件号 | body | 否 | string |
mobileNo | 个人手机号 | body | 否 | string |
bankCardNo | 个人银行卡号(仅支持银联卡) | body | 否 | string |
认证配置信息
参数名称 | 说明 | 参数类型 | 是否必须 | 类型 |
---|---|---|---|---|
indivUneditableInfo | 指定页面上不可修改的信息属性。 详见:个人页面版认证信息属性名称对照表 创建e签宝账号时传入的信息属性在页面上固定不可修改;未传入的信息属性可通过此参数指定在页面上是否可修改,未指定的信息属性可以修改。 |
array | 否 | string |
请求示例
POST /v2/identity/auth/web/3c918cec17c04daa9a7bd2259ec3fe30/indivIdentityUrl HTTP/1.1
{
"authType": "PSN_BANK4_AUTHCODE",
"availableAuthTypes":["PSN_BANK4_AUTHCODE","PSN_FACEAUTH_BYURL"],
"contextInfo": {
"contextId": "57cc9602-d1b6-48bd-bdbb-61e9f8443955",
"notifyUrl": "https://www.notifyUrl.cn",
"origin": "BROWSER",
"redirectUrl": "https://www.redirectUrl.cn",
"showResultPage": true
},
"indivInfo": {
"name": "张三",
"nationality": "MAINLAND",
"certType": "INDIVIDUAL_CH_IDCARD",
"certNo": "362428199001010010",
"mobileNo": "18612345678",
"bankCardNo": "6227123412341234123"
},
"configParams": {
"indivUneditableInfo": ["name", "certNo", "mobileNo", "bankCardNo"]
},
"repeatIdentity": true,
"receiveUrlMobileNo": "13811111111"
}
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
code | 错误码 | int |
data | 业务信息 | 获取认证链接地址响应 |
message | 错误信息 | string |
获取实名认证链接地址响应数据
属性名称 | 说明 | 类型 |
---|---|---|
flowId | 认证流程Id | string |
shortLink | 认证地址短连接 | string |
url | 认证地址原始链接 | string |
响应示例
{
"code": 0,
"data": {
"flowId": "806735635690817476",
"shortLink": "https://testt.tsign.cn/AzPS1T0LtMqU",
"url": "http://testfront.tsign.cn:8890/identity/login?param=RjnJDvu5CYdgGzn5fC9z2iCGY0T2ytSFx08ZyMLVXwvkma7PPiwuic8hqMsyl5QdwbXxpdhLYs9EdWbklEHn8CQaTs8XW5K1DM2WmzI0imNASHNnCMZ3s42GMiwY02RdqHZ%2FS4sZCs%2F2c5mMPrDFwGHW72sv2yQ4h4IQH44%2BGJTwry6eCP3W49kd11lDEEtSnL737p7bh%2FhYvKrDSEYGdnfsLCvbxnd4bjzH1GcE7acg4%2BZXNZaQn23Nnvb2ZPhF7bSwFk7tZ6S4E7dbAECBeA%3D%3D"
},
"message": "成功"
}