接口说明
1,验证用户的身份信息(姓名,证件号)是否匹配,目前只支持身份证。
2,调用该接口本身不会对网易宝的用户信息及用户状态有任何改动,只是单纯去公安网通道校验姓名身份证是否匹配。
3,本接口每日调用次数限制为10000次,如要调整,可联系网易支付商户人工客服。
数据格式
请求网易宝和通知商户的接口采用统一的参数定义规则:
参数 | 参数名称 | 长度 | 必填 | 样例 |
sign | 根据msg和算法签名后的字符 | String | 是 | |
msg | 消息体,根据"业务参数"列表,拼装而成的消息体 | String | 是 | |
msgType | 消息类型,XML,JSON | String | 是 | XML |
比如:https://epay.163.com/api/real_name_check.htm?msg=&sign=&msgType=,其中msg、msgType和sign是必填参数。msgType:XML或者JSON
如果有特殊字符为避免请求被转码等问题,每个参数发送时需进行UrlEncode, msg,msgType,sign本身不需要encode
商户使用CA签名方式:此接口中的msg和sign的CA签名算法请参考文档,链接如下:
接口地址
https://epay.163.com/api/real_name_check.htm?msg=&sign=&msgType=
请求参数
参数名称 | 参数 | 必填 | 长度 | 样例 |
---|---|---|---|---|
版本号 | version | 是 | 8 | 1.0.0 |
操作名称 | action | 是 | 30 | real_name_check |
商户平台ID | platformId | 是 | 50 | 2013090421PT17189296 |
用户ID | accountId | 是 | 12 | 111@163.com,非网易账号体系,请传入gate@wyb.163.com |
证件类型 | identityType | 是 | 1 | 0:身份证 1:护照 2:港澳台通行证 3:军官证 目前仅支持身份证,请传0 |
证件号 | identityNo | 是 | 18 | 身份证仅支持18位 |
姓名 | realName | 是 | 40 | 姓名 |
是否显示照片 | showImg | 否 | 10 | true:显示照片(权限需单独申请INI中REAL_NAME_CHECK_SHOW_IMG_POWER) |
是否自动升级账户级别 | autoUpdateGrade | 否 | 10 | true-自动升级,false-不升级 |
自动升级账户级别 | grade | 否 | 10 | 1-一类账户,2-二类账户,3-三类账户 |
调用方请求ID | requestId | 否 | 10 | 商户传入的请求ID,用于记录每次调用,最大32位 |
返回参数
参数 | 参数名称 | 是否为空 | 样例 |
---|---|---|---|
msg | 处理结果报文 | 如果查询失败为空 | (当没有showImg=true时)返回值进行base64.decode后的结果为: SUCCESS:成功(身份信息匹配) FAILED:失败(身份信息不匹配) EXCEED:调用超限(账号或IP超过阈值) ERROR:网络繁忙 BLACK:证件号在黑名单 NOT_EXIST:库无(公安网没有该身份证,或者用户身份证在迁移中或已注销) |
sign | Msg签名信息 | 如果查询失败为空 | |
operationCode | 返回码 | 不为空 | 0000 |
errorMsg | 错误内容 | 如果查询失败, 返回错误详细信息;查询成功为空 | msg_is_null |
Msg中的参数说明
参数名称 | 参数 | 描述 | 样例 |
---|---|---|---|
验证结果 | result | 验证结果 | SUCCESS |
图片 | img | 只在result=SUCESS时才会返回),对图片字节流base64后的内容 | WSDHYG2SS |
描述 | description | 对result的描述 | 您的姓名和身份证号码不匹配,请修改 |
result和description对应表:
result | description | 备注 |
---|---|---|
FAILED | 您的姓名和身份证号码不匹配,请修改 | 不匹配,有极小概率误判,误判多是由用户换过姓名引起。可联系网易宝客服@李斌处理 |
SUCCESS | 姓名和身份证号码校验成功 | 验证成功 |
EXCEED | 您今日尝试次数受限,请明日再试 | 超过网易宝分配给商户的每日限额(预分配每日1w) |
ERROR | 网络繁忙,请稍后再试 | 接口公安网时调用异常 |
BLACK | 证件号码存在风险,请更换 | 在网易宝风控黑名单中 |
NOT_EXIST | 您的姓名和身份证号码不匹配,请修改 | 用户户口迁移中,或者已经注销。或者证件号本身就是不存在的 |
注:
1,上述描述字段可能会有调整,result状态可能新增,请开发时注意风险。
2,获取不到图片的情形有哪些?
答:当前证件姓名校验不通过;当前通道不是公安网通道;公安网网络或系统原因导致WebServcie接口不能正常访问;NOS云存储访问异常。以上情形无法返回图片。并不会提示用户具体原因。
3,接口调用时显示PLATFORM_NOT_SUPPORT_SHOW_IMG_PARAMETER异常?
答:除了申请开通接口权限,还需请开通返回图片的权限,申请方式请咨询网易支付商户人工客服。只有当showImg参数为true时,才会出现该报错