/ocr/indian_card

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

1. 接口说明

该接口用于识别印度 Aadhaar 卡或 PAN 卡，并提取关键信息。

Aadhaar 卡（调用 2 次） - 正面和背面
PAN 卡（调用 1 次） - 正面

图像规格

  1. 格式：JPG(JPEG)、PNG、电子 Aadhaar（PDF）
  2. 分辨率范围：128128 到 60006000 像素，推荐：1280*1280
  3. 文件大小：不超过 5 MB

请求方法

POST

请求 URL

https://cloudapi.accuauth.in/ocr/indian_card

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_type string 文件类型：pdf 或 image，默认为 image，目前仅支持来自 UIDAI 网站 的 PDF
可选 file_password string PDF 文件密码
可选 detect_face int 人脸检测选项：1 开启，0 关闭。开启后会返回 face_region 字段
可选 detect_image_quality int 图像质量检测：1 开启，0 关闭。开启后会返回 image_quality 字段

file 或 image_base64 至少提供一个参数。
使用 file 时，请将图像流添加到 multipart/form-data 的 POST 消息体中。

3. 返回参数

字段 类型 描述
request_id string 请求唯一 ID
status string 响应状态，成功为 OK，失败参见 错误码
image_quality float 图像质量分数 [0.0-1.0]，数值越大质量越高
results array 卡片 OCR 识别结果数组，详见下方说明
results 中的元素：
字段 类型 描述
card_type string 卡类型：aadhaar_card 或 pan_card
card_side string 卡片面：front 或 back
card_info object 卡片关键信息
face_region array 人脸矩形区域的四个点坐标，格式：[(x1,y1), (x2,y2), (x3,y3), (x4,y4)]
card_region array 废弃字段，仅用于兼容旧版本
card_info 字段：

字段 类型 描述
**card_no** *string* Aadhaar 卡号
**name** *string* 姓名
**gender** *string* 性别（Male 或 Female）
**mother_name** *string* 母亲姓名
**father_name** *string* 父亲姓名
**date_type** *string* 日期类型（DOB：出生日期；YOB：出生年份）
**date_info** *string* 日期信息（DOB 格式为 DD/MM/YYYY 或 DD-MM-YYYY，YOB 为 YYYY）
**phone_number** *string* 手机号码
**vid** *string* 虚拟 ID
返回示例
{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "image_quality": 0.771,
  "results": [{
     "card_side": "front",
     "card_type": "aadhaar_card",
     "card_info":{
       "name": "***",
       "gender": "Male",
       "mother_name": "",
       "father_name": "***",
       "date_type": "DOB",
       "date_info": "1982-03-15",
       "card_no": "XXXXXXXXX801",
       "vid": "XXXXXXXXXXXX8291",
       "phone_number": "XXXXXXXXXX"
      },
      "face_region": [
         [15, 460],
         [185, 460],
         [185, 666],
         [15, 666]
     ],
      "card_region": [
       [32, 241],
       [599, 241],
       [599, 556],
       [32, 556]
     ]
  }]
}
字段 类型 描述
**card_no** *string* Aadhaar 卡号
**vid** *string* 虚拟 ID
**son_of** *string* 之子
**daughter_of** *string* 之女
**care_of** *string* C/O 信息
**wife_of** *string* 配偶为（妻子）
**husband_of** *string* 配偶为（丈夫）
**city** *string* 城市
**state** *string* 州
**pin** *string* 邮政编码
**address** *string* 完整地址
**address_line_one** *string* 地址第一行
**address_line_two** *string* 地址第二行
返回示例
{
  "request_id": "TIDbf966570c8804c1586e06aaddd0738d8",
  "status": "OK",
  "image_quality": 0.771,
  "results": [{
     "card_side": "back",
     "card_type": "aadhaar_card",
     "card_info": {
        "address": "C/O : Sarangdhar Baburao ***",
         "address_line_one": "67,asangaon, ***",
        "address_line_two": "main rode ***, ***",
        "card_no": "4964 XXXX XXXX",
        "care_of": "***",
        "city": "Jalna",
        "daughter_of": "",
        "husband_of": "",
        "pin": "XXXXXX",
        "son_of": "",
        "state": "Maharashtra",
        "vid": "",
        "wife_of": ""
     },
     "card_region": [
       [32, 241],
       [599, 241],
       [599, 556],
       [32, 556]
     ]
  }]
}
字段 类型 描述
**card_no** *string* 账号
**name** *string* 姓名
**father_name** *string* 父亲姓名
**date_type** *string* 日期类型
**date_info** *string* 出生日期或年份
**issue_date** *string* 发证日期
返回示例
{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "image_quality": 0.771,
  "results": [{
     "card_side": "front",
     "card_type": "pan_card",
     "card_info":{
       "card_no": "XXXXX2601P",
       "name": "***",
       "father_name": "***",
       "date_type": "DOB",
       "date_info": "15/03/1982",
       "issue_date": "2003-06-08"
      },
      "face_region": [
         [15, 460],
         [185, 460],
         [185, 666],
         [15, 666]
       ]
      "card_region": [
       [32, 241],
       [599, 241],
       [599, 556],
       [32, 556]
     ]
  }]
}

4. 错误码

常见错误码：

HTTP 状态码 status 字段 描述
400 INVALID_ARGUMENT 请求参数无效
400 DETECTION_FAILED 图像识别失败
401 UNAUTHORIZED 未授权或拒绝访问
401 KEY_EXPIRED API 密钥已过期
403 NO_PERMISSION 无权限调用接口
403 OUT_OF_QUOTA 调用次数超出限额
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 ""