/ocr/pdf_credit_report
1.接口描述
该 API 用于识别提取征信报告上的文字信息。
- 文件要求
- 格式为 PDF
- 小于等于 100 MB
请求方式
POST
请求 URL
https://cloudapi.deepfinch.com/ocr/pdf_credit_report
调试工具
2.请求参数
2.1 请求头域
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
X-DF-API-ID | string | 是 | API调用凭证信息,详细信息请参考API调用 |
X-DF-API-SECRET | string | 是 | API调用凭证信息,详细信息请参考API调用 |
2.2 请求体
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
file | file | 见下方注释 | 需上传的文件。上传本地文件进行检测时选取此参数 |
参数file
需把文件的内容以 multipart/form-data 的形式放到 POST 消息体中。
3.返回参数
字段 | 类型 | 说明 |
---|---|---|
status | string | 状态,正常为 OK ,其他值表示失败,详见错误码 |
structured_result | object | 结构化信息,详见返回结果 |
structured_result
字段信息
字段 | 类型 | 说明 |
---|---|---|
serialNo | string | 报告编号 |
askAt | string | 查询请求时间 |
createAt | string | 报告时间 |
whoWasChecked | string | 被查询者姓名 |
idType | string | 被查询者证件类型 |
idNum | string | 被查询者证件号码 |
organization | string | 查询操作机构 |
operator | string | 查询操作人 |
reason | string | 查询原因 |
profile | object | 个人基本信息 |
creditInfo | object | 信用提示 |
overdueBreachOutline | object | 呆帐、资产处置、保证人代偿信息汇总 |
overDueInfoCollection | object | 逾期(透支)信息汇总 |
noPayedInfoCollection | object | 未结清贷款信息汇总 |
destroyedCrtCardCollection | object | 未销户贷记卡信息汇总 |
noDestroyedQuasiCrtCardCollection | object | 未销户准贷记卡信息汇总 |
guaranteeCollection | object | 对外担保信息汇总 |
assetsDisposal | objectArray | 资产处置信息 |
assurerRepayInfos | objectArray | 保证人代偿信息 |
loans | objectArray | 贷款 |
creditCards | objectArray | 贷记卡 |
quasiCreditCards | objectArray | 准贷记卡 |
loanGuaranteeInfos | objectArray | 对外贷款担保信息 |
creditCardGuaranteeInfos | objectArray | 对外信用卡担保信息 |
owedTaxesRecord | objectArray | 欠税记录 |
civilJudgmentRecord | objectArray | 民事判决记录 |
forceExecutions | objectArray | 强制执行记录 |
administrativePenaltyRecord | objectArray | 行政处罚记录 |
houseFundPayedRecord | objectArray | 住房公积金参缴记录 |
socialSecuritys | objectArray | 养老保险金缴存记录 |
subsistenceAllowanceRecord | objectArray | 低保救助记录 |
competenceRecordInfos | objectArray | 执业资格记录 |
administrativeRewardRecord | objectArray | 行政奖励记录 |
carTradeOrPledges | objectArray | 车辆交易和抵押记录 |
telRecord | objectArray | 电信缴费记录 |
checkedRecord | object | 查询记录汇总 |
checkDetails | objectArray | 机构查询记录明细 |
querySelfRecordDetail | objectArray | 本人查询记录明细 |
返回结果
{
"serialNo": "报告编号",
"askAt": "查询请求时间",
"createAt": "报告时间",
"whoWasChecked": "被查询者姓名",
"idType": "被查询者证件类型",
"idNum": "被查询者证件号码",
"organization": "查询操作机构",
"operator": "查询操作人",
"reason": "查询原因",
"profile": {
"gender": "性别",
"genderOrganization": "性别数据发生机构名称",
"birthday": "出生日期",
"birthdayOrganization": "出生日期数据发生机构名称",
"isMarried": "婚姻状况",
"isMarriedOrganization": "婚姻状况数据发生机构名称",
"mobile": "手机号码",
"mobileOrganization": "手机号码数据发生机构名称",
"officeTel": "单位电话",
"officeTelOrganization": "单位电话数据发生机构名称",
"homeTel": "住宅电话",
"homeTelOrganization": "住宅电话数据发生机构名称",
"education": "学历",
"educationOrganization": "学历数据发生机构名称",
"qualification": "学位",
"qualificationOrganization": "学位数据发生机构名称",
"postAddr": "通讯地址",
"postAddrOrganization": "通讯地址数据发生机构名称",
"registerAddr": "户籍地址",
"registerAddrOrganization": "户籍地址数据发生机构名称",
"connubialInfo": {
"name": "姓名",
"idType": "证件类型",
"idNum": "证件号码",
"compony": "工作单位",
"tel": "联系电话",
"connubialInfoOrganization": "配偶信息数据发生机构名称"
},
"livedInfos": [{
"no": "编号",
"address": "居住地址",
"status": "居住状况",
"updateAt": "信息更新日期",
"livedInfosOrganization": "居住信息数据发生机构名称"
}],
"experiences": [{
"no": "编号",
"company": "工作单位",
"address": "单位地址",
"jobNature": "职业",
"industry": "行业",
"title": "职务",
"level": "职称",
"startedAt": "进入本单位年份",
"updateAt": "信息更新日期",
"experiencesOrganization": "职业信息数据机构名称"
}]
},
"creditInfo": {
"houseLoansNum": "个人住房贷款笔数",
"commercialHouseLoansNum": "个人商用房(包括商住两用)贷款笔数",
"otherLoansNum": "其他贷款笔数",
"firstLoanGotAt": "首笔贷款发放月份",
"creditCardsNum": "贷记卡账户数",
"firstCreditCardGotAt": "首张贷记卡发卡月份",
"quasiCardsNum": "准贷记卡账户数",
"firstQuasiCardGotAt": "首张准贷记卡发卡月份",
"selfDeclaredNum": "本人声明数目",
"objectionLabelNum": "异议标注数目"
},
"overdueBreachOutline": {
"badDebtsNumber": "呆账信息汇总笔数",
"badDebtsBalance": "呆账信息汇总余额",
"assetsDisposalNumber": "资产处置信息汇总笔数",
"assetsDisposalBalance": "资产处置信息汇总余额",
"guarantorCompensationNumber": "保证人代偿信息汇总笔数",
"guarantorCompensationBalance": "保证人代偿信息汇总余额"
},
"overDueInfoCollection": {
"loanNum": "贷款逾期笔数",
"loanMonth": "贷款逾期月份数",
"loanMaxAmount": "贷款逾期单月最高逾期总额",
"loanMaxMonths": "贷款逾期最长逾期月数",
"crdCardAccounts": "贷记卡逾期账户数",
"crdCardMonth": "贷记卡逾期月份数",
"crdCardMaxAmount": "贷记卡逾期单月最高逾期总额",
"crdCardMaxMonths": "贷记卡逾期最长逾期月数",
"qcCardAccounts": "准贷记卡60天以上透支账户数",
"qcCardMonth": "准贷记卡60天以上透支月份数",
"qcCardMaxAmount": "准贷记卡60天以上透支单月最高透支余额",
"qcCardMaxMonths": "准贷记卡60天以上透支最长透支月数"
},
"noPayedInfoCollection": {
"companys": "贷款法人机构数",
"organizations": "贷款机构数",
"num": "笔数",
"amount": "合同总额",
"surplusAmount": "余额",
"avg6monthPay": "最近6个月平均应还款"
},
"destroyedCrtCardCollection": {
"companys": "发卡法人机构数",
"organizations": "发卡机构数",
"accounts": "账户数",
"amount": "授信总额",
"maxAmount": "单家行最高授信额",
"leastAmount": "单家行最低授信额",
"usedAmount": "已用额度",
"avg6monthPay": "最近6个月平均使用额度"
},
"noDestroyedQuasiCrtCardCollection": {
"companys": "发卡法人机构数",
"organizations": "发卡机构数",
"accounts": "账户数",
"amount": "授信总额",
"maxAmount": "单家行最高授信额",
"leastAmount": "单家行最低授信额",
"surplusAmount": "透支余额",
"avg6monthOverdraft": "最近6个月平均透支余额"
},
"guaranteeCollection": {
"count": "担保笔数",
"amount": "担保金额",
"balance": "担保本金余额"
},
"assetsDisposal":[{
"no": "编号",
"assetsCompany": "资产管理公司",
"debtReceiveDate": "债务接收日期",
"debtAmount": "接收的债权金额",
"latestRepayDate": "最近一次还款日期",
"balance": "余额"
}],
"assurerRepayInfos": [{
"no": "编号",
"organName": "代偿机构",
"latestAssurerRepayDate": "最近一次代偿日期",
"money": "累计代偿金额",
"latestRepayDate": "最近一次还款日期",
"balance": "余额"
}],
"loans": [{
"serialNo": "编号",
"businessNo": "业务号",
"organization": "贷款发放机构",
"amount": "贷款金额",
"currency": "币种",
"periods": "贷款期数",
"rate": "还款频率",
"type": "贷款类型",
"guarantee": "担保方式",
"startAt": "发放日期",
"endAt": "到期日期",
"finAt": "截至日期",
"startRt": "开始还款日期",
"endRt": "结束还款日期",
"status": "账户状态",
"category": "五级分类",
"balance": "本金余额",
"surplusPaymentNum": "剩余还款期数",
"scheduledPayment": "本月应还款",
"scheduledPayAt": "应还款日",
"currPayed": "本月实还款",
"lastPayedAt": "最近一次还款日期",
"currOverduePeriods": "当前逾期期数",
"currOverdue": "当前逾期金额",
"overdue31Tp60": "逾期31-60天未还本金",
"overdue61Tp90": "逾期61-90天未还本金",
"overdue91Tp180": "逾期91-180天未还本金",
"overdue180": "逾期180天以上未还本金",
"last24Status": "最近24个月还款记录",
"overdueRecordSummary": {
"startAt": "开始日期",
"endAt": "结束日期",
"records ": [{
"overdueMonth": "逾期月份",
"overdueMonthsNum": "逾期持续月数",
"amount": "逾期金额"
}]
},
"speBusinesses": [{
"type": "特殊交易类型",
"startAt": "发生日期",
"changeMonths": "变更月数",
"amount": "发生金额",
"detail": "明细记录"
}]
}],
"creditCards": [{
"serialNo": "编号",
"businessNo": "业务号",
"organization": "发卡机构",
"amount": "授信额度金额",
"amountType": "授信额度",
"sharedAmount": "共享授信额度金额",
"sharedAmountType": "共享授信额度",
"accountCategory": "账户类型",
"guarantee": "担保方式",
"startAt": "发卡日期",
"finAt": "截至日期",
"balance": "余额",
"status": "账户状态",
"used": "已用额度",
"avgUsed6Months": "最近6个月平均使用额度",
"maxAmount": "最大使用额度",
"scheduledPayed": "本月应还款",
"payAt": "账单日",
"payed": "本月实还款",
"lastPayedAt": "最近一次还款日期",
"currOverduePeriods": "当前逾期期数",
"currOverdue": "当前逾期金额",
"startRt": "开始还款日期",
"endRt": "结束还款日期",
"last24Status": "最近24个月还款记录",
"overdueRecordSummary": {
"startAt": "开始日期",
"endAt": "结束日期",
"records ": [{
"overdueMonth": "逾期月份",
"overdueMonthsNum": "逾期持续月数",
"amount": "逾期金额"
}]
},
"speBusinesses": [{
"type": "特殊交易类型",
"startAt": "发生日期",
"changeMonths": "变更月数",
"amount": "发生金额",
"detail": "明细记录"
}]
}],
"quasiCreditCards": [{
"serialNo": "编号",
"businessNo": "业务号",
"organization": "发卡机构",
"amount": "授信额度金额",
"amountType": "授信额度",
"sharedAmount": "共享授信额度金额",
"sharedAmountType": "共享授信额度",
"accountCategory": "账号种类",
"guarantee": "担保方式",
"startAt": "发卡日期",
"finAt": "截至日期",
"balance": "余额",
"status": "账户状态",
"surplusOverdraft": "透支余额",
"avgSurOver6Months": "最近6个月平均透支余额",
"maxSurplusOverdraft": "最大透支余额",
"payAt": "账单日",
"payed": "本月实还款",
"lastPayedAt": "最近一次还款日期",
"noPayedOver180": "透支180天以上未付余额",
"startRt": "开始还款日期",
"endRt": "结束还款日期",
"last24Status": "最近24个月还款记录",
"overdraftRecordSummary": {
"startAt": "开始日期",
"endAt": "结束日期",
"records": [{
"month": "透支月份",
"keepMonths": "透支持续月数",
"amount": "透支金额"
}]
},
"speBusinesses": [{
"type": "特殊交易类型",
"startAt": "发生日期",
"changeMonths": "变更月数",
"amount": "发生金额",
"detail": "明细记录"
}]
}],
"loanGuaranteeInfos": [{
"id": "编号",
"organization": "担保贷款发放机构",
"amount": "担保贷款合同金额",
"gotAt": "担保贷款发放日期",
"expireAt": "担保贷款到期日期",
"guaranteeAmount": "担保金额",
"balance": "担保贷款本金余额",
"category": "担保贷款五级分类",
"payAt": "应还款日",
"guarantorName": "被担保人姓名",
"guarantorIdType": "被担保人证件类型",
"guarantorId": "被担保人证件号码"
}],
"creditCardGuaranteeInfos": [{
"id": "编号",
"organization": "担保信用卡发放机构",
"amount": "担保信用卡授信额度",
"gotAt": "担保信用卡发卡日期",
"guaranteeAmount": "担保金额",
"used": "担保信用卡已用额度",
"payAt": "账单日"
}],
"owedTaxesRecord": [{
"no": "编号",
"competentTaxAuthorities": "主管税务机关",
"taxesTotal": "欠税总额",
"taxRegistrationDate": "欠税统计日期"
}],
"civilJudgmentRecord": [{
"no": "编号",
"court": "立案法院",
"caseReason": "案由",
"registerDate": "立案日期",
"closedType": "结案方式",
"sentenceResult": "判决/调解结果",
"sentenceResultDate": "判决/调解生效日期",
"actionObject": "诉讼标的",
"actionObjectMoney": "诉讼标的金额"
}],
"forceExecutions": [{
"no": "编号",
"court": "执行法院",
"caseReason": "执行案由",
"registerDate": "立案日期",
"closedType": "结案方式",
"caseState": "案件状态",
"closedDate": "结案日期",
"enforceObject": "申请执行标的",
"enforceObjectMoney": "申请执行标的价值",
"alreadyEnforceObject": "已执行标的",
"alreadyEnforceObjectMoney": "已执行标的金额"
}],
"administrativePenaltyRecord": [{
"no": "编号",
"punishmentOrganization": "处罚机构",
"punishmentContent": "处罚内容",
"punishmentAmount": "处罚金额",
"effectDate": "生效日期",
"closeDate": "截止日期",
"administrationReviewOrg": "行政复议结果"
}],
"houseFundPayedRecord": [{
"no": "编号",
"address": "参缴地",
"payAt": "参缴日期",
"firstPayedAt": "初缴月份",
"lastPayedAt": "缴至月份",
"status": "缴费状态",
"amount": "月缴存额",
"personalPercent": "个人缴存比例",
"componyPercent": "单位缴存比例",
"compony": "缴费单位",
"updateAt": "信息更新日期"
}],
"socialSecuritys": [{
"no": "编号",
"ginsengto": "参保地",
"insuredDate": "参保日期",
"countMonth": "累计缴费月数",
"jobMonth": "参加工作月份",
"status": "缴费状态",
"personageCostNumber": "个人缴费基数",
"monthAmount": "本月缴费金额",
"messageUpdateDate": "信息更新日期",
"unit": "缴费单位",
"cause": "中断或终止缴费原因"
}],
"subsistenceAllowanceRecord": [{
"no": "编号",
"personType": "人员类别",
"location": "所在地",
"company": "工作单位",
"familyMonthlyIncome": "家庭月收入",
"applicationDate": "申请日期",
"approvalDate": "批准日期",
"updateDate": "信息更新日期"
}],
"competenceRecordInfos": [{
"no": "编号",
"competencyname": "执业资格名称",
"grade": "等级",
"awarddate": "获得日期",
"enddate": "到期日期",
"revokedate": "吊销日期",
"organname": "颁发机构",
"area": "机构所在地"
}],
"administrativeRewardRecord": [{
"no": "编号",
"rewardOrganization": "奖励机构",
"rewardContent": "奖励内容",
"effectDate": "生效日期",
"closeDate": "截止日期"
}],
"carTradeOrPledges": [{
"no": "编号",
"licensecode": "车牌号码",
"enginecode": "发动机号",
"brand": "品牌",
"cartype": "车辆类型",
"usecharacter": "使用性质",
"state": "车辆状态",
"pledgeflag": "抵押标记",
"gettime": "信息更新日期"
}],
"telRecord": [{
"no": "编号",
"companyNo": "电信运营商",
"busiType": "业务类型",
"openDate": "业务开通日期",
"status": "当前缴费状态",
"oweMoney": "当前欠费金额",
"oweNum": "当前欠费月数",
"acctDate": "记账年月",
"pay24Months": "最近24个月缴费记录"
}],
"checkedRecord": {
"lastMonthLoanCheckOrgs": "最近1个月内的贷款审批查询机构数",
"lastMonthCardCheckOrgs": "最近1个月内的信用卡审批查询机构数",
"lastMonthLoanCheck": "最近1个月内的贷款审批查询次数",
"lastMonthCardCheck": "最近1个月内的信用卡审批查询次数",
"lastMonthCheckBySelf": "最近1个月内的本人查询次数",
"last2YearsAfterLoaned": "最近2年内的贷后管理查询次数",
"last2YearsQualificationCheck": "最近2年内的担保资格审查查询次数",
"last2YearsVIPNameCheck": "最近2年内的特约商户实名审查查询次数"
},
"checkDetails": [{
"no": "编号",
"checkedAt": "查询日期",
"operator": "查询操作员",
"reason": "查询原因"
}],
"querySelfRecordDetail": [{
"no": "编号",
"queryDate": "查询日期",
"queryOperator": "查询操作员",
"queryReason": "查询原因"
}]
}
4.错误码
以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。
状态码 | status 字段 |
说明 |
---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
400 |
DETECTION_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"
}