/ocr/idcard

1. 接口规范
2. 请求参数
3. 返回参数
4. 错误码
5. 示例

1. 接口规范

该接口用于识别孟加拉国的身份证，并提取关键信息。

图片要求

  1. 格式：JPG(JPEG)、PNG、e-aadhaar(PDF)
  2. 分辨率范围：128×128 到 6000×6000 像素，推荐分辨率：1280×1280
  3. 文件大小：不超过 5 MB

请求方式

POST

请求地址

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

Debugging Tool

Debugging Tool

2. 请求参数

2.1 请求头

参数 类型 是否必须 描述
X-DF-API-ID string 是 API 凭证，请参见 API Request
X-DF-API-SECRET string 是 API 凭证，请参见 API Request

2.2 请求体

可选 字段 类型 描述
是 file file 图片的二进制数据
是 image_base64 string 图片的 Base64 编码数据

参数 file 或 image_base64 至少需要提供一个。

使用 file 参数时，需将图像数据放入 POST 的 multipart/form-data 中。

3. 返回参数

字段 类型 描述
request_id string 请求的唯一 ID
status string 返回状态，成功为 OK，失败见 错误码
results array 卡证识别结果数组，详见下文
results 数组中的字段：
字段 类型 描述
card_side string 卡片面（front/back）
card_info object 卡片的关键信息
card_info 字段说明：
  • 身份证正面信息
字段 类型 描述
id_number string 身份证号码（数字）
name string 姓名
father_name_bg string 父亲姓名（孟加拉语）
mother_name_bg string 母亲姓名（孟加拉语）
birthday string 出生日期，例如：18 Dec 1999
birthday_s string 出生日期格式化（dd-mm-yyyy）
  • 身份证背面信息
字段 类型 描述
address string 地址
blood_type string 血型
birth_place string 出生地
issue_date string 发证日期，例如：12 Nov 2020
issue_date_s string 发证日期（阿拉伯语）
正面返回示例：
{
  "request_id": "TID928fce867db54de9bb6632b6bf38cd4a",
  "status": "OK",
  "results": [
    {
      "card_side": "front",
      "card_info": {
        "id_number": "780600****",
        "name": "SALMAN SABXXX",
        "father_name_bg": "",
        "mother_name_bg": "",
        "birthday": "24 Nov 1997",
        "birthday_s": "24-11-1997"
      }
    }
  ]
}
背面返回示例：
{
  "request_id": "TIDd8d16d2742294ca09237f80c61f3328b",
  "status": "OK",
  "results": [
    {
      "card_side": "back",
      "card_info": {
        "address": " ঠিকানা: বাসা হোল্ডি?: ৫৬৭/ ১ , গ্রাম/রাস্তা: কালাইচাডা_ গোপিনাথপুর",
        "blood_type": "",
        "birth_place": "PABNA",
        "issue_date": "18 Nov 2018",
        "issue_date_s": "18-11-2022"
      }
    }
  ]
}

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"
}

5.Sample

results matching ""

    No results matching ""