/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.thailand.accuauth.com/ocr/idcard
Debugging Tool
2. 请求参数
2.1 请求头
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X-DF-API-ID | string | 是 | 用于 API 认证,详见 API 请求 |
X-DF-API-SECRET | string | 是 | 用于 API 认证,详见 API 请求 |
2.2 请求体
是否必填 | 字段 | 类型 | 描述 |
---|---|---|---|
可选 | file | file | 图片的二进制数据 |
可选 | image_base64 | string | 图片的 Base64 编码数据 |
请求参数中必须提供
file
或image_base64
之一。使用
file
参数时,必须将图像流添加到 POST 消息的 multipart/form-data 部分中。
3. 返回参数
字段 | 类型 | 描述 |
---|---|---|
request_id | string | 每次请求的唯一 ID |
status | string | 请求状态,成功为 OK ,失败请参考 错误码 |
results | array | 卡片识别结果数组,详情见下方 results |
results
元素说明:
字段 | 类型 | 描述 |
---|---|---|
card_side | string | 卡片面:front 或 back |
card_type | string | ID 或 ALIEN (非泰国身份证) |
card_info | object | 卡片的关键信息 |
card_info
字段说明:
字段 | 类型 | 描述 |
---|---|---|
**id_number** | *string* | 身份证号码 |
**type_en** | *string* | 英文身份证类型 |
**type_th** | *string* | 泰文身份证类型 |
**name_en** | *string* | 英文姓名(含称谓如 Miss/Mrs/Mr) |
**name_th** | *string* | 泰文姓名 |
**last_name_en** | *string* | 英文姓氏 |
**birthday_en** | *string* | 出生日期(英文) |
**birthday_th** | *string* | 出生日期(泰文) |
**birthday_s** | *string* | 出生日期格式化:dd-mm-yyyy |
**issue_date_en** | *string* | 签发日期(英文) |
**issue_date_th** | *string* | 签发日期(泰文) |
**issue_date_s** | *string* | 签发日期格式化:dd-mm-yyyy |
**expiry_date_en** | *string* | 到期日期(英文) |
**expiry_date_th** | *string* | 到期日期(泰文) |
**expiry_date_s** | *string* | 到期日期格式化:dd-mm-yyyy |
**religion_th** | *string* | 宗教(泰文) |
**issuing_officer_th** | *string* | 签发官员(泰文) |
**address_th** | *string* | 地址(泰文) |
**picture_number** | *string* | 照片编号 |
返回格式示例
{
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
"status": "OK",
"results": [{
"card_side": "front",
"card_type": "ID",
"card_info":{
"id_number":"*****",
"type_en":"Thai National ID Card",
"type_th":"บัตรป*****น",
"name_en":"Miss *****",
"name_th":"น.ส. ***** *****",
"last_name_en":"*****",
"birthday_en":"20 Feb. 1995",
"birthday_th":"20 ก.พ. 2538",
"birthday_s":"20-02-1995",
"issue_date_en":"15 Nov. 2016",
"issue_date_th":"15 พ.ย. 2559",
"issue_date_s":"15-11-2016",
"expiry_date_en":"19 Feb. 2025",
"expiry_date_th":"19 ก.พ. 2568",
"expiry_date_s":"19-02-2025",
"religion_th":"พุทธ",
"issuing_officer_th":"***** *****",
"address_th":"****** ******* **** ***** ***",
"picture_number": "xxxx-xx-xxxxxxx"
}
}]
}
字段 | 类型 | 描述 |
---|---|---|
**id_number** | *string* | 身份证号码 |
**laser_number** | *string* | 激光码 |
返回格式示例
{
"request_id": "TID9567cb773ee645f9b20a9593f4d1c35a",
"results": [
{
"card_info": {
"card_number": "BORA-2.0-01-xxxx",
"laser_number": "ME0-1187***-**"
},
"card_type": "ID",
"card_side": "back"
}
],
"status": "OK"
}
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 | 调用次数已用完 |
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"
}