产品文档

香港身份证识别

香港身份证识别

描述

香港身份证识别

请求方式

POST

请求地址

apl
https://aiapi.jdcloud.com/jdai/hkIdcardRecognition

header请求参数

名称 类型 是否必需 示例值 描述
Content-Type String application/json json格式

body请求参数

参数名称 参数类型 是否必填 参数说明
serialNo string N 请求流水号, 不传接口自动生成
imageItem Object 图片信息
cardType string Y 新老版式,取值【“v2003”,“v2018”】, 若未知传"v2018"

imageItem对象信息

参数名称 参数类型 是否必填 示例值 参数说明
imgType enum DL 图片的类型 SFF("采集照"),FF("全景采集照"),NIR("双目采集的近红外照片"),DEEP("深度采集的照片"),IDP("身份证正面"),IDN("身份证反面"),MP("网纹照"),AP("动作照"),VL("行驶证"),DL("驾驶证"),BC("银行卡"),BL("营业执照"),LP("车牌"),COM("通用图片
imgBase64 String DL /9j/4AAQSkZJRgABAQAAAQABAA...
filename String 图片的存储名, 指定了则不读base64
imgUrl String 图片的Url地址(外网地址可能会有socket连接超时问题,建议传base64)
imgArr byte[ ] 图片的二进制
encryptionType enum NON 加密方式 AKS,LICENSE,NON AKS解密方式:com.wangyin.key.server.DeviceCryptoService#decryptEnvelop 版本号1.5.3

返回实体

参数名称 参数类型 参数说明
code int 返回code码0:成功
msg string msg
serialNo string 交互的流水号
data Object 识别结果

字段data的内容说明:

参数名称 参数类型 参数说明
cardType String 证件版式,【"v2003", "v2018", "other"】
id String 身份证号
name String 姓名
enName String 英文名
commercial String comercial code
sex String 性别
symbols String symbols code
birth String 出生日期
issue String 签发日期
register String 注册日期
isValid String 校验字段 "Y" / "N"

请求参数示例

{
    "cardType": "v2018",
    "imageItem": {
        "encryptionType": "NON",
        "imgBase64": "",
        "imgType": "COM"
    },
    "serialNo": "12092873283-2313"
}

返回样例

{
    "code": 0,
    "data": {
        "birth": "01-01-1988",
        "cardType": "v2018",
        "commercial": "394725355174",
        "enName": "SAN, Chi Nan",
        "id": "C668668(E)",
        "isValid": "N",
        "issue": "(01-99)",
        "name": "中智能",
        "register": "15-09-18",
        "sex": "F",
        "symbols": "***AZ"
    },
    "msg": "成功",
    "serialNo": "12092873283-2313",
    "timestamp": 1646188619374
}
更新时间:2022-03-18 19:49:20
feedback