接口描述
对个人姓名和个人证件号的一致性进行检查校验 。
【注】仅支持中国大陆身份证和港澳台居民居住证证件类型。
API在线调试
可通过API在线调试工具使用接口功能,入口:个人2要素信息比对
接口
/v2/identity/verify/individual/base
请求方式
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鉴权方式,请点击查阅详情。
请求参数
参数名称 | 类型 | 必选 | 参数位置 | 参数说明 |
idNo | string | 是 | body | 身份证件号码
|
name | string | 是 | body | 姓名 |
响应参数
展开全部参数参数名称(点击左侧“+”一键展开) | 类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |
message | string | 是 | 错误信息 请根据 code 来判断错误情况,不应该依赖message匹配,因为 message 可能会调整。 | |
data | object | 否 | 业务信息 | |
verifyId | string | 否 | 信息比对业务Id,请注意保存该参数 |
请求示例
{
"idNo":"3209261xxxxxxxx5276",
"name":"**"
}
响应示例
{
"code": 0,
"message": "成功”,
"data":{
"verifyId": "2d3b07ee-xx-xx-xx-b47af979d83c"
}
}
错误码
错误码 | 错误描述 | 解决方案 |
30500101 | 参数错误:身份证号不能为空 | 请核实身份证号是否为空 |
30500101 | 参数错误:请输入正确的身份证号码! | 请输入真实有效的身份证号 |
30500101 | 参数错误:姓名不能为空 | 请核实姓名是否为空 |
30500101 | 参数错误:请输入正确长度的姓名(2-20位) | 请输入真实有效的姓名 |
30504001 | 信息比对不通过,请检查信息的正确性 | 信息比对不通过,请核实姓名和证件号是否匹配 |