1. 接口描述
接口请求域名: ocr.tencentcloudapi.com 。
本接口支持马来西亚身份证识别,识别字段包括身份证号、姓名、性别、地址;具备身份证人像照片的裁剪功能和翻拍、复印件告警功能。
本接口暂未完全对外开放,如需咨询,请联系商务
默认接口请求频率限制:5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:MLIDCardOCR。 |
Version | 是 | String | 公共参数,本接口取值:2018-11-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-singapore 。 |
ImageBase64 | 否 | String | 图片的 Base64 值。 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 |
ImageUrl | 否 | String | 图片的 Url 地址。( 中国地区之外不支持这个字段 ) 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。 示例值:https://xx/a.jpg |
RetImage | 否 | Boolean | 是否返回图片,默认false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ID | String | 身份证号 示例值:710716-08-6085 |
Name | String | 姓名 示例值:KAVIN ONG KHI MN |
Address | String | 地址 示例值:NO 11 PERSIARN PERAJRIT 4 TAMA PERAK 31400 IPOH ERAK |
Sex | String | 性别 示例值:LEAKI |
Image | String | 证件图片 |
AdvancedInfo | String | 此字段为扩展字段。 返回字段识别结果的置信度,格式如下 { 字段名:{ Confidence:0.9999 } } 示例值:{"ID":{"Confidence":"1.0000"},"Name":{"Confidence":"0.9996"},"Address":{"Confidence":"0.9997"},"Sex":{"Confidence":"0.9999"}} |
Type | String | 证件类型 MyKad 身份证 MyPR 永居证 MyTentera 军官证 MyKAS 临时身份证 POLIS 警察证 IKAD 劳工证 MyKid 儿童卡 示例值:MyKad |
Birthday | String | 出生日期(目前该字段仅支持IKAD劳工证、MyKad 身份证) |
WarnCardInfos | Array of Integer | 告警码 -9101 证件边框不完整告警 -9102 证件复印件告警 -9103 证件翻拍告警 -9104 证件PS告警 -9107 证件反光告警 -9108 证件模糊告警 -9109 告警能力未开通 示例值:[-9101] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 马来西亚身份证识别示例代码
输入示例
https://ocr.tencentcloudapi.com/?Action=MLIDCardOCR &ImageUrl=https://xx/a.jpg &<公共请求参数>
输出示例
{
"Response": {
"Name": "KAVIN ONG KHI MN",
"ID": "710716-08-6085",
"Address": "NO 11 PERSIARN PERAJRIT 4 TAMA PERAK 31400 IPOH ERAK",
"Sex": "LEAKI",
"Birthday": "",
"Warn": [],
"Image": "",
"AdvancedInfo": "{\"ID\":{\"Confidence\":\"1.0000\"},\"Name\":{\"Confidence\":\"0.9996\"},\"Address\":{\"Confidence\":\"0.9997\"},\"Sex\":{\"Confidence\":\"0.9999\"}}",
"Type": "MyKad",
"RequestId": "c969da05-54e3-4d0a-a55d-b3ef90d4ebf5"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DownLoadError | 文件下载失败。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.NoMASIDCard | 非马来身份证。 |
FailedOperation.OcrFailed | OCR识别失败。 |
FailedOperation.UnKnowError | 未知错误。 |
FailedOperation.UnOpenError | 服务未开通。 |
FailedOperation.WarningServiceFailed | 通用告警服务异常 |
InvalidParameter.EngineImageDecodeFailed | 图片解码失败。 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
LimitExceeded.TooLargeFileError | 文件内容太大。 |
ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |