1. 接口描述
接口请求域名: ocr.tencentcloudapi.com 。
本接口支持泰国身份证识别,识别字段包括泰文姓名、英文姓名、地址、出生日期、身份证号码、首次领用日期、签发日期等字段。
本接口暂未完全对外开放,如需咨询,请联系商务
默认接口请求频率限制:10次/秒
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:RecognizeThaiIDCardOCR。 |
| Version | 是 | String | 公共参数,本接口取值:2018-11-19。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ImageBase64 | 否 | String | 图片的 Base64 值。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。 示例值:/9j/4AAQSkZJRg.....s97n//2Q== |
| BackImageBase64 | 否 | String | 卡证背面图片的 Base64 值。支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。 示例值:/9j/4AAQSkZJRg.....s97n//2Q== |
| ImageUrl | 否 | String | 图片的 Url 地址。要求图片经Base64编码后不超过 7M,分辨率建议500800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。建议图片存储于腾讯云,可保障更高的下载速度和稳定性。 示例值:https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/**/fakeurl.jpg |
| BackImageUrl | 否 | String | 卡证背面图片的 Url 地址。支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 示例值:https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg |
| CropPortrait | 否 | Boolean | 图片开关。默认为false,不返回泰国身份证头像照片的base64编码。 示例值:false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ID | String | 身份证号码 示例值:3102001968756 |
| ThaiName | String | 泰文姓名 示例值:นาย ธนกฤต บุญโญปกรุณ์ |
| EnFirstName | String | 英文姓名 示例值:Mr. Thanakit |
| EnLastName | String | 英文姓名 示例值:Boonyopakron |
| IssueDate | String | 泰文签发日期 示例值:9ธ.ค.2559 |
| ExpirationDate | String | 泰文到期日期 示例值:13ธ.ค.2567 |
| EnIssueDate | String | 英文签发日期 示例值:29 Mar. 2021 |
| EnExpirationDate | String | 英文到期日期 示例值:12 Mar. 2030 |
| Birthday | String | 泰文出生日期 示例值:14ธ.ค.2509 |
| EnBirthday | String | 英文出生日期 示例值:13 Mar. 1986 |
| Religion | String | 宗教信仰 示例值:พุทธ |
| SerialNumber | String | 序列号 示例值:1047-02-03291045 |
| Address | String | 地址 示例值:ที่อยู่21/19หมู่ที่3ต.บางคูครัดอ.บางบัวทอง |
| LaserID | String | 背面号码 示例值:JC4-1841713-14 |
| PortraitImage | String | 证件人像照片抠取 示例值:/9j/4AAQSkZJRg.....s97n//2Q== |
| WarnCardInfos | Array of Integer | 告警码 示例值:[-9101] |
| CardCount | Integer | 卡证正面图片中,证件主体的数量(仅请求曼谷地域[ap-bangkok]返回) 示例值:1 |
| ThaiFirstName | String | 泰文姓名 示例值:ธนกฤต |
| ThaiLastName | String | 泰文姓名 示例值:บุญโญปกรุณ์ |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 RecognizeThaiIDCardOCR调用
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RecognizeThaiIDCardOCR
<公共请求参数>
{
"ImageUrl": "https://ai-demo-1426683817.cos.ap-chengdu.myqcloud.com/xxx"
}
输出示例
{
"Response": {
"Address": "ที่อยู่ 27 ****ฐีระเวช 7 ต.ตะพ***ิน ****พานห** จ.พิจิตร",
"Birthday": "28 ม.ค. 2542",
"EnBirthday": "28 Jan. 1999",
"EnExpirationDate": "27 Jan. 2031",
"EnFirstName": "Miss Nat*****cha",
"EnIssueDate": "26 Mar. 2022",
"EnLastName": "Ph*******wan",
"ExpirationDate": "27 ม.ค. 2574",
"ID": "1 6604 ***** 52 4",
"IssueDate": "26 มี.ค. 2565",
"LaserID": "",
"PortraitImage": "",
"Religion": "พุทธ",
"SerialNumber": "10**-03-*****113",
"ThaiName": "น.ส. ณั*********ชราวรรณ",
"WarnCardInfos": [
-9109
],
"RequestId": "23e58a98-0cbd-46dd-aad8-7144bf7cf47a"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DownLoadError | 文件下载失败。 |
| FailedOperation.EmptyImageError | 图片内容为空。 |
| FailedOperation.IdCardTooSmall | 图片分辨率过小或身份证在原图中的占比过小 |
| FailedOperation.ImageBlur | 图片模糊。 |
| FailedOperation.ImageDecodeFailed | 图片解码失败。 |
| FailedOperation.ImageNoSpecifiedCard | 非指定卡类别图片 |
| FailedOperation.OcrFailed | OCR识别失败。 |
| FailedOperation.UnKnowError | 未知错误。 |
| FailedOperation.UnOpenError | 服务未开通。 |
| FailedOperation.WarningServiceFailed | 通用告警服务异常 |
| InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
| LimitExceeded.TooLargeFileError | 文件内容太大。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |