有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: ocr.tencentcloudapi.com 。

印尼身份证识别

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RecognizeIndonesiaIDCardOCR。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-singapore 。
ImageBase64 String 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
示例值:image
ImageUrl String 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
示例值:https://xx/a.jpg
ReturnHeadImage Boolean 是否返回人像照片。
示例值:true
Scene String 场景参数,默认值为V1
可选值:
V1
V2

3. 输出参数

参数名称 类型 描述
NIK String 证件号码
示例值:360XXXXXX
Nama String 姓名
示例值:INM
TempatTglLahir String 出生地/出生时间
示例值:JAKARTA 13-01-1987
JenisKelamin String 性别
示例值:LAKEI
GolDarah String 血型
示例值:o
Alamat String 地址
示例值:BANJARSARI
RTRW String 街道
示例值:00/000
KelDesa String
示例值:PAKEMBINANGUN
Kecamatan String 地区
示例值:LAKEI
Agama String 宗教信仰
示例值:ATHOLIK
StatusPerkawinan String 婚姻状况
示例值:KAWFN
Perkerjaan String 职业
示例值:KARYAWAN
KewargaNegaraan String 国籍
示例值:INM
BerlakuHingga String 身份证有效期限
示例值:SEUMUR
IssuedDate String 发证日期
示例值:15-05-2015
Photo String 人像截图
Provinsi String 省份,Scene为V2时支持识别
Kota String 城市,Scene为V2时支持识别
WarnCardInfos Array of Integer 告警码
-9101 证件边框不完整告警
-9102 证件复印件告警
-9103 证件翻拍告警
-9107 证件反光告警
-9108 证件模糊告警
-9109 告警能力未开通
示例值:[-9101]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 RecognizeIndonesiaIDCardOCR

印尼身份证

输入示例

POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RecognizeIndonesiaIDCardOCR
<公共请求参数>

{
    "ReturnHeadImage": "false",
    "ImageUrl": "https://xx/a.jpg"
}

输出示例

{
    "Response": {
        "Agama": "ATHOLIK",
        "Alamat": "BANJARSARI",
        "BerlakuHingga": "SEUMUR HIDUP",
        "GolDarah": "O",
        "IssuedDate": "15-05-2015",
        "JenisKelamin": "LAKEI AKI",
        "Kecamatan": "",
        "KelDesa": "PAKEMBINANGUN",
        "KewargaNegaraan": "INM",
        "NIK": "360000000006",
        "Nama": "",
        "Perkerjaan": "KARYAWAN SWASTA",
        "Photo": "",
        "RTRW": "00/000",
        "RequestId": "0000-0000-0000-0001",
        "StatusPerkawinan": "KAWFN",
        "TempatTglLahir": "JAKARTA 13-01-1987",
        "Provinsi": "DKI JAKARTA",
        "Kota": "DKI JAKARTA"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.OcrFailed OCR识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
FailedOperation.WarningServiceFailed 通用告警服务异常
InvalidParameter.EngineImageDecodeFailed 图片解码失败。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourcesSoldOut.ChargeStatusException 计费状态异常。