/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.indonesia.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 编码数据

fileimage_base64 参数必须至少提供一个。

当使用 file 参数时,必须将图像流添加到 POST 消息的 multipart/form-data 部分。

3. 返回参数

字段 类型 描述
request_id string 每次请求的唯一 ID
status string 响应状态,成功为 OK,失败请参阅 错误码
results array 身份证 OCR 结果数组,详见下方 results 字段
results 中的字段:
字段 类型 描述
id_number string 身份证号码
name string 姓名
pob string 出生地
dob string 出生日期
gender string 性别
gender_s string 格式化性别:M(男性)或 F(女性)
address string 地址
province string 所在省
city string 所在城市
district string 所在区
village string 所在村
rt string RT(居民小区代码)
rw string RW(社区编号)
religion string 宗教信仰
marital_status string 婚姻状况
work string 职业
nationnality string 国籍

返回示例
{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "results": [{
    "id_number": "**********",
    "name": "**********",
    "dob": "26-12-1993",
    "gender": "LAKI-LAKI",
    "gender_s": "M",
    "address": "**********",
    "province": "xxxxx",
    "city": "xxxxx",
    "district": "",
    "village": "xxx",
    "rt": "",
    "rw": "",
    "religion": "",
    "marital_status": "KAWIN",
    "work": "",
    "nationnality": "WNI"
  }]
}

4. 错误码

此 API 的常见错误码如下:

HTTP 状态码 status 字段 描述
400 INVALID_ARGUMENT 请求参数无效
400 DETECTION_FAILED 图像识别失败
401 UNAUTHORIZED 未授权或拒绝访问
401 KEY_EXPIRED API ID 已过期
403 NO_PERMISSION 没有权限使用此 API
403 OUT_OF_QUOTA 超出 API 调用配额
403 RATE_LIMIT_EXCEEDED 请求频率超过限制
404 NOT_FOUND 未找到对应 API
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 ""