身份证识别接口，该接口适用于单张身份证正面和单张身份证反面的混贴图像识别，也可以单独识别单张身份证正面图像或者单张身份证反面图像；同时返回了人脸区域（需指定参数OutputFigure）、身份证正面、身份证反面子图坐标信息。需要注意的是，如果输入图像中包含多张身份证正面子图区域和多张身份证反面子图区域，本接口会提示您超过图片限制（ExceededFaceBackCount）且不会计费，请您悉知。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | RecognizeIdcard |
系统规定参数。取值：RecognizeIdcard。 |
| Url | String | 否 | https://img.alicdn.com/tfs/TB1q5IeXAvoK1RjSZFNXXcxMVXa-483-307.jpg |
图片链接（长度不超 2048，不支持 base64） |
| String | 否 | 图片二进制文件 |
图片二进制文件，最大10MB，与URL二选一。 使用HTTP方式调用，把图片二进制文件放到HTTP body 中上传即可。 使用SDK的方式调用，把图片放到SDK的body中即可。 |
|
| OutputFigure | Boolean | 否 | false |
是否需要图案检测功能，默认不需要。true：需要 false：不需要 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 86B83935-DD36-195B-B6E4-D07BE370C8B6 |
请求唯一 ID |
| Data | String | {"data":{"face":{"data":{"name":"方大呆","sex":"女","ethnicity":"汉","birthDate":"2006年10月2日","address":"上海市西藏南路-瞿溪路弘辉名苑","idNumber":"371002200610020000"},"ftype":0,"height":307,"orgHeight":307,"orgWidth":483,"prism_keyValueInfo":[{"key":"name","keyProb":100,"value":"方大呆","valuePos":[{"x":142,"y":40},{"x":142,"y":60},{"x":82,"y":60},{"x":82,"y":40}],"valueProb":100},{"key":"sex","keyProb":100,"value":"女","valuePos":[{"x":104,"y":77},{"x":104,"y":96},{"x":85,"y":96},{"x":85,"y":77}],"valueProb":100},{"key":"ethnicity","keyProb":100,"value":"汉","valuePos":[{"x":212,"y":75},{"x":212,"y":95},{"x":192,"y":95},{"x":192,"y":75}],"valueProb":100},{"key":"birthDate","keyProb":100,"value":"2006年10月2日","valuePos":[{"x":214,"y":116},{"x":214,"y":131},{"x":76,"y":131},{"x":76,"y":116}],"valueProb":100},{"key":"address","keyProb":100,"value":"上海市西藏南路-瞿溪路弘辉名苑","valuePos":[{"x":278,"y":154},{"x":278,"y":196},{"x":73,"y":196},{"x":73,"y":154}],"valueProb":100},{"key":"idNumber","keyProb":100,"value":"371002200610020000","valuePos":[{"x":379,"y":256},{"x":379,"y":274},{"x":162,"y":274},{"x":162,"y":256}],"valueProb":100}],"sliceRect":{"x0":0,"y0":0,"x1":481,"y1":0,"x2":481,"y2":307,"x3":0,"y3":307},"width":483}},"height":307,"orgHeight":307,"orgWidth":483,"width":483} |
返回数据 |
| Code | String | 200 |
状态码 |
| Message | String | message |
详细信息 |
示例
请求示例
http(s)://[Endpoint]/?Action=RecognizeIdcard
&Url=https://img.alicdn.com/tfs/TB1q5IeXAvoK1RjSZFNXXcxMVXa-483-307.jpg
&OutputFigure=false
&公共请求参数正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<RecognizeIdcardResponse>
<RequestId>86B83935-DD36-195B-B6E4-D07BE370C8B6</RequestId>
<Data>{"data":{"face":{"data":{"name":"方大呆","sex":"女","ethnicity":"汉","birthDate":"2006年10月2日","address":"上海市西藏南路-瞿溪路弘辉名苑","idNumber":"371002200610020000"},"ftype":0,"height":307,"orgHeight":307,"orgWidth":483,"prism_keyValueInfo":[{"key":"name","keyProb":100,"value":"方大呆","valuePos":[{"x":142,"y":40},{"x":142,"y":60},{"x":82,"y":60},{"x":82,"y":40}],"valueProb":100},{"key":"sex","keyProb":100,"value":"女","valuePos":[{"x":104,"y":77},{"x":104,"y":96},{"x":85,"y":96},{"x":85,"y":77}],"valueProb":100},{"key":"ethnicity","keyProb":100,"value":"汉","valuePos":[{"x":212,"y":75},{"x":212,"y":95},{"x":192,"y":95},{"x":192,"y":75}],"valueProb":100},{"key":"birthDate","keyProb":100,"value":"2006年10月2日","valuePos":[{"x":214,"y":116},{"x":214,"y":131},{"x":76,"y":131},{"x":76,"y":116}],"valueProb":100},{"key":"address","keyProb":100,"value":"上海市西藏南路-瞿溪路弘辉名苑","valuePos":[{"x":278,"y":154},{"x":278,"y":196},{"x":73,"y":196},{"x":73,"y":154}],"valueProb":100},{"key":"idNumber","keyProb":100,"value":"371002200610020000","valuePos":[{"x":379,"y":256},{"x":379,"y":274},{"x":162,"y":274},{"x":162,"y":256}],"valueProb":100}],"sliceRect":{"x0":0,"y0":0,"x1":481,"y1":0,"x2":481,"y2":307,"x3":0,"y3":307},"width":483}},"height":307,"orgHeight":307,"orgWidth":483,"width":483}</Data>
</RecognizeIdcardResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "86B83935-DD36-195B-B6E4-D07BE370C8B6",
"Data" : "{\"data\":{\"face\":{\"data\":{\"name\":\"方大呆\",\"sex\":\"女\",\"ethnicity\":\"汉\",\"birthDate\":\"2006年10月2日\",\"address\":\"上海市西藏南路-瞿溪路弘辉名苑\",\"idNumber\":\"371002200610020000\"},\"ftype\":0,\"height\":307,\"orgHeight\":307,\"orgWidth\":483,\"prism_keyValueInfo\":[{\"key\":\"name\",\"keyProb\":100,\"value\":\"方大呆\",\"valuePos\":[{\"x\":142,\"y\":40},{\"x\":142,\"y\":60},{\"x\":82,\"y\":60},{\"x\":82,\"y\":40}],\"valueProb\":100},{\"key\":\"sex\",\"keyProb\":100,\"value\":\"女\",\"valuePos\":[{\"x\":104,\"y\":77},{\"x\":104,\"y\":96},{\"x\":85,\"y\":96},{\"x\":85,\"y\":77}],\"valueProb\":100},{\"key\":\"ethnicity\",\"keyProb\":100,\"value\":\"汉\",\"valuePos\":[{\"x\":212,\"y\":75},{\"x\":212,\"y\":95},{\"x\":192,\"y\":95},{\"x\":192,\"y\":75}],\"valueProb\":100},{\"key\":\"birthDate\",\"keyProb\":100,\"value\":\"2006年10月2日\",\"valuePos\":[{\"x\":214,\"y\":116},{\"x\":214,\"y\":131},{\"x\":76,\"y\":131},{\"x\":76,\"y\":116}],\"valueProb\":100},{\"key\":\"address\",\"keyProb\":100,\"value\":\"上海市西藏南路-瞿溪路弘辉名苑\",\"valuePos\":[{\"x\":278,\"y\":154},{\"x\":278,\"y\":196},{\"x\":73,\"y\":196},{\"x\":73,\"y\":154}],\"valueProb\":100},{\"key\":\"idNumber\",\"keyProb\":100,\"value\":\"371002200610020000\",\"valuePos\":[{\"x\":379,\"y\":256},{\"x\":379,\"y\":274},{\"x\":162,\"y\":274},{\"x\":162,\"y\":256}],\"valueProb\":100}],\"sliceRect\":{\"x0\":0,\"y0\":0,\"x1\":481,\"y1\":0,\"x2\":481,\"y2\":307,\"x3\":0,\"y3\":307},\"width\":483}},\"height\":307,\"orgHeight\":307,\"orgWidth\":483,\"width\":483}"
}返回示例补充说明
中英文字段映射
data 结构化信息，face（身份证正面，人像面）和 back（身份证反面，国徽面）
name 姓名
sex 性别
ethnicity 民族
birthDate 出生日期
address 住址
idNumber 身份证号码
figure 身份证人像面的人脸位置信息
prism_keyValueInfo 结构化信息的坐标信息
sliceRect 图片中身份证子图区域的任意四边形表示，起始点为左上角，顺序为顺时针
ftype 是否是复印件(1:是，0:否)
--------------------------prism_keyValueInfo数组内字段说明--------------------------
key 识别出的字段名称
keyProb 字段名称置信度
value 识别出的字段名称对应的值
valuePos 字段的四个点坐标（左上、右上、右下、左下）
--------------------------figure内字段说明（如果OutputFigure=true，返回此字段）--------------------------
type 身份证类型 (正面：face，背面：back)
angle 图片的角度，0表示正向，90表示图片朝右，180朝下，270朝左
x 人像图案左上角横坐标
y 人像图案左上角纵坐标
w 人像图案宽度
h 人像图案高度
box 人像图案坐标信息：人像图案中心横纵坐标，长宽，图案顺时针旋转角度。定义同 OpenCV 中 RotatedRect，请参见 OpenCV 文档
points 人像图案四个点坐标（左上、右上、右下、左下）
错误码
访问错误中心查看更多错误码。