1. 身份验证
验证身份信息与身份证号码中的信息是否一致
字段名 |
字段位置 |
字段类型 |
字段说明 |
举例 |
必选 |
apiv |
head |
string |
API版本,默认是1.0.0 |
1.0.0 |
可选 |
Authorization |
head |
string |
客户端保存的鉴权token |
Authorization字符串 |
必选 |
idno |
body |
string |
身份证号码,18位或者16位(16位身份证号码省去了出生年份的19) |
"32128319990905904X" |
必选 |
name |
body |
string |
姓名,长度大于2小于50字节 |
"姓名" |
必选 |
birthday |
body |
string |
出生年月日 |
"19990905" |
必选 |
validity |
body |
string |
身份证号码的有效期,格式为2012.03.22-2022.03.22或长期 |
"2012.03.22-2022.03.22" |
必选 |
address |
body |
string |
地址,如北京市海淀区xxxx |
"北京市海淀区XXXX" |
必选 |
issuer |
body |
string |
签发机关,格式为xx市公安局xx分局 |
"北京市公安局海淀分局" |
必选 |
sex |
body |
string |
性别,可以为"男"/"女"/"M"/"F",除此之外,还可以是一个0-9的奇数或偶数 |
"男" |
必选 |
nation |
body |
string |
民族 |
"汉" |
必选 |
返回数据
{
"error": 1,
"reason":"success",
"result": {
"birthday": 1,
"validity": 1,
"address": 1,
"sex": 1
}
}
成功返回
字段名 |
字段类型 |
字段说明 |
birthday |
int |
1=出生日期与身份证号码中的出生日期一致 ,0=不一致 |
validity |
int |
1=身份证有效期限合理,0=身份证有效期限不合理,其中年龄大于46有效期限应为长期,年龄大于26小于45有效期应为20年,年龄大于16小于25有效期应为10年,年龄小于16有效期应为5年 |
address |
int |
1=签发机关与住址匹配,0=签发机关与住址不匹配 |
sex |
int |
1=性别与身份证号码中的性别匹配,0=不匹配 |
失败返回
{
"error": 1,
"reason": "失败原因",
"result": {"失败的参考数据"},
}
1.1. 错误码
错误码来自于error字段
错误码 |
错误码名 |
说明 |
可能原因 |
2000 |
服务成功完成 |
成功 |
服务成功完成。 |
2015 |
身份信息无效 |
成功 |
以下几种情况会返回"身份信息无效":1.身份证号码不正确,按规定身份证号码必须为15位或18位,前6位为地区代码,7至14位为出生日期,除最后一位外其余位为0-9数字(最后一位可为x或X)并且身份证号要符合校验算法。2.无效的姓名,姓名应大于2小于50;3.无效的出生日期,出生日期的格式应为年-月-日且不能为负数;3.无效的有效期,有效期的格式应为"2012.07.03-2022.07.03";4.无效的住址即住址不存在 5.无效的签发机关,签发机关的格式不符合xx公安局xx分局或者签发机关不存在;5.无效的性别,输入了除"男"/"女"/"M"/"F"或0-9的奇数或偶数的性别字段;6.无效的民族,输入的民族不存在 |
2016 |
身份验证错误 |
成功 |
以下四种情况会返回"身份验证错误":1.出生日期与身份证号码不匹配;2.身份证有效期限不合理,按规定年龄大于46有效期限应为长期,年龄大于26小于45有效期应为20年,年龄大于16小于25有效期应为10年,年龄小于16有效期应为5年;3.签发机关与住址不匹配;4性别与身份证号码不匹配;3.签发机关与住址不匹配;4性别与身份证号码不匹配;3.签发机关与住址不匹配;4性别与身份证号码不匹配,按规定,在15位的身份证中,第15位表示性别,在18位身份证中,第17位表示性别,奇数为男偶数为女 |
1.2. Browser SDK调用示例代码
async function test_addIdcardValidation() {
const ham = await hannm({
APP_KEY: "aHEVYhE1",
APP_SECRET: "f34b127abc7cca1862dac91db6256190",
})
const res = await ham.addIdcardValidation({
idno :"340406199512301413",
name :"吴仲狄",
birthday:"19951230",
validity:"1994.07.14-2004.07.14",
address :"南京市鼓楼区街8号",
issuer :"南京市公安局鼓楼分局",
sex :"1",
nation :"维吾尔"
})
api_name = "身份验证";
console.log(res);
if(res.error == 0){
got_ugrp_id = res.result.id;
console.log(api_name+"成功 "+got_ugrp_id);
}else{
got_ugrp_id = res.result.id;
console.log(api_name+"失败 "+res.reason);
}
}
{
error : 0,
result : { birthday: 1, sex: 1, address: 1, validity: 1 },
reason : 'success'
}