实名认证能力接口开发指南
1.能力介绍
实名认证是基于手机号码、姓名、身份证号码是否一致的校验服务,采用实名认证能力无需用户上传身份证信息,毫秒实现用户实名信息的校验,大大提升产品的体验。
实名认证流程如下:
1.接入方通过接口方式传入用户脱敏信息:手机号码、身份证、姓名信息到天翼账号平台;
2.天翼账号平台调用实名认证接口较验三要素/二要素信息,并将校验结果返回(Y/N)
2.能力说明
实名认证能力可分为二要素认证和三要素认证。
二要素认证是指手机号与姓名,手机号与身份证号码是否匹配,需合作方提供手机号,姓名或身份证号码给予天翼账号,天翼账号将校验后的结果是否一致传输给合作方。
三要素认证是指手机号、姓名和身份证号码是否匹配,需合作方提供手机号,姓名、身份证号码给予天翼账号,天翼账号将校验后的结果是否一致传输给合作方。
3.能力对接
3.1 交互流程
天翼账号平台:服务主要提供方,提供验证手机号与姓名及身份证号是否一致的服务;
合作方平台:传入校验的手机号码、身份证/姓名等脱敏信息
3.2.对接指引
3.2.1 三要素验证
应用场景
业务端调用该接口对用户手机号码、姓名及身份证是否匹配。
接口定义
接口名称 | authCloudUserInfo.do |
接口描述 | 验证手机号与姓名及身份证号是否匹配 |
承载协议 | HTTPS |
承载网络 | 公网 |
请求方式 | POST |
数据格式 | Json |
约束 | 无 |
接口URL | https://open.e.189.cn/openapi/bus/authCloudUserInfo.do |
公共请求参数:
字段标识 | 说明 | 数据类型 | 长度 | 可空 |
---|---|---|---|---|
clientId | 申请应用时分配的AppID | String | 60 | N |
timeStamp | 时间戳,毫秒 | Long | 18 | N |
sign | sign=HMAC-SHA1(请求参数升序拼接值,appSecret) | String | 100 | N |
clientIp | 客户端的ip | String | 60 | Y |
version | 版本号 | String | 10 | N |
clientType | 客户端类型,具体说明参见附录2 | String | 10 | N |
私有请求参数:
字段标识 | 说明 | 数据类型 | 长度 | 可空 |
---|---|---|---|---|
mobile | 手机号码 | String | 20 | N |
name | 用户姓名,与certCard不可同时为空 | String | 20 | N |
certCard | 身份证号后四位 | String | 20 | N |
certType | 证件类型, 默认1:身份证 | String | 2 | Y |
响应参数
字段标识 | 说明 | 数据类型 | 长度 | 字段含义 | 可空 |
---|---|---|---|---|---|
msg | 如果result不等于0,会有相应的错误信息提示,返回数据全部用UTF-8编码 | String | 256 | 获取验证码出错信息 | N |
result | 0表示操作成功,非0表示操作失败 | int | 5 | 操作结果返回码 | N |
status | 成功为:SUCCEED 失败为:FAIL | String | 256 | 验证结果 | Y |
time | 如:2016-04-12 18:36:48 | String | 10 | 结果状态 | Y |
data | 详细信息 | 详细信息 | Y | ||
idTypeCheckResult | -1:不做验证 0:验证一致; 1:验证不一致 | String | 10 | 身份证件类型校验结果 | Y |
idNoCheckResult | -1:不做验证 0:验证一致; 1:验证不一致 | String | 10 | 身份证件号码校验结果 | Y |
nameCheckResult | -1:不做验证 0:验证一致; 1:验证不一致 | String | 10 | 姓名校验结果 | Y |
成功返回结果
{ "result":0, "msg":"操作成功", "status":"SUCCEED", "time":" 2015-03-16 16:30:19", "trace":"", "data": { "idTypeCheckResult": 0, "idNoCheckResult": 0 "nameCheckResult": 0 } }
3.2.2 二要素验证
应用场景
业务端调用该接口对用户手机号码与身份证校验。
接口定义
接口名称 | verifyNumCertcard.do |
接口描述 | 验证手机号与身份证号是否一致 |
承载协议 | HTTPS |
承载网络 | 公网 |
请求方式 | POST |
数据格式 | Json |
约束 | 无 |
接口URL | https://open.e.189.cn/api/oauth2/account/credit/verifyNumCertcard.do |
公共请求参数:
字段标识 | 说明 | 数据类型 | 长度 | 可空 |
---|---|---|---|---|
clientId | 申请应用时分配的AppID | String | 60 | N |
timeStamp | 时间戳,毫秒 | Long | 18 | N |
sign | sign=HMAC-SHA1(请求参数升序拼接值,appSecret) | String | 100 | N |
clientIp | 客户端的ip | String | 60 | Y |
version | 版本号 | String | 10 | N |
clientType | 客户端类型,具体说明参见附录2 | String | 10 | N |
私有请求参数:
字段标识 | 说明 | 数据类型 | 长度 | 可空 |
---|---|---|---|---|
mobile | 手机号码 | String | 20 | N |
name | 用户姓名,与certCard不可同时为空 | String | 20 | N |
certCard | 身份证号后四位 | String | 20 | N |
响应参数
字段标识 | 说明 | 数据类型 | 长度 | 字段含义 | 可空 |
---|---|---|---|---|---|
msg | 如果result不等于0,会有相应的错误信息提示,返回数据全部用UTF-8编码 | String | 256 | 获取验证码出错信息 | N |
result | 0表示操作成功,非0表示操作失败 | int | 5 | 操作结果返回码 | N |
isMatch | true:是 false:否 | String | 256 | 验证结果 | Y |
成功返回结果
{ "result":0, "isMatch":true, "msg":"处理成功" }
应用场景
业务端调用该接口对用户手机号与姓名校验。
接口定义
接口名称 | verifyNameNum.do |
接口描述 | 验证手机号与姓名是否一致 |
承载协议 | HTTPS |
承载网络 | 公网 |
请求方式 | POST |
数据格式 | Json |
约束 | 无 |
接口URL | https://open.e.189.cn/api/oauth2/account/credit/verifyNameNum.do |
公共请求参数:
字段标识 | 说明 | 数据类型 | 长度 | 可空 |
---|---|---|---|---|
clientId | 申请应用时分配的AppID | String | 60 | N |
timeStamp | 时间戳,毫秒 | Long | 18 | N |
sign | sign=HMAC-SHA1(请求参数升序拼接值,appSecret) | String | 100 | N |
clientIp | 客户端的ip | String | 60 | Y |
version | 版本号 | String | 10 | N |
clientType | 客户端类型,具体说明参见附录2 | String | 10 | N |
私有请求参数:
字段标识 | 说明 | 数据类型 | 长度 | 可空 |
---|---|---|---|---|
mobile | 手机号码 | String | 20 | N |
name | 用户姓名 | String | 20 | N |
响应参数
字段标识 | 说明 | 数据类型 | 长度 | 字段含义 | 可空 |
---|---|---|---|---|---|
msg | 如果result不等于0,会有相应的错误信息提示,返回数据全部用UTF-8编码 | String | 256 | 获取验证码出错信息 | N |
result | 0表示操作成功,非0表示操作失败 | int | 5 | 操作结果返回码 | N |
isMatch | true:是 false:否 | String | 256 | 验证结果 | Y |
成功返回结果
{ "result":0, "isMatch":true, "msg":"处理成功" }