/ocr/utr
1. 接口说明
2. 请求参数
3. 返回参数
4. 错误码
5. 示例
1. 接口说明
该接口用于识别印度 UTR 图像,并提取关键信息。
图像规格
- 格式:JPG(JPEG)、PNG
- 分辨率范围:128128 到 60006000 像素,推荐:1280*1280
- 文件大小:不超过 5 MB
请求方法
POST
请求 URL
https://cloudapi.accuauth.in/ocr/utr
Debugging Tool
2. 请求参数
2.1 请求头
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| X-DF-API-ID | string | 是 | API 凭证,请参考 API Request |
| X-DF-API-SECRET | string | 是 | API 凭证,请参考 API Request |
2.2 请求体
| 是否必填 | 字段 | 类型 | 描述 |
|---|---|---|---|
| 可选 | file | file | 图像的二进制数据 |
| 可选 | image_base64 | string | 图像的 Base64 编码字符串 |
file或image_base64至少提供一个参数。使用
file时,请将图像流添加到 multipart/form-data 的 POST 消息体中。
3. 返回参数
| 字段 | 类型 | 描述 |
|---|---|---|
| request_id | string | 请求唯一 ID |
| status | string | 响应状态,成功为 OK,失败参见 错误码 |
| results | array | UTR OCR 识别结果数组,详见下方说明 |
results 中的元素:
| 字段 | 类型 | 描述 |
|---|---|---|
| card_side | string | UTR 图像面:front |
| card_info | object | UTR 图像关键信息 |
card_info 字段:
- UTR 正面信息:
| 字段 | 类型 | 描述 |
|---|---|---|
| upi_id | string | 保留字段,值与 upi_transaction_id 相同 |
| time_info | string | 时间字符串,格式为 YYYY-MM-DD HH:MM |
| upi_transaction_id | string | UPI 交易 ID |
| payer_name | string | 付款方姓名 |
| payer_upi_id | string | 付款方 UPI ID |
| payee_name | string | 收款方姓名 |
| payee_upi_id | string | 收款方 UPI ID |
返回示例
- UTR 正面
{
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
"status": "OK",
"results": [{
"card_side": "front",
"card_info":{
"upi_id": "1028423xxxxxx",
"time_info":"2024-06-12 13:52",
"upi_transaction_id": "1028423xxxxxx",
"payer_name": "***",
"payer_upi_id": "***@upi",
"payee_name": "***",
"payee_upi_id": "***@upi"
}
}]
}
4. 错误码
常见错误码:
| HTTP 状态码 | status 字段 |
描述 |
|---|---|---|
| 400 | INVALID_ARGUMENT | 请求参数无效 |
| 400 | DETECTION_FAILED | 图像识别失败 |
| 401 | UNAUTHORIZED | 未授权或拒绝访问 |
| 401 | KEY_EXPIRED | API 密钥已过期 |
| 403 | NO_PERMISSION | 无权限调用接口 |
| 403 | OUT_OF_QUOTA | 调用次数超出限额 |
| 403 | RATE_LIMIT_EXCEEDED | 请求频率超出限制 |
| 404 | NOT_FOUND | 接口不存在 |
| 500 | INTERNAL_ERROR | 服务器内部错误 |
备注: 遇到 40X 错误时,请检查返回的 reason 字段说明。
返回示例
{
"status": "INVALID_ARGUMENT",
"reason": "must specify 'file' or 'image_base64' argument",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}