接口描述
对个人运营商三要素信息进行核验,成功后向手机号发送验证码。该接口可结合电子签名场景使用。
注:实名认证请提前为用户创建账号,【点击】前往创建个人账号;
接口
/v2/identity/auth/api/individual/{accountId}/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鉴权方式,请点击查阅详情。
请求参数
参数名称 | 类型 | 必选 | 参数位置 | 参数说明 |
accountId | string | 是 | path | 个人账号ID,通过创建个人账号接口获取 |
mobileNo | string | 是 | body | 手机号(仅限中国大陆3大运营商开通的手机号码) |
repetition | boolean | 否 | body | 是否允许账号重复实名(默认允许重复实名) |
contextId | string | 否 | body | 自定义业务标识,将在异步通知及跳转时携带返回对接方 |
notifyUrl | string | 否 | body | 认证结束后,异步通知地址,具体见 异步通知 章节说明 |
grade | string | 否 | body | 指定运营商3要素信息比对结果详情 ADVANCED - 详情版(核验失败时会返回具体不匹配信息) STANDARD - 普通版(默认值) 【注】详情版:需要单独购买,具体购买方式请咨询e签宝工作人员; 普通版:信息比对核验失败,不会返回具体的不匹配信息。 |
certificationPurpose | string | 否 | body | 本次实名用途,默认:INDIVIDUAL(个人认证) INDIVIDUAL - 个人认证 ORGANIZATION - 企业认证 注:
|
orgName | string | 否 | body | 企业名称(本次实名用途为企业认证时需传入)
|
orgCertNo | string | 否 | body | 企业证件号(本次实名用途为企业认证时需传入) 注:
|
响应参数
展开全部参数参数名称(点击左侧“+”一键展开) | 类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |
message | string | 是 | 错误信息 请根据 code 来判断错误情况,不应该依赖message匹配,因为 message 可能会调整。 | |
data | object | 否 | 业务信息 | |
flowId | string | 否 | 认证流程ID |
请求示例
{
"mobileNo": "188****8888",
"repetition": false,
"contextId": "f0a7927dxxxx1130d86c8fa8",
"notifyUrl": "http://172.xx.xx.10:8080/notify/msgRecive",
"grade":"ADVANCED"
}
响应示例
{
"code": 0,
"message": "成功”,
"data":{
"flowId": "7938573****1143859"
}
}
错误码
错误码 | 错误描述 | 解决方案 |
30500000 | 操作出错,请联系服务人员处理, ID:XXXX | 请核实入参格式是否正确 |
30500101 | 参数错误:手机号不能为空 | 请核实手机号是否为空 |
30500101 | 参数错误:请输入正确的手机号码! | 请输入真实有效的手机号 |
30500152 | 当前账户已实名 | 如需账号重复实名,需在请求时传入repetition字段 |
30500154 | 个人用户基本信息缺少必要属性:姓名 | 指定账号在实名前中未预先设置姓名属性 |
30500154 | 个人用户基本信息缺少必要属性:身份证号 | 指定账号在实名前中未预先设置身份证号 |
30500156 | 账号不存在,请检查accountId的正确性 | 请传入真实有效的accountId |
30500116 | 格式校验不通过,请检查填入信息是否有多余空格 | 请核实入参是否存在空格 |
30500150 | 未找到个人用户基本信息 | 请核实创建账号时是否传入个人信息 |
30503107 | 很抱歉,订单余额不足 | 请核实是否有购买认证服务套餐,或登录e签宝官网核实账单记录 |
30501002 | 运营商三要素信息核验失败,请检查信息正确性 | 请核实创建账号时,传入的个人信息是否真实存在并匹配 |
30501002 | 手机号并非使用此身份证办理 | 请检查手机号开户对应的身份信息是否与当前信息一致 |
30501002 | 姓名和⾝份证号不匹配 | 请检查姓名和证件号是否匹配 |