/ocr/idcard - 身份证识别接口

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

1.API 说明

该 API 用于识别秘鲁身份证并提取关键信息。

图片规格

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

请求方法

POST

请求地址

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

Debugging Tool

Debugging Tool

2.请求参数

2.1 请求头

2.2 请求体

Either parameter file or image_base64 必须提供作为请求参数.

使用 file 参数时，必须将图像流添加到 POST 请求的 multipart/form-data 部分。

3.响应参数

results中的字段:

card_info中的字段

• 新ID卡正面

• 新ID卡背面

• 旧版ID卡正面

• 旧版ID卡背面

• 外国人卡正面

• 外国人卡背面

返回示例

• 新ID卡正面

{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "results": [{
     "card_type": "new",
     "card_side": "front",
     "card_info":{
     "id_number": "1075xxxx-x",
     "father_name": "COMXX",
     "mother_name": "CCAXXXXX",
     "name": "ANA ISAXXX",
     "gender": "FEMENINO",
     "gender_s": "F",
     "marriage": "Soltero",
     "birthday": "16/05/1994",
     "birth_place": "140133",
     "issue_date": "11/10/2019",
     "expiry_date": "11/10/2024",
     "election_number": "053xxx",
     "organ_donation": "NO"
  },
  "face_region": [
    [
        325,
        1010
    ],
    [
        736,
        1010
    ],
    [
        736,
        1523
    ],
    [
        325,
        1523
    ]
  ]
]
}

• 新ID卡背面

{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "results": [{
     "card_type": "new",
     "card_side": "back",
     "card_info":{
       "region": "LIMA/LIMA/LA VICTORIA",
       "address": "15 DE JULIO 10XX DPTO.21X"
  }]
}

• 旧卡正面

{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "results": [{
     "card_type": "old",
     "card_side": "front",
     "card_info":{
       "id_number": "1075xxxx-x",
       "father_name": "COMXX",
       "mother_name": "CCAXXXXX",
       "name": "ANA ISAXXX",
       "gender": "F",
       "marriage": "S",
       "birthday": "16/05/1994",
       "birth_place": "140133",
       "registration_date": "11/10/2016",
       "issue_date": "11/10/2019",
       "expiry_date": "11/10/2024",
    },
    "face_region": [
      [
        325,
        1010
      ],
      [
        736,
        1010
      ],
      [
        736,
        1523
      ],
      [
        325,
        1523
      ]
    ]
]
}

• 旧卡背面

{
  "request_id": "TIDcfa616942c0e4c4cb3870cfb9b1a94be",
  "results": [
    {
      "card_info": {
        "address": "AV. BRASIL xxxx",
        "department": "LIMA",
        "district": "JESUS MARIA",
        "election_number": "036xxx",
        "organ_donation": "NO",
        "province": "LIMA"
      },
      "card_side": "back",
      "card_type": "old"
    }
  ],
  "status": "OK"
}

• 外国人卡正面

{
    "request_id": "TIDdcda3ce2753a4455b459b370d7768dd1",
    "results": [
        {
            "card_info": {
                "birthday": "xx MAR 1991",
                "birthday_s": "xx-03-1991",
                "document_number": "",
                "expiry_date": "",
                "expiry_date_s": "",
                "gender": "M",
                "gender_s": "M",
                "given_name": "ADRIAN XXXXXX",
                "id_number": "004599xxx",
                "issue_date": "",
                "issue_date_s": "",
                "marriage": "S",
                "migratory_quality": "ESP ESPECIAL",
                "nationality": "VENEZOLANA",
                "surname": "RIOS XXXXX"
            },
            "card_side": "front",
            "card_type": "ALIEN",
            "face_region": [
                [
                    325,
                    1010
                ],
                [
                    736,
                    1010
                ],
                [
                    736,
                    1523
                ],
                [
                    325,
                    1523
                ]
              ]
        }
    ],
    "status": "OK"
}

• 外国人卡背面

{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "results": [{
     "card_type": "ALIEN",
     "card_side": "back",
     "card_info":{
       "region": "LIMA / LIMA / ATE",
       "nationality_code": "VEN",
       "address": "HUMANO SAN JUAN BAUTIS**** ***"
  }]
}

4.错误码

常见错误码如下：

说明： 当出现 40X 错误时，请查看响应中的 reason 字段以获取详细信息。

错误返回示例：

{
  "status": "INVALID_ARGUMENT",
  "reason": "must specify 'file' or 'image_base64' argument",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.Sample