/ocr/idcard

1. API 说明
2. 请求参数
3. 返回参数
4. 错误码
5. 示例

1. API 说明

本接口用于识别智利身份证，并提取其关键信息。

图像规格

  1. 支持格式：JPG(JPEG)、PNG
  2. 图像尺寸：128×128 至 6000×6000 像素，推荐分辨率：1280×1280
  3. 文件大小：不超过 5MB

请求方式

POST

请求地址

https://cloudapi.chile.accuauth.com/ocr/idcard

2. 请求参数

2.1 请求头

参数 类型 必填 描述
X-DF-API-ID string 是 用于 API 验证，请访问 API 请求
X-DF-API-SECRET string 是 用于 API 验证，请访问 API 请求

2.2 请求体

是否必填 字段 类型 描述
可选 file file 图像的二进制数据
可选 image_base64 string 图像的 Base64 编码数据
可选 detect_face integer 1：启用人脸检测，会返回 face_region 字段；0：默认值，禁用人脸检测

请求参数中必须提供 file 或 image_base64 之一。
若使用 file，必须将图像流添加至 POST 的 multipart/form-data 部分。

3. 返回参数

字段 类型 描述
request_id string 请求的唯一标识
status string 响应状态，成功为 OK，失败时为其他状态，详见错误码
results array OCR 识别结果数组，详见下方 results 字段说明
results 字段说明：
字段 类型 描述
card_side string 身份证的面：front（正面），back（背面）
card_info object 身份证关键信息
face_region array 人脸区域的四个点坐标，格式为：[(x1, y1), (x2, y2), (x3, y3), (x4, y4)]；坐标基于原始图像，点的顺序基于旋转后人脸的上下左右顺序
card_info 字段说明：
  • 身份证正面字段：
字段 类型 描述
id_number string 身份证号
document_number string 证件编号
name string 名字
last_name string 姓氏
gender string 性别
birthday string 出生日期
birthday_s string 格式化出生日期（dd-mm-yyyy）
nationality string 国籍
issue_date string 签发日期
issue_date_s string 格式化签发日期（dd-mm-yyyy）
expiry_date string 过期日期
expiry_date_s string 格式化过期日期（dd-mm-yyyy）
  • 身份证背面字段：
字段 类型 描述
id_number string 身份证号
document_number string 证件编号
name string 名字
last_name string 姓氏
gender string 性别，M 表示男性，F 表示女性
birthday string 出生日期
birth_place string 出生地
nationality string 国籍
expiry_date string 过期日期
line1_all string 第1行
line2_all string 第2行
line3_all string 第3行
other string 其他信息
profession string 职业
返回示例
{
  "request_id": "TID60da2163781c4436957c82174a38409b",
  "results": [
    {
      "card_info": {
        "id_number": "185959xxx",
        "document_number": "515.159.xxx",
        "birthday": "10 MAR 1987",
        "birthday_s": "10-03-1987",
        "expiry_date": "10 MAR 2027",
        "expiry_date_s": "10-03-2027",
        "gender": "M",
        "issue_date": "19 ABR 2018",
        "issue_date_s": "19-04-2018",
        "last_name": "ALFARO *****",
        "name": "MANUEL ******",
        "nationality": "CHILENA"
      },
      "card_side": "front",
      "face_region": [
        [325, 1010],
        [736, 1010],
        [736, 1523],
        [325, 1523]
      ]
    }
  ],
  "status": "OK"
}

4. 错误码

本接口常见错误码如下：

HTTP 状态码 status 字段 描述
400 INVALID_ARGUMENT 请求参数不合法
400 DETECTION_FAILED 图像检测失败
401 UNAUTHORIZED 未授权或访问被拒绝
401 KEY_EXPIRED API ID 已过期
403 NO_PERMISSION 无权限访问该接口
403 OUT_OF_QUOTA API 调用配额已用完
403 RATE_LIMIT_EXCEEDED 请求频率超出限制
404 NOT_FOUND 接口路径不存在
500 INTERNAL_ERROR 内部服务器错误

备注： 当发生 40X 类错误时，请查看返回体中的 reason 字段以了解详细原因。

错误响应示例
{
  "status": "INVALID_ARGUMENT",
  "reason": "must specify 'file' or 'image_base64' argument",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

results matching ""

    No results matching ""