/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.pakistan-1.accuauth.com/ocr/idcard
备用节点: https://cloudapi.pakistan.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 参数时，需将图像数据添加至 multipart/form-data 的 POST 请求中。

3. 返回参数

字段 类型 描述
request_id string 每个请求的唯一 ID
status string 响应状态：OK 表示成功，失败请参考 错误码
results array 识别结果数组，详见下文 results 部分
results 字段结构说明：
字段 类型 描述
card_type string 身份证类型：SNIC（新版智能身份证）或 NIC（老版身份证）
card_side string 卡片面：front（正面）或 back（背面）
card_info object 提取的主要身份信息
card_info 字段说明：

字段 类型 描述 适用卡类型
**id_number** *string* 身份证号码 SNIC NIC
**expiry_date** *string* 有效期截止日期 SNIC
**issue_date** *string* 签发日期 SNIC
**name** *string* 持证人姓名（英文） SNIC
**name_urdu** *string* 持证人姓名（乌尔都语） SNIC NIC
**birthday** *string* 出生日期 SNIC NIC
**gender** *string* 性别 SNIC NIC
**father_name** *string* 父亲姓名（英文） SNIC NIC
**father_name_urdu** *string* 父亲姓名（乌尔都语） SNIC NIC
**identifier** *string* 唯一身份标识（老卡专有） NIC
**country_of_stay** *string* 居住国家 SNIC
返回示例：
{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "results": [{
     "card_type": "SNIC",
     "card_side": "front",
     "card_info":{
        "id_number":"******",
        "name":"MUMAD XXXX",
        "name_urdu":"**** ****",
        "birthday":"08/17/1999",
        "gender":"M",
        "father_name":"****** ******",
        "father_name_urdu": "**** ***"
        "identifier":"",
        "country_of_stay": "Pakistan"
      }
  }]
}
字段 类型 描述 适用卡类型
**id_number** *string* 身份证号码 SNIC NIC
**current_address** *string* 当前住址 SNIC NIC
**expiry_date** *string* 有效期截止日期 NIC
**family_number** *string* 家庭编号 NIC
**permanent_address** *string* 永久地址 SNIC NIC
**issue_date** *string* 签发日期 NIC
返回示例：
{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "results": [{
     "card_type": "SNIC",
     "card_side": "back",
     "card_info":{
        "id_number":"******",
        "expiry_date":"04/05/2030",
        "issue_date":"04/05/2010",
        "family_number":"xxxxxxx",
        "permanent_address":"xxxxx xxxxxxx",
        "current_address":"xxxxx xxxxx"
      }
  }]
}

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