接口描述
对个人运营商三要素信息进行核验,成功后向手机号发送验证码,需要调用【手机号认证】短信验证码校验 接口进行验证码回填,回填成功才算完成了核身认证。
【注】核身认证无需提前为用户创建账号;
API在线调试
可通过API在线调试工具使用接口功能,入口:发起运营商3要素核身认证
接口
/v2/identity/auth/api/individual/telecom3Factors
请求方式
POST
请求头
提供两种安全接入方式,对应参数如何获取,参考文档【请点击】。
方式一:请求签名鉴权(优先推荐)
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-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鉴权方式,请点击查阅详情。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
name | string | 是 | body | 姓名 |
idNo | string | 是 | body | 身份证号 |
mobileNo | string | 是 | body | 手机号(仅限中国大陆11位手机号) |
contextId | string | 否 | body | 自定义业务标识,将在异步通知及跳转时携带返回对接方 |
notifyUrl | string | 否 | body | 实名结束后异步通知地址,具体见 异步通知 章节说明 |
grade | string | 否 | body | 指定运营商3要素信息比对结果详情 ADVANCED - 详情版(核验失败时会返回具体不匹配信息) STANDARD - 普通版(默认值) 【注】详情版:需要单独购买,具体购买方式请咨询e签宝工作人员; 普通版:信息比对核验失败,不会返回具体的不匹配信息。 |
source | int | 否 | body | 指定运营商3要素信息比对来源,默认0 |
0 - 权威库比对; 对用户3要素进行权威数据源的比对,收取运营商3要素信息比对费用 | ||||
1 - 可信数据比对; 可信核身数据有效期内,直接发送短信验证码,仅收取短信费用,若无可信数据,接口会报错(限在当前appId下做过运营商3要素核身认证,一年内可以免除信息比对,直接发送验证码场景使用,并且需保证姓名、身份证号和手机号三者与之前的认证数据完全一致) | ||||
2 - 优先策略比对; 优先进行可信数据源比对,若无可信数据,则进行权威库比对(为了避免直接使用 “1- 可信数据比对”造成接口报错,建议传2,由e签宝自动判断) |
响应参数
展开全部参数参数名称(点击左侧“+”一键展开) | 类型 | 必选 | 参数说明 | ||
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | ||
message | string | 是 | 错误信息 请根据 code 来判断错误情况,不应该依赖message匹配,因为 message 可能会调整。 | ||
data | object | 否 | 业务信息 | ||
flowId | string | 否 | 本次核身认证流程ID | ||
behavior | object | 否 | 本次核身认证流程行为数据 【注】仅在请求参数source指定:1或2时返回该对象 | ||
source | int | 否 | 本次核身认证数据来源: 0 - 权威库比对:运营商3要素信息比对 + 短信验证 1 - 可信数据比对:短信验证 | ||
refFlowId | string | 否 | 关联的权威库认证完成的核身流程(响应参数source为1时该参数返回值) | ||
refFlowTime | int64 | 否 | 关联的refFlowId核身认证完成时间,unix时间戳(毫秒)格式 | ||
refFlowExpired | int64 | 否 | 关联的refFlowId核身认证流程的有效期截止时间,unix时间戳(毫秒)格式 |
请求示例
{
"name": "**",
"idNo": "320926xxxxxxxx5276",
"mobileNo": "188****8888",
"contextId": "f0a7927dxxxx1130d86c8fa8",
"notifyUrl": "http://172.xx.xx.10:8080/notify/msgRecive",
"grade": "ADVANCED",
"source": 2
}
响应示例
信息比对来源source(请求参数)为1或者2场景:
{
"code": 0,
"message": "成功",
"data": {
"flowId": "3324********6753",
"behavior": {
"source": 1,
"refFlowId": "332******507288",
"refFlowTime": 1712890644000,
"refFlowExpired": 1744426644000
}
}
}
信息比对来源source(请求参数)为0场景:
{
"code": 0,
"message": "成功",
"data": {
"flowId": "3324********493"
}
}
错误码
错误码 | 错误描述 | 解决方案 |
30500000 | 操作出错,请联系服务人员处理, ID:XXXX | 请核实入参格式是否正确 |
30500101 | 参数错误:姓名只支持中文/点符号·/半角逗号 | 请输入真实有效的姓名 |
30500101 | 参数错误:请输入正确的身份证号码 | 请输入真实有效的身份证件号码 |
30500101 | 参数错误:请输入正确的手机号码 | 请输入真实有效的运营商认证手机号 |
30500101 | 参数错误:name不能为空 | 请核实姓名是否为空 |
30500101 | 参数错误:idNo不能为空 | 请核实证件号是否为空 |
30500101 | 参数错误:mobileNo不能为空 | 请核实手机号是否为空 |
30500116 | 格式校验不通过,请检查填入信息是否有多余空格 | 请核实入参是否存在空格 |
30503107 | 很抱歉,订单余额不足 | 请核实是否有购买认证服务套餐,认证套餐是否生效,以及对应子服务是否开通。 |
30501002 | 运营商三要素信息核验失败,请检查信息正确性 | 请核实创建账号时,传入的个人信息是否真实存在并匹配 |
30501002 | 手机号并非使用此身份证办理 | 请检查手机号开户对应的身份信息是否与当前信息一致 |
30501002 | 姓名和⾝份证号不匹配 | 请检查姓名和证件号是否匹配 |
30500056 | 无法核实身份,可信核身流程不存在,请将source切换到0或者2后重新发起 | 该用户信息在自2024年4月12日起的一年内 ,在当前appId下没有做过运营商3要素核身认证,不能指定source为1 |
30500100 | 缺少参数:source类型不支持 | 请输入正确的信息比对来源枚举值(source) |