/text/v1_html_credit_report
1.接口描述
该 API 用于提取第一代授信机构版征信报告(html版本)上的文字信息。
- 文件要求
- 格式为 html,utf-8编码
- 小于等于 5 MB
请求方式
POST
请求 URL
https://cloudapi.deepfinch.com/text/v1_html_credit_report
调试工具
2.请求参数
2.1 请求头域
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
X-DF-API-ID | string | 是 | API调用凭证信息,详细信息请参考API调用 |
X-DF-API-SECRET | string | 是 | API调用凭证信息,详细信息请参考API调用 |
2.2 请求体
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
file | file | 见下方注释 | 需要提取的html文件。 |
file_base64 | string | 见下方注释 | 需要提取的html文件内容的base64编码。 |
参数
file
与file_base64
二选一。
参数file
需把文件的内容以 multipart/form-data 的形式放到 POST 消息体中。
3.返回参数
字段 | 类型 | 说明 |
---|---|---|
status | string | 状态,正常为 OK ,其他值表示失败,详见错误码 |
result | object | 结构化信息,详见返回结果 |
4.错误码
以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。
状态码 | status 字段 |
说明 |
---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
400 |
PARSE_FAILED | 文件解析失败 |
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": "PARAMETER_MISSING",
"reason": "param is missing or the value is empty: file"
}