# 身份证识别 API 文档
# 接口说明
身份证识别,对身份证正反面图片进行识别,返回身份证图片上的姓名、民族、住址、身份证号、签发机关和有效期等信息,可以省去用户手动录入的过程,自动完成身份证信息的结构化和图像数据的采集,可以很方便对接客户的后台数据系统,给用户带来极大的便利。
该能力是通过HTTP API的方式给开发者提供一个通用的接口,适用于一次性交互数据传输的AI服务场景,块式传输。相较于SDK,API具有轻量、跨语言的特点,不过请注意该接口使用的HTTP API协议不支持跨域。
# 接口Demo
示例demo请点击 这里 下载。
目前仅提供部分开发语言的demo,其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到 讯飞开放平台社区 (opens new window) 分享你们的demo。
# 接口要求
集成身份证识别API时,需按照以下要求。
内容 | 说明 |
---|---|
传输方式 | http[s] (为提高安全性,强烈推荐https) |
请求地址 | http(s): //api.xf-yun.com/v1/private/s5ccecfce 注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用 |
请求行 | POST /v1/private/s5ccecfce |
接口鉴权 | 签名机制,详情请参照下方鉴权认证 |
字符编码 | UTF-8 |
响应格式 | 统一采用JSON格式 |
开发语言 | 任意,只要可以向讯飞云服务发起HTTP请求的均可 |
适用范围 | 任意操作系统,但因不支持跨域不适用于浏览器 |
图片格式 | jpg/jpeg/png/bmp |
图片大小 | base64编码后大小不超过4M |
# 接口调用流程
· 通过接口密钥基于hmac-sha256计算签名,将签名以及其他参数加在请求地址后面。详见下方 鉴权认证 。
· 将请求参数以及图片数据放在Http Request Body中,以POST表单的形式提交,详见下方 请求参数 。
· 向服务器端发送Http请求后,接收服务器端的返回结果。
# 鉴权认证
在调用业务接口时,请求方需要对请求进行签名,服务端通过签名来校验请求的合法性。
# 鉴权方法
通过在请求地址后面加上鉴权相关参数的方式,参数具体如下:
http示例url:
https://api.xf-yun.com/v1/private/s5ccecfce?authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iS1pyaU5Nb0dBOHV2V1ZrL0h0M2FMMUwyb1dXdmtjQlByOC9oWTA5SzAwaz0i&host=api.xf-yun.com&date=Mon%2C+23+Nov+2020+08%3A39%3A15+GMT
鉴权参数:
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
host | string | 是 | 请求主机 | api.xf-yun.com |
date | string | 是 | 当前时间戳,RFC1123格式("EEE, dd MMM yyyy HH:mm:ss z") | Mon, 23 Nov 2020 08:39:15 GMT |
authorization | string | 是 | 使用base64编码的签名相关信息(签名基于hamc-sha256计算) | 参考下方详细生成规则 |
· date参数生成规则:
date必须是UTC+0或GMT时区,RFC1123格式(Mon, 23 Nov 2020 08:39:15 GMT)。
服务端会对date进行时钟偏移检查,最大允许300秒的偏差,超出偏差的请求都将被拒绝。
· authorization参数生成格式:
1)获取接口密钥APIKey 和 APISecret。
在讯飞开放平台控制台,创建一个应用后打开身份证识别页面可以获取,均为32位字符串。
2)参数authorization base64编码前(authorization_origin)的格式如下。
api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"
其中 api_key 是在控制台获取的APIKey,algorithm 是加密算法(仅支持hmac-sha256),headers 是参与签名的参数(见下方注释)。
signature 是使用加密算法对参与签名的参数签名后并使用base64编码的字符串,详见下方。
注: headers是参与签名的参数,请注意是固定的参数名("host date request-line"),而非这些参数的值。
3)signature的原始字段(signature_origin)规则如下。
signature原始字段由 host,date,request-line三个参数按照格式拼接成,
拼接的格式为(\n为换行符,’:’后面有一个空格):
host: $host\ndate: $date\n$request-line
假设
请求url = api.xf-yun.com
date = Mon, 23 Nov 2020 08:39:15 GMT
那么 signature原始字段(signature_origin)则为:
host: api.xf-yun.com
date: Mon, 23 Nov 2020 08:39:15 GMT
POST /v1/private/s5ccecfce HTTP/1.1
4)使用hmac-sha256算法结合apiSecret对signature_origin签名,获得签名后的摘要signature_sha。
signature_sha=hmac-sha256(signature_origin,$apiSecret)
其中 apiSecret 是在控制台获取的APISecret
5)使用base64编码对signature_sha进行编码获得最终的signature。
signature=base64(signature_sha)
假设
APISecret = apisecretXXXXXXXXXXXXXXXXXXXXXXX
date = Mon, 23 Nov 2020 08:39:15 GMT
则signature为
signature=KZriNMoGA8uvWVk/Ht3aL1L2oWWvkcBPr8/hY09K00k=
6)根据以上信息拼接authorization base64编码前(authorization_origin)的字符串,示例如下。
api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="KZriNMoGA8uvWVk/Ht3aL1L2oWWvkcBPr8/hY09K00k="
注: headers是参与签名的参数,请注意是固定的参数名("host date request-line"),而非这些参数的值。
7)最后再对authorization_origin进行base64编码获得最终的authorization参数。
authorization = base64(authorization_origin)
示例:
authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iS1pyaU5Nb0dBOHV2V1ZrL0h0M2FMMUwyb1dXdmtjQlByOC9oWTA5SzAwaz0i
# 鉴权结果
如果鉴权失败,则根据不同错误类型返回不同HTTP Code状态码,同时携带错误描述信息,详细错误说明如下:
HTTP Code | 说明 | 错误描述信息 | 解决方法 |
---|---|---|---|
401 | 缺少authorization参数 | {"message":"Unauthorized"} | 检查是否有authorization参数,详情见authorization参数详细生成规则 |
401 | 签名参数解析失败 | {"message":"HMAC signature cannot be verified"} | 检查签名的各个参数是否有缺失,是否正确,特别确认下复制的api_key是否正确 |
401 | 签名校验失败 | {"message":"HMAC signature does not match"} | 签名验证失败,可能原因有很多。 1. 检查api_key,api_secret 是否正确。 2.检查计算签名的参数host,date,request-line是否按照协议要求拼接。 3. 检查signature签名的base64长度是否正常(正常44个字节)。 |
403 | 时钟偏移校验失败 | {"message":"HMAC signature cannot be verified, a valid date or x-date header is required for HMAC Authentication"} | 检查服务器时间是否标准,相差5分钟以上会报此错误 |
认证失败返回示例:
HTTP/1.1 403 Forbidden
Date: Thu, 06 Dec 2018 07:55:16 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
"message": "HMAC signature cannot be verified, a valid date or x-date header is required for HMAC Authentication"
}
# 请求参数
在调用业务接口时,都需要在 Http Request Body 中配置以下参数,请求数据均为json字符串。
参数名 | 类型 | 必传 | 描述 |
---|---|---|---|
header | object | 是 | 用于上传平台参数 |
header.app_id | string | 是 | 在平台申请的appid信息 |
header.status | int | 是 | 请求状态,请设置为3(代表一次传完) |
parameter | object | 是 | 用于上传服务特性参数 |
parameter.s5ccecfce | object | 是 | 用于上传功能参数 |
parameter.s5ccecfce.result | object | 是 | 用于上传响应数据参数 |
parameter.s5ccecfce.result.encoding | string | 否 | 文本编码,可选值:utf8(默认值) |
parameter.s5ccecfce.result.compress | string | 否 | 文本压缩格式,可选值:raw(默认值) |
parameter.s5ccecfce.result.format | string | 否 | 文本格式,可选值:json(默认值) |
parameter.s5ccecfce.template_list | string | 是 | 请求功能类型,取值范围为:id_card |
payload | object | 是 | 用于上传请求数据 |
payload.s5ccecfce_data_1 | object | 是 | 用于上传图像数据 |
payload.s5ccecfce_data_1.encoding | string | 否 | 图像编码 可选值: jpg:jpg格式(默认值) jpeg:jpeg格式 png:png格式 bmp:bmp格式 |
payload.s5ccecfce_data_1.image | string | 是 | 图像数据,base64编码,需保证图像文件大小base64编码后不超过4MB |
payload.s5ccecfce_data_1.status | int | 否 | 数据状态,请设置为3(代表一次传完) |
请求参数示例:
{
"header": {
"app_id": "xxxxxxxx",
"status": 3
},
"parameter": {
"s5ccecfce": {
"result": {
"encoding": "utf8",
"format": "json",
"compress": "raw"
},
"template_list": "id_card"
}
},
"payload": {
"s5ccecfce_data_1": {
"encoding": "jpg",
"status": 3,
"image": "/9j/2wBDAA0JCgsK..."
}
}
}
# 返回参数
参数名 | 类型 | 描述 |
---|---|---|
header | object | 协议头部,用于描述平台特性的参数 |
header.sid | string | 本次会话id |
header.code | int | 返回码 0表示会话调用成功(并不一定表示服务调用成功,服务是否调用成功以text字段中的error_code为准) 其它表示会话调用异常,详情请参考错误码。 |
header.message | string | 描述信息 |
payload | object | 数据段,用于携带响应的数据 |
payload.result | object | 身份证识别响应数据块 |
payload.result.compress | string | 文本压缩格式,仅在设置了parameter.s5ccecfce.result.compress参数时返回 |
payload.result.encoding | string | 文本编码,仅在设置了parameter.s5ccecfce.result.encoding参数时返回 |
payload.result.format | string | 文本格式,仅在设置了parameter.s5ccecfce.result.format参数时返回 |
payload.result.text | string | 身份证识别返回结果,需要对其进行base64解码,解码后的返回字段如下 |
payload.result.text字段具体信息如下,其中各元素及结果请关注:
object_list[n].region_list[n].text_block_list[n].key
object_list[n].region_list[n].text_block_list[n].value
参数名 | 类型 | 描述 | 备注 |
---|---|---|---|
engine_version | string | 引擎版本号 | 版本相关信息,无需特别关注 |
error_code | int | 返回码(0表示成功) | |
error_msg | string | 描述返回码信息 | |
object_count | int | 目标数量 | 目前仅支持一次识别一个目标,一般返回1 |
version | string | json协议的版本号 | 版本相关信息,无需特别关注 |
object_list | array | 目标版面分析结果 | |
object_list[n].error_code | int | 当前图片识别错误码(0表示成功) | |
object_list[n].error_msg | string | 当前图片识别错误码信息 | |
object_list[n].type | string | 预留字段,暂无需关注 | |
object_list[n].description | string | 识别的目标图像类别名称 | |
object_list[n].width | int | 目标图像的宽度 | |
object_list[n].height | int | 目标图像的高度 | |
object_list[n].idx | int | 输出图片索引 | |
object_list[n].table_count | int | 表格区域数量 | 身份证识别此项返回0 |
object_list[n].table_list | array | 表格区域 | 身份证识别此项返回空 |
object_list[n].region_count | int | 通用区域数量 | |
object_list[n].region_list | array | 通用区域 | |
object_list[n].region_list[n].id | string | 序号,从0开始 | |
object_list[n].region_list[n].order | int | 同层级内的阅读顺序 | 无需特别关注 |
object_list[n].region_list[n].type | string | 区域类型 | 可能返回的值有 Address:地址 Birthday:出生日期 Gender:性别 ID:公民身份号码 Issuing-authority:签发机关 Name:姓名 Nation:民族 Validity-period:有效期限 |
object_list[n].region_list[n].position | object | 区域位置 | |
object_list[n].region_list[n].position.tl_point | object | 区域左上角坐标 | |
object_list[n].region_list[n].position.tl_point.x | int | 区域左上角x坐标 | |
object_list[n].region_list[n].position.tl_point.y | int | 区域左上角y坐标 | |
object_list[n].region_list[n].position.tr_point | object | 区域右上角坐标 | |
object_list[n].region_list[n].position.tr_point.x | int | 区域右上角x坐标 | |
object_list[n].region_list[n].position.tr_point.y | int | 区域右上角y坐标 | |
object_list[n].region_list[n].position.bl_point | object | 区域左下角坐标 | |
object_list[n].region_list[n].position.bl_point.x | int | 区域左下角x坐标 | |
object_list[n].region_list[n].position.bl_point.y | int | 区域左下角y坐标 | |
object_list[n].region_list[n].position.br_point | object | 区域右下角坐标 | |
object_list[n].region_list[n].position.br_point.x | int | 区域右下角x坐标 | |
object_list[n].region_list[n].position.br_point.y | int | 区域右下角y坐标 | |
object_list[n].region_list[n].text_block_count | int | 文本块数量 | |
object_list[n].region_list[n].text_block_list | array | 文本块结果 | |
object_list[n].region_list[n].text_block_list[n].id | string | id识别码 | |
object_list[n].region_list[n].text_block_list[n].order | int | 同层级内的阅读顺 | 无需特别关注 |
object_list[n].region_list[n].text_block_list[n].key | string | 要素key值 | 可能返回的值有 Address:地址 Birthday:出生日期 Gender:性别 ID:公民身份号码 Issuing-authority:签发机关 Name:姓名 Nation:民族 Validity-period:有效期限 |
object_list[n].region_list[n].text_block_list[n].value | string | 要素value值,识别后处理结果 | |
object_list[n].region_list[n].text_block_list[n].position | object | 文本块区域位置 | |
object_list[n].region_list[n].text_block_list[n].position.tl_point | object | 区域左上角坐标 | |
object_list[n].region_list[n].text_block_list[n].position.tl_point.x | int | 区域左上角x坐标 | |
object_list[n].region_list[n].text_block_list[n].position.tl_point.y | int | 区域左上角y坐标 | |
object_list[n].region_list[n].text_block_list[n].position.tr_point | object | 区域右上角坐标 | |
object_list[n].region_list[n].text_block_list[n].position.tr_point.x | int | 区域右上角x坐标 | |
object_list[n].region_list[n].text_block_list[n].position.tr_point.y | int | 区域右上角y坐标 | |
object_list[n].region_list[n].text_block_list[n].position.bl_point | object | 区域左下角坐标 | |
object_list[n].region_list[n].text_block_list[n].position.bl_point.x | int | 区域左下角x坐标 | |
object_list[n].region_list[n].text_block_list[n].position.bl_point.y | int | 区域左下角y坐标 | |
object_list[n].region_list[n].text_block_list[n].position.br_point | object | 区域右下角坐标 | |
object_list[n].region_list[n].text_block_list[n].position.br_point.x | int | 区域右下角x坐标 | |
object_list[n].region_list[n].text_block_list[n].position.br_point.y | int | 区域右下角y坐标 | |
object_list[n].region_list[n].text_block_list[n].ocr_flag | int | 当前要素是否进行识别,1代表识别,0代表不识别 | |
object_list[n].region_list[n].text_block_list[n].tag | string | 保留字段,无需特别关注 | |
object_list[n].region_list[n].text_block_list[n].class | string | 所属要素类型,英文名 | 可能返回的值有 Address:地址 Birthday:出生日期 Gender:性别 ID:公民身份号码 Issuing-authority:签发机关 Name:姓名 Nation:民族 Validity-period:有效期限 |
object_list[n].region_list[n].text_block_list[n].text_sent_count | int | 文本行数量 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list | object | 识别的文本行(文本块内可能包含多行文本) | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].text | string | 文本行文字内容 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position | object | 文本块区域位置 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.tl_point | object | 区域左上角坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.tl_point.x | int | 区域左上角x坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.tl_point.y | int | 区域左上角y坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.tr_point | object | 区域右上角坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.tr_point.x | int | 区域右上角x坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.tr_point.y | int | 区域右上角y坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.bl_point | object | 区域左下角坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.bl_point.x | int | 区域左下角x坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.bl_point.y | int | 区域左下角y坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.br_point | object | 区域右下角坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.br_point.x | int | 区域右下角x坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].position.br_point.y | int | 区域右下角y坐标 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].image_data | string | 预留字段,请暂不要使用 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].angle | float | 文本行角度(0-360),在原图中 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].char_count | int | 文本行字符数 | |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].det_score | float | 要素检测框置信度 | 无需特别关注 |
object_list[n].region_list[n].text_block_list[n].text_sent_list[n].score | float | 该行文本识别置信度 |
返回参数示例:
{
"header": {
"code": 0,
"message": "success",
"sid": "ase0007e8d4@hu175f3aa47c20212882"
},
"payload": {
"result": {
"compress": "raw",
"encoding": "utf8",
"format": "json",
"text": "ewogICAiZW5naW5lX3Zlc..."
}
}
}
base64解码后的text示例(这是一个背面示例):
{
"engine_version": "2.0.2006",
"error_code": 0,
"error_msg": "Success",
"object_count": 1,
"object_list": [
{
"description": "身份证",
"error_code": 0,
"error_msg": "Success",
"height": 640,
"idx": 0,
"region_count": 2,
"region_list": [
{
"id": "0",
"order": 0,
"position": {
"bl_point": {
"x": 74,
"y": 445
},
"br_point": {
"x": 94,
"y": 445
},
"tl_point": {
"x": 74,
"y": 297
},
"tr_point": {
"x": 94,
"y": 297
}
},
"text_block_count": 1,
"text_block_list": [
{
"class": "Issuing-authority",
"id": "0",
"key": "Issuing-authority",
"ocr_flag": 1,
"order": 0,
"position": {
"bl_point": {
"x": 74,
"y": 445
},
"br_point": {
"x": 94,
"y": 445
},
"tl_point": {
"x": 74,
"y": 297
},
"tr_point": {
"x": 94,
"y": 297
}
},
"tag": "",
"text_sent_count": 1,
"text_sent_list": [
{
"angle": 90.0,
"char_count": 30,
"det_score": 0.99694567918777466,
"image_data": "/9j/4AAQSkZJRgABAQAAAQ...",
"position": {
"bl_point": {
"x": 93,
"y": 444
},
"br_point": {
"x": 74,
"y": 444
},
"tl_point": {
"x": 93,
"y": 297
},
"tr_point": {
"x": 74,
"y": 297
}
},
"score": 0.82860720157623291,
"text": "XX市公安局XX分局"
}
],
"value": "XX市公安局XX分局"
}
],
"type": "Issuing-authority"
},
{
"id": "1",
"order": 1,
"position": {
"bl_point": {
"x": 42,
"y": 458
},
"br_point": {
"x": 62,
"y": 458
},
"tl_point": {
"x": 42,
"y": 300
},
"tr_point": {
"x": 62,
"y": 300
}
},
"text_block_count": 1,
"text_block_list": [
{
"class": "Validity-period",
"id": "1",
"key": "Validity-period",
"ocr_flag": 1,
"order": 0,
"position": {
"bl_point": {
"x": 42,
"y": 458
},
"br_point": {
"x": 62,
"y": 458
},
"tl_point": {
"x": 42,
"y": 300
},
"tr_point": {
"x": 62,
"y": 300
}
},
"tag": "",
"text_sent_count": 1,
"text_sent_list": [
{
"angle": 90.0,
"char_count": 21,
"det_score": 0.99347174167633057,
"image_data": "/9j/4AAQSkZJRgABAQAAA...",
"position": {
"bl_point": {
"x": 61,
"y": 457
},
"br_point": {
"x": 42,
"y": 457
},
"tl_point": {
"x": 61,
"y": 300
},
"tr_point": {
"x": 42,
"y": 300
}
},
"score": 0.9511486291885376,
"text": "2019.12.04-2039.12.04"
}
],
"value": "2019.12.04-2039.12.04"
}
],
"type": "Validity-period"
}
],
"table_count": 0,
"table_list": [
],
"type": "",
"width": 299
}
],
"version": 2.0
}
# 错误码
备注:如出现下述列表中没有的错误码,可到 这里 (opens new window) 查询。
错误码 | 错误描述 | 说明 | 处理方式 |
---|---|---|---|
10010 | service license not enough | 授权不足 | 联系技术人员 |
10019 | service read buffer timeout, session timeout | session 超时 | 检查网络是否正常 |
10106 | wrapper output data invalid(key or type) | 参数校验失败 | 依据错误提示信息检查参数是否正确上传 |
10163 | param validate error:... | 参数校验失败 | 1)依据错误提示信息检查参数是否正确上传 2)检查图片大小是否超过上限,base64编码后大小不能超过4M |
10222 | context deadline exceeded | 调用失败 | 1)检查图片格式是否不符合要求(jpg/jpeg/png/bmp) 2)检查图片数据是否正确上传,尤其是payload中的image是否传入 3)检查图片大小是否超过上限,base64编码后大小不能超过4M |
10313 | invalid appid | appid不合法 | 检查app_id参数是否正确上传或是否为空 |
37042 | Failure | 没有检测到身份证要素 | 检查上传的是否为身份证图片 |
# 调用示例
注: demo只是一个简单的调用示例,不适合直接放在复杂多变的生产环境使用
身份证识别demo python3语言 (opens new window)
身份证识别demo java语言 (opens new window)
注: 其他开发语言请参照 接口调用流程 进行开发,也欢迎热心的开发者到 讯飞开放平台社区 (opens new window) 分享你们的demo。
# 常见问题
# 身份证识别的主要功能是什么?
答:对身份证正反面图片进行识别,返回身份证图片上的姓名、民族、住址、身份证号、签发机关和有效期等信息。
# 身份证识别支持什么应用平台?
答:目前支持WebAPI应用平台。