最近更新时间：2022.08.25 10:49:54
首次发布时间：2021.12.16 13:59:15
请先查看接入指引了解具体接入方式，再参考此文档完成接入。
| 名称 | 内容 |
|---|---|
| 请求方式 | POST |
| Content-Type | application/x-www-form-urlencoded |
| 图片要求 | 1. 图片格式：JPG、JPEG、PNG、BMP等常见格式，建议使用JPG格式。 2. 图片像素尺寸：最小 256 x 256 像素，最大 2048 x 2048 像素。为了保证文字识别效果，推荐图片中身份证最短边长不低于256像素。 3. 图片文件大小：最大 5 MB。身份证主体尽量占据图片主要区域，不支持黑白图片。 4. 注意图片质量：保证身份证图片足够清晰，不应该有因为压缩导致的噪声，避免对身份证正反面的遮挡、不当的光照（强光、暗光、逆光）等，否则会降低结果准确度。 5. 图片需要有版权，有肖像权，没有法律或者政策风险的。相关风险请注意评估。 6. 身份证图片不可以是复印件、翻拍件、PS件等。 |
Query参数：
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| Action | 必选 | String | 接口名，取值：IDCard |
| Version | 必选 | String | 版本号，取值：2020-08-26 |
Body参数：
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| image_base64 | 必选 | String | 身份证图片文件，base64编码 |
| version | 可选 | String | 身份证服务版本，可选"v1"/"v2", 默认为"v1" |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| card_front | front_info | 正面信息 | 正面信息字段说明见下方 |
| card_back | back_info | 背面信息 | 背面信息字段说明见下方 |
| card_corners | Array of Int | 身份证位置信息 |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| name | String | 姓名 | 正面信息 |
| gender | String | 性别 | 正面信息 |
| ethnicity | String | 民族 | 正面信息 |
| date_of_birth | String | 出生日期（YYYY.MM.DD） | 正面信息 |
| domicile | String | 住址 | 正面信息 |
| id_number | String | 公民身份号码 | 正面信息 |
| face_corners | Array of Int | 身份证人脸位置信息 | 正面信息 |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| issue_authority | String | 签发机关 | 背面信息 |
| valid_period | String | 有效期限（YYYY.MM.DD-YYYY.MM.DD） | 背面信息 |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| card_front | front_info | 正面信息 | 图片内不含正面证件时内容为空 |
| card_back | back_info | 背面信息 | 图片内不含背面证件时内容为空 |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| name | String | 姓名 | 正面信息 |
| gender | String | 性别 | 正面信息 |
| ethnicity | String | 民族 | 正面信息 |
| date_of_birth | String | 出生日期（YYYY.MM.DD） | 正面信息 |
| domicile | String | 住址 | 正面信息 |
| id_number | String | 公民身份号码 | 正面信息 |
| face_corners | Array of Int | 身份证人脸位置信息 | 正面信息 |
| card_corners | Array of Int | 身份证位置信息 | |
| card_img | String | 身份证图片Base64值 | |
| face_img | String | 人脸图片Base64值 | |
| card_type | String | 证件类型 | “真实身份证”、“身份复印件”、“屏幕翻拍”、“临时身份证”、“其他” |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| issue_authority | String | 签发机关 | 背面信息 |
| valid_period | String | 有效期限（YYYY.MM.DD-YYYY.MM.DD） | 背面信息 |
| card_corners | Array of Int | 身份证位置信息 | |
| card_img | String | 身份证图片Base64值 | |
| card_type | String | 证件类型 | “真实身份证”、“身份复印件”、“屏幕翻拍”、“临时身份证”、“其他” |
| HttpCode | 错误码 | 错误消息 | 描述 |
|---|---|---|---|
| 400 | 60103 | Missing Input Parameters: empty input image | 输入图片为空 |
| 400 | 60301 | Invalid Input Image: get input image error | 输入图片错误 |
| 400 | 60303 | Card Type Error: invalid card type | 卡证类型输入错误 |
| 400 | 60304 | Invalid Input Parameters: No id card detected in input image | 输入图片无身份证内容 |
| 400 | 60305 | Card Quality Error: Unqualified card | 输入图片中身份证部分质量差 |
| 400 | 60306 | Card Invalid Info Error | 图片中身份证包含非身份证信息 |
| 400 | 60307 | Card Unreal Error | 无效身份证，错误信息包括“身份证复印件”、“屏幕翻拍”、“临时身份证”和“其它”说明 |
{ "code":10000, "data":{ "card_front":{ "name":"字节跳动", "gender":"男", "ethnicity":"汉", "data_of_birth":"1990.01.01", "domicile":"北京市海淀区东知春路00号", "id_number":"102030199001014444", "face_corners":[183,65,232,65,232,131,183,131] } "card_back":{ "issue_authority":"", "valid_period":"" }, "card_corners":[0,14,254,17,255,192,0,192] }, "message":"Success", "request_id":"6838889517957515275", "time_elapsed":"41.897331ms" }
{ "code":10000, "data":{ "card_front": { "name": "", "gender": "", "ethnicity": "", "date_of_birth": "", "domicile": "", "id_number": "" }, "card_back":{ "issue_authority":"北京市海淀区公安局", "valid_period":"2020.01.01-2030.01.01" }, "card_corners":[0,14,254,17,255,192,0,192] }, "message":"Success", "request_id":"6838889517957544315", "time_elapsed":"36.875321ms" }