实名认证

开发文档

更新时间：2025-03-20 15:11:59

一、身份证校验

日期	版本	修订内容摘要
2023-08-18	v2.0.0	更新接口文档

1.协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/idcard/id-card-auth
并发说明	50QPS（特殊需求联系运营）

2.请求参数说明

请求参数 Body 以 multipart/form-data 方式提交

参数名	说明
appId	请在https://www.chuanglan.com/ 登录后获取
appKey	请在https://www.chuanglan.com/ 登录后获取
name	姓名
idNum	身份证号码

3.响应参数说明

响应 body 数据为 JSON 格式

字段名	类型	说明
chargeStatus	int	1:收费；0：不收费
code	String	响应 code 码。200000：成功，其他失败。
message	String	响应 code 码解释
data	Object
orderNo	String	业务唯一流水号。例：628291418130630
handleTime	String	查询时间例：2018-04-09 15:05:01
province	String	省份
city	String	市区
country	String	县区
birthday	String	生日，格式是 yyyyMMdd
age	String	年龄
gender	String	性别：1：男、2：女
remark	String	备注，例：一致 (对结果的说明，不能作为判断条件)
result	String	返回结果： 01-认证一致(收费) 02-认证不一致(收费) 03-认证不确定（不收费） 04-认证失败(不收费)

4.响应返回实体 DEMO

{
    "chargeStatus":1,
    "message":"成功",
    "data":{
        "orderNo":"011668751216213704",
        "handleTime":"2022-11-18 14:00:16",
        "result":"01",
        "remark":"一致",
        "province":"安徽省",
        "city":"安庆市",
        "country":"太湖县",
        "birthday":"19940613",
        "age":"29",
        "gender":"1"
    },
    "code":"200000"
}

5.失败返回实体

{
    "chargeStatus":0,
    "message":"失败",
    "data": null,
    "code":"500"
}

二、身份证校验 V2（签名版）

1.协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/idcard/id-card-auth/vs
并发说明	50QPS（特殊需求联系运营）

2.请求参数说明

请求参数 Body 以 multipart/form-data 方式提交

参数名	说明
appId	请在https://www.chuanglan.com/ 登录后获取
name	姓名
idNum	身份证号码
sign	签名。按 appId+idNum+name 顺序，将参数名称和值拼接，例如"appIdAbcd1234idNum430512198908131367name 代用名"，之后以 appKey（控制台获得）为密钥，使用 hmacSHA1 签名后经 Base64 编码得到。

3.响应参数说明

响应 body 数据为 JSON 格式

字段名	类型	说明
code	String	响应 code 码。200000：成功，其他失败。见附录 5.1 响应 code 码
message	String	响应 code 码解释
data	Object
orderNo	String	业务唯一流水号。例：628291418130630
handleTime	String	查询时间例：2018-04-09 15:05:01
province	String	省份
city	String	市区
country	String	县区
birthday	String	生日，格式是 yyyyMMdd
age	String	年龄
gender	String	性别：1：男、2：女
remark	String	备注，例：一致 (对结果的说明，不能作为判断条件)
result	String	返回结果： 01-认证一致(收费) 02-认证不一致(收费) 03-认证不确定（不收费） 04-认证失败(不收费)

4.响应返回实体 DEMO

{
    "chargeStatus": 1,
    "message": "成功",
    "data": {
        "orderNo": "011569554991100011",
        "handleTime": "2018-06-29 13:18:24",
        "result": "02",
        "province": "湖南省",
        "city": "怀化市",
        "country": "辰溪县",
        "birthday": "19890725",
        "age": "29",
        "gender": "1",
        "remark": "不一致"
    },
    "code": "200000"
}

5.失败返回实体

{
    "chargeStatus":0,
    "message":"失败",
    "data": null,
    "code":"500"
}

三、身份证校验（有效期版）

1.协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/idcard/id-card-auth-valid
并发说明	30QPS（特殊需求联系运营）

2.请求参数说明

请求参数 Body 以 multipart/form-data 方式提交

参数名	类型	说明
appId	String	请在https://www.chuanglan.com/ 登录后获取
appKey	String	请在https://www.chuanglan.com/ 登录后获取
name	String	姓名
idNum	String	身份证号码
startTime	String	身份证有效开始日期 (示例：2024-01-01)
endTime	String	身份证有效结束日期 (示例：2034-01-01)

3.响应参数说明

响应 body 数据为 JSON 格式

字段名	类型	说明
chargeStatus	Int	是否收费
code	String	响应 code 码。200000：成功，其他失败。见附录 5.1 响应 code 码
message	String	响应 code 码解释
data	Object
orderNo	String	业务唯一流水号。例：628291418130630
handleTime	String	查询时间例：2018-04-09 15:05:01
province	String	省份
city	String	市区
country	String	县区
birthday	String	生日
age	String	年龄
gender	String	性别：1：男、2：女
remark	String	备注，例：一致 (对结果的说明，不能作为判断条件)
result	String	返回结果： 01-认证一致(收费) 02-认证不一致(收费) 03-认证不确定（不收费） 04-认证失败(不收费)

4.响应返回实体 DEMO

{
    "chargeStatus": 1,
    "message": "成功",
    "data": {
        "orderNo": "011569554991100011",
        "handleTime": "2018-06-29 13:18:24",
        "result": "02",
        "province": "湖南省",
        "city": "怀化市",
        "country": "辰溪县",
        "birthday": "19890725",
        "age": "29",
        "gender": "1",
        "remark": "不一致"
    },
    "code": "200000"
}

5.失败返回实体

{
    "code": "500000",
    "success": false,
    "message": "系统异常",
    "chargeStatus": 0
}

四、涉外身份证校验

1.协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/idcard/id-card-auth-foreign-sign
并发说明	50QPS（特殊需求联系运营）

2.请求参数说明

请求参数 Body 以 multipart/form-data 方式提交

参数名	是否必须	说明
appId	是	应用id 请在https://www.chuanglan.com/ 登录后获取
appKey	是	应用key 请在https://www.chuanglan.com/ 登录后获取
name	是	姓名
idNum	是	证件号
nation	是	国家名英文缩写，除港澳以外参照ISO3166标准，华侨、港澳和台湾人员使用CHN
idType	是	证件类型，414-华侨护照，516-港澳居民来往内地通行证，511-台湾台湾居民来往大陆通行，553-外国人永久居留身份证
sign	是	签名。按appId+appKey+idNum+idType+name+nation顺序，将参数名称和值拼接，之后以appKey（控制台获得）为密钥，使用hmacSHA1签名后经Base64编码得到。示例：System.out.println(EncryptUtils.hmacSHA1Encrypt("appIdmRXI45AIappKeyf5oO8y4eidNumC5NFV8Z8GidType414nameWALDEMAR ANTON LELZnationFRA", "f5oO8y4e"));

3.响应参数说明

响应 body 数据为 JSON 格式

字段名	类型	说明
chargeStatus	int	是否收费。1 ：收费 0：不收费
code	string	响应 code 码。200000：成功，其他失败。请对照万数状态码
message	string	响应 code 码解释
data	Object	返回对象
orderNo	String	业务唯一流水号。例：628291418130630
handleTime	String	查询时间例：2018-04-09 15:05:01
result	String	状态码(01：一致（收费）,02：不一致（收费）,03：认证不确定（不收费）,04：认证失败（不收费）)
remark	String	状态描述
isValid	String	证件是否有效(0-证件无效 1-证件有效 2-无法确认)

4.响应返回实体 DEMO

{
    "chargeStatus": 1,
    "message": "成功",
    "data": {
        "orderNo": "011711700418100003",
        "handleTime": "2024-03-29 16:20:19",
        "result": "01",
        "remark": "一致",
        "isValid": "1"
    },
    "code": "200000"
}

5.失败返回实体

{
    "code": "500000",
    "success": false,
    "message": "系统异常",
    "chargeStatus": 0
}

五、身份证四要素V2（有效期版校验）

1.协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://wsapi.253.com/open/idcard/four-parameter
并发说明	30QPS（特殊需求联系运营）

2.请求参数说明

请求参数 Body 以 application/x-www-form-urlencoded 方式提交

参数名	字段类型	是否必填	说明
appId	string	是	请在https://www.chuanglan.com/ 登录后获取
appKey	string	是	请在https://www.chuanglan.com/ 登录后获取
chName	string	是	姓名
idNum	string	是	身份证号码，限单个
startDate	string	是	身份证有效开始日期，20170206
endDate	string	是	身份证有效结束日期，20270206
idType	string	是	证件类型，详见“证件类型”（暂只支持01身份证）
mchInfo	string	是	商户信息（商户名称）
riskInfo	string	是	授权协议编号，公民对商户使用其个人信息进行查询的确权协议。提供这个协议对应的编号即可，授权编号由商户拟定，创蓝对协议编号规则暂无要求。可传：B20241010

3.响应参数说明

响应 body 数据为 JSON 格式

字段名	类型	说明
chargeStatus	Int	是否收费
code	String	响应 code 码。200000：成功，其他失败。见附录 5.1 响应 code 码
reqId	String	请求唯一的id
message	String	响应 code 码解释
data	Object	返回对象
data>>remark	String	备注，例：一致
data>>result	String	校验结果：01：一致（收费）02：不一致（不收费）03：认证不确定（不收费）04：认证失败（不收费）
data>>orderNo	String	业务唯一流水号。例：628291418130630

4.证件类型

枚举名称	枚举值
身份证	01

5.响应一致-示例

{
    "code": "200000",
    "message": "success",
    "reqId": "1198531487920554540",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
        "result": "01",
        "remark": "认证一致",
        "orderNo": "1198531487920554540"
    }
}

6.响应不一致-示例

{
    "code": "200000",
    "message": "success",
    "reqId": "1198531487920580372",
    "chargeStatus": 0,
    "chargeCount": "0",
    "data": {
        "result": "02",
        "remark": "认证不一致",
        "orderNo": "1198531487920580372"
    }
}

7.入参不符合异常-示例

{
    "code": "200000",
    "message": "success",
    "reqId": "1189524288460154805",
    "chargeStatus": 0,
    "chargeCount": "0",
    "data": {
        "result": "03",
        "remark": "系统异常：请求报文参数有误[startDate]",
        "orderNo": "1189524288460154805"
    }
}

8.请求失败-结果示例

{
    "code": "500000",
    "message": "有效期开始日期不能为空",
    "reqId": "1180517088999589852",
    "chargeStatus": 0,
    "data": null
}

code码解释

code码解释见：code码解释

没有更多了

上一篇：功能介绍

下一篇：常见问题

文档目录

收缩

注册登录

新客获客

老客激活

金融行业

游戏行业

电商行业

餐饮行业

私有云

产品中心

联系我们

注册登录

新客获客

老客激活

金融行业

游戏行业

电商行业

餐饮行业

私有云

热门搜索

中国站

国际站

实名认证

开发文档

一、身份证校验

二、身份证校验 V2（签名版）

三、身份证校验（有效期版）

四、涉外身份证校验

五、身份证四要素V2（有效期版校验）

code码解释

注册登录

新客获客

老客激活

金融行业

游戏行业

电商行业

餐饮行业

私有云

热门搜索

中国站

国际站

实名认证

开发文档

一、 身份证校验

二、 身份证校验 V2（签名版）

三、 身份证校验（有效期版）

四、 涉外身份证校验

五、 身份证四要素V2（有效期版校验）

code码解释

一、身份证校验

二、身份证校验 V2（签名版）

三、身份证校验（有效期版）

四、涉外身份证校验

五、身份证四要素V2（有效期版校验）