出入境信息核验接口
2024.11.20 10:20:47
通过对比权威数据源,对港澳台居民来往内地、定居国外的中国公民等用户上传的姓名、身份证号,判断证件的真实性,返回对比结果
接口说明
该接口返回结果状态分以下两种:
- 认证不通过:表示确认证件信息不一致,产品可驳回认证申请,不通过的原因可通过ReasonType字段获取。
- 认证通过:表示确认证件信息完全一致,产品直接通过该认证申请。
鉴权说明
易盾信息认证服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature参数),以验证用户身份,防止信息被恶意篡改。目前支持MD5,SHA1,SHA256,SM3几种加密算法,详细信息,请参见接口鉴权
请求
请求地址
名称 | 值 |
---|---|
HTTP URL | https://verify.dun.163.com/v1/foreign/check |
HTTP Method | POST |
请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | String | 是 | 固定值:"application/x-www-form-urlencoded" |
请求参数
请求参数由请求公共参数和请求业务参数两部分组成,通用参数见请求通用字段
名称 | 类 型 | 必填 | 最大长度 | 描述 |
---|---|---|---|---|
name | String | 是 | 32 | 用户真实姓名,以相关证件上的姓名为准 |
cardNo | String | 是 | 18 | 证件号 |
verifyType | String | 是 | 11 | 证件类型,证件类型,"1"-港澳台居民来往内地通行证,"2"-外国人永久居留身份证,"3"-定居国外的中国公民护照(华侨),"4"-港澳台居住证,"5"-内地的中国居民护照 |
nation | String | 是 | 15 | 国家或地区三位大写英文字母缩写,除港澳台以外参照ISO3166标准,港澳台居民和定居国外的中国公民使用CHN |
dataId | String | 否 | 64 | 数据标识,可传入用户标识等数据,便于数据查询 |
请求体示例
name=张三&cardNo=341622123456784317&verifyType=1&nation=CHN&version=v1&businessId=xxx×tamp=1638180222235&nonce=xxx&secretId=xxx&signature=xxx
响应
响应结果
响应字段如下,响应通用字段已省略,详细见响应公共字段
参数名称 | 类型 | 必须返回 | 描述 |
---|---|---|---|
status | Number | 是 | 认证结果,1-通过 2-不通过(原因见reasonType) 0-待定 |
reasonType | Number | 否 | 原因详情 2-输入姓名和证件号不一致 7-系统繁忙 8-国籍参数格式错误 9-证件号或国籍参数格式错误 |
taskId | String | 是 | 本次请求数据标识,可以根据该标识查询数据最新结果 |
isPayed | Number | 是 | 本次请求是否收费标识,1代表收费,0代表不收费 |
响应体示例
{
"code": 200,
"msg": "ok",
"result": {
"taskId": "079560a6c9f34783bdce47e168510038",
"status": 1,
"reasonType": 1,
"isPayed": 1
}
}
响应返回码
响应返回码见:响应返回码