/ocr/add_credit_report_ocr_task
1.接口描述
该 API 用于提交征信报告OCR任务。
- 图片要求:
- 格式为 pdf
- 小于等于 30 MB
请求方式
POST
请求 URL
https://cloudapi.deepfinch.com/ocr/add_credit_report_ocr_task
调试工具
2.请求参数
2.1 请求头域
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
X-DF-API-ID | string | 是 | API调用凭证信息,详细信息请参考API调用 |
X-DF-API-SECRET | string | 是 | API调用凭证信息,详细信息请参考API调用 |
2.2 请求体
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
file | file | 是 | 征信报告扫描件PDF文件 |
参数 file 需把图片文件以 multipart/form-data 的形式放到 POST 消息体中。
3.返回参数
字段 | 类型 | 说明 |
---|---|---|
request_id | string | 本次请求的ID |
status | string | 返回状态, 正常为OK , 其他值表示失败, 详见错误码 |
task_id | string | 任务ID, 用于后续查询任务结果 |
返回结果示例
{
"request_id": "TIDf7802c753b3048eb8524f2dc143b7a70",
"status": "OK",
"task_id": "8bf47ab6eda64476973cc5f5b6ebf"
}
4.错误码
状态码 | status 字段 |
说明 |
---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
401 |
UNAUTHORIZED | 未授权 |
401 |
KEY_EXPIRED | 授权过期 |
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' argument",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}