跳到正文

开发文档 / API v1

中登查询与查重 API 接口参考

查阅智能中登开放 API 的请求参数、响应字段和状态码,涵盖账户权益、企业登记查询、自动查重、证据定位与文件下载,可下载完整 OpenAPI 契约。

更新于

接口约定

以下路径相对于 /api/open/v1,由公开 OpenAPI 契约在构建时生成。请求通过 X-Api-Key 认证,仅访问本人资源。分页从 1 开始,默认每页 20 条,最多 100 条;JSON 成功响应没有额外的 data 包裹。

创建任务返回 202,表示已受理;请继续读取执行状态。参数字段、重试和计次规则见接入规则。

请求体和成功响应的字段直接列在对应接口内;尚未展开的嵌套类型可点击查看数据结构。 请求体中的 criteria[].kind表示条件列表中每一项的类型。嵌套字段标为“父字段有值时必需”,表示父对象出现时该字段必填。

下载 OpenAPI 3.1.0 契约 →

账户权益

账户权益

GET/account/entitlements

响应

200 · OK

application/json · PublicEntitlements

字段类型必需说明与约束
accountIdstring是

当前 API Key 所属账户的稳定标识;同账户不同密钥返回相同值,用于绑定重试意图,不是登录凭据

activeboolean是

当前账户是否拥有有效订阅

apiEnabledboolean是

当前有效订阅是否允许创建 API 任务;不表示剩余额度充足,不影响已有结果读取及成功请求重放

checkPublicAllowance是

查重次数的总额、使用、预留及可用情况

queryPublicAllowance是

查询次数的总额、使用、预留及可用情况

subscriptionPublicSubscription | null是

当前订阅详情;无有效订阅时为 null

查看通用响应与状态码 →

主体登记查询

查询任务列表

GET/queries

请求参数

参数位置类型 / 必需说明
searchquerystring / 否按企业全称、身份证号码或查询任务 ID 搜索;留空返回全部;%/_/! 按字面匹配默认值:""
statusquerystring / 否按任务业务状态筛选;留空表示全部状态

允许值:"" · "all" · "queued" · "waiting_resource" · "processing" · "succeeded" · "no_result" · "partial" · "failed" · "cancelled"

pagequeryinteger (int32) / 否页码,从 1 开始默认值:1最小值:1
pageSizequeryinteger (int32) / 否每页条数,范围 1–100默认值:20最大值:100最小值:1

响应

200 · OK

application/json · PublicPagePublicQuery

字段类型必需说明与约束
itemsarray<PublicQuery>是

当前页的查询任务

pageinteger (int32)是

当前页码,从 1 开始

pageSizeinteger (int32)是

每页条数

totalinteger (int64)是

符合筛选条件的查询任务总数

查看通用响应与状态码 →

创建主体查询

POST/queries

请求参数

参数位置类型 / 必需说明
Idempotency-Keyheaderstring / 是同一业务意图的非空唯一幂等键,最长 128 字符;重试沿用原键和原请求体最长长度:128最短长度:1

请求体(必填)

application/json · PublicCreateQueries

字段类型必需说明与约束
subjectNamesarray<string>是

本批查询主体:企业全称或18位大陆居民身份证号码,1–100 项;规范化去重后按主体计次

最多项:100最少项:1

响应

202 · Accepted

已受理,需继续查询状态;受理成功不表示任务已经完成。

application/json · PublicAcceptedQueries

字段类型必需说明与约束
queriesarray<PublicQuery>是

整批受理的查询任务;每个 ID 分别轮询

查看通用响应与状态码 →

查询进度与摘要

GET/queries/{id}

请求参数

参数位置类型 / 必需说明
idpathstring / 是路径所指查询、查重任务或文档的 ID;必须属于当前账户

响应

200 · OK

application/json · PublicQuery

字段类型必需说明与约束
completedAtstring否

查询执行结束时间;尚未结束时省略

coverageCompleteboolean是

登记清单和主证明取得、解析是否完整;完整零登记也为 true

createdAtstring是

查询任务创建时间

executionStatusstring是

后台执行状态;succeeded、partial、failed、cancelled 为终态

允许值:"queued" · "waiting_resource" · "processing" · "succeeded" · "partial" · "failed" · "cancelled"

failurePublicFailure否

执行结束后的公开失败或覆盖问题;正常完成、执行中及取消时省略

idstring是

查询任务 ID,用于轮询和读取登记

processedDocumentCountinteger (int64)是

已处理的主证明数量

registrationCountinteger (int64)是

取得的登记数量;明确零登记时为 0

sourceStatusstring是

查询资料来源状态;unavailable 或 quarantined 不可用于排除风险

允许值:"available" · "unavailable" · "quarantined"

statusstring是

查询业务状态;no_result 表示完整且明确的零登记结果

允许值:"queued" · "waiting_resource" · "processing" · "succeeded" · "no_result" · "partial" · "failed" · "cancelled"

subjectNamestring是

被查询的主体:规范化后的企业全称或18位大陆居民身份证号码

totalDocumentCountinteger (int64)是

需要处理的主证明总数

查看通用响应与状态码 →

登记清单

GET/queries/{id}/registrations

请求参数

参数位置类型 / 必需说明
idpathstring / 是路径所指查询、查重任务或文档的 ID;必须属于当前账户
searchquerystring / 否按证明编号、主体名称、合同编号或财产描述搜索;留空返回全部;%/_/! 按字面匹配默认值:""
parseStatusqueryarray<string> / 否主证明解析状态,多选取并集;支持重复传参或逗号分隔,忽略空项和重复值;省略、空值或单独 all 表示全部,all 不可与具体状态混用;missing 表示未取得主证明,不代表附件识别或整体覆盖状态
pagequeryinteger (int32) / 否页码,从 1 开始默认值:1最小值:1
pageSizequeryinteger (int32) / 否每页条数,范围 1–100默认值:20最大值:100最小值:1

响应

200 · OK

application/json · PublicPagePublicRegistrationSummary

字段类型必需说明与约束
itemsarray<PublicRegistrationSummary>是

当前页的登记摘要及实际附件元数据

pageinteger (int32)是

当前页码,从 1 开始

pageSizeinteger (int32)是

每页条数

totalinteger (int64)是

符合筛选条件的登记总数

查看通用响应与状态码 →

登记详情与附件

GET/queries/{id}/registrations/{registrationId}

请求参数

参数位置类型 / 必需说明
idpathstring / 是路径所指查询、查重任务或文档的 ID;必须属于当前账户
registrationIdpathstring / 是当前查询或查重任务下的登记 ID

响应

200 · OK

application/json · PublicRegistration

字段类型必需说明与约束
attachmentsarray<RegistrationAttachmentsItem>否

实际取得的附件及下载元数据

certificateCertificate | null是

主证明解析后的结构化内容;未解析成功时为 null

certificateNumberstring是

登记证明编号

coverageCompleteboolean否

该登记资料与主证明解析是否完整

idstring是

登记 ID

indexStatusIndexStatus是

查重索引准备状态;查询阶段通常为 not_requested

允许值:"not_requested" · "pending" · "indexing" · "completed" · "failed"

indexedAtstring否

查重索引完成时间

pdfPublicPdf | null是

主证明文件元数据;未取得时为 null

registrationChainRegistrationChain否

同账户同查询内,按初始登记编号关联的登记链;不推断法律效力

sourceRegistrationIdstring否

复用资料时的来源登记 ID

sourceStatusstring否

登记资料来源状态

允许值:"available" · "unavailable" · "quarantined"

upstreamSummaryUpstreamSummary是

上游返回的登记概要;不能代替解析证明

查看通用响应与状态码 →

自动查重与证据

查重任务列表

GET/checks

请求参数

参数位置类型 / 必需说明
searchquerystring / 否按企业全称、身份证号码、查重任务 ID 或查重条件搜索;留空返回全部;%/_/! 按字面匹配默认值:""
statusquerystring / 否按任务业务状态筛选;留空表示全部状态

允许值:"" · "all" · "processing" · "review_pending" · "completed" · "partial" · "failed"

pagequeryinteger (int32) / 否页码,从 1 开始默认值:1最小值:1
pageSizequeryinteger (int32) / 否每页条数,范围 1–100默认值:20最大值:100最小值:1

响应

200 · OK

application/json · PublicPagePublicCheck

字段类型必需说明与约束
itemsarray<PublicCheck>是

当前页的查重任务

pageinteger (int32)是

当前页码,从 1 开始

pageSizeinteger (int32)是

每页条数

totalinteger (int64)是

符合筛选条件的查重任务总数

查看通用响应与状态码 →

创建自动查重

POST/checks

请求参数

参数位置类型 / 必需说明
Idempotency-Keyheaderstring / 是同一业务意图的非空唯一幂等键,最长 128 字符;重试沿用原键和原请求体最长长度:128最短长度:1

请求体(必填)

application/json · PublicCreateCheck

字段类型必需说明与约束
applicantstring是

本次查重的主体:企业全称或18位大陆居民身份证号码,只接受一个主体

最长长度:100最短长度:2
criteriaarray<PublicCriterionInput>是

查重条件列表,1–100 条

最多项:100最少项:1
criteria[].kindstring父字段有值时必需

查重条件类型:invoice_no 为发票号,keyword 为关键词

允许值:"invoice_no" · "keyword"

格式规则:"invoice_no|keyword"
criteria[].valuestring父字段有值时必需

查重条件原文,最长 200 个字符

最长长度:200最短长度:1
sourceRegistryQueryIdstring否

可选;复用本人、同一主体且已结束的来源查询 ID

最长长度:100最短长度:0

响应

202 · Accepted

已受理,需继续查询状态;受理成功不表示任务已经完成。

application/json · PublicCheck

字段类型必需说明与约束
applicantstring是

本次查重的主体:规范化后的企业全称或18位大陆居民身份证号码

candidateCountinteger (int64)是

系统命中的候选登记数量

completedAtstring否

查重任务整体结束时间;尚未结束时省略

confirmedRiskCountinteger (int64)是

人工确认风险的候选登记数量

coverageCompleteboolean是

查重证据检索是否完整;为 false 时未命中不能排除风险

coverageIssuesarray<PublicCoverageIssue>是

影响查重覆盖完整性的具体问题

createdAtstring是

查重任务创建时间

criteriaarray<PublicCriterion>是

本次查重使用的条件及服务端条件 ID

criterionCountsarray<PublicCriterionCount>是

各查重条件的候选命中数

excludedCountinteger (int64)是

人工判断为误报的候选登记数量

executionStatusstring是

后台自动执行状态;succeeded 时业务状态仍可为 review_pending

允许值:"queued" · "waiting_resource" · "processing" · "succeeded" · "partial" · "failed"

failurePublicFailure否

执行结束后的公开失败或覆盖问题;正常完成、执行中及取消时省略

idstring是

查重任务 ID,用于轮询和读取结果

pendingReviewCountinteger (int64)是

尚待人工复核的候选登记数量

processingCompletedAtstring否

自动查重处理完成时间

sourceRegistryQueryIdstring是

本次查重使用的来源查询 ID

sourceStatusstring是

查重来源资料状态;不可用或隔离时不能据未命中排除风险

允许值:"available" · "unavailable" · "quarantined"

statusstring是

查重业务状态;review_pending 表示自动执行完成但仍有待复核候选

允许值:"processing" · "review_pending" · "completed" · "partial" · "failed"

unmatchedCriterionIdsarray<string>是

未命中的查重条件 ID;覆盖不完整时不能据此排除风险

查看通用响应与状态码 →

查重执行状态与完整性

GET/checks/{id}

请求参数

参数位置类型 / 必需说明
idpathstring / 是路径所指查询、查重任务或文档的 ID;必须属于当前账户

响应

200 · OK

application/json · PublicCheck

字段类型必需说明与约束
applicantstring是

本次查重的主体:规范化后的企业全称或18位大陆居民身份证号码

candidateCountinteger (int64)是

系统命中的候选登记数量

completedAtstring否

查重任务整体结束时间;尚未结束时省略

confirmedRiskCountinteger (int64)是

人工确认风险的候选登记数量

coverageCompleteboolean是

查重证据检索是否完整;为 false 时未命中不能排除风险

coverageIssuesarray<PublicCoverageIssue>是

影响查重覆盖完整性的具体问题

createdAtstring是

查重任务创建时间

criteriaarray<PublicCriterion>是

本次查重使用的条件及服务端条件 ID

criterionCountsarray<PublicCriterionCount>是

各查重条件的候选命中数

excludedCountinteger (int64)是

人工判断为误报的候选登记数量

executionStatusstring是

后台自动执行状态;succeeded 时业务状态仍可为 review_pending

允许值:"queued" · "waiting_resource" · "processing" · "succeeded" · "partial" · "failed"

failurePublicFailure否

执行结束后的公开失败或覆盖问题;正常完成、执行中及取消时省略

idstring是

查重任务 ID,用于轮询和读取结果

pendingReviewCountinteger (int64)是

尚待人工复核的候选登记数量

processingCompletedAtstring否

自动查重处理完成时间

sourceRegistryQueryIdstring是

本次查重使用的来源查询 ID

sourceStatusstring是

查重来源资料状态;不可用或隔离时不能据未命中排除风险

允许值:"available" · "unavailable" · "quarantined"

statusstring是

查重业务状态;review_pending 表示自动执行完成但仍有待复核候选

允许值:"processing" · "review_pending" · "completed" · "partial" · "failed"

unmatchedCriterionIdsarray<string>是

未命中的查重条件 ID;覆盖不完整时不能据此排除风险

查看通用响应与状态码 →

登记查重结果

GET/checks/{id}/results

请求参数

参数位置类型 / 必需说明
idpathstring / 是路径所指查询、查重任务或文档的 ID;必须属于当前账户
searchquerystring / 否按证明编号、主体名称或命中条件内容搜索;留空返回全部;%/_/! 按字面匹配
resultStatusquerystring / 否结果状态:all、pending、confirmed、excluded 或 unmatched

允许值:"all" · "pending" · "confirmed" · "excluded" · "unmatched"

默认值:"all"
matchStatusquerystring / 否匹配状态:all、matched、unmatched 或 pending

允许值:"all" · "matched" · "unmatched" · "pending"

默认值:"all"
criterionIdquerystring / 否仅返回命中该查重条件 ID 的登记;留空不限制条件
strengthquerystring / 否命中强度:all、invoice_match 或 keyword_only

允许值:"all" · "invoice_match" · "keyword_only"

默认值:"all"
reviewableOnlyqueryboolean / 否为 true 时仅返回来源可用且尚未人工判断的候选登记默认值:false
sortquerystring / 否结果排序:resultStatus 按结果状态,reviewPriority 将待复核结果优先

允许值:"resultStatus" · "reviewPriority"

默认值:"resultStatus"
pagequeryinteger (int32) / 否页码,从 1 开始默认值:1最小值:1
pageSizequeryinteger (int32) / 否每页条数,范围 1–100默认值:20最大值:100最小值:1

响应

200 · OK

application/json · PublicCheckResultPage

字段类型必需说明与约束
countsCheckResultCounts是

全任务四类互斥结果的数量,不随列表筛选变化

itemsarray<PublicCheckResultSummary>是

当前页的登记查重摘要

pageinteger (int64)是

当前页码,从 1 开始

pageSizeinteger (int64)是

每页条数

reviewableCountinteger (int64)是

全任务中来源可用且尚未人工判断的候选数量

totalinteger (int64)是

当前筛选条件下的登记总数

查看通用响应与状态码 →

登记查重详情

GET/checks/{id}/results/{registrationId}

请求参数

参数位置类型 / 必需说明
idpathstring / 是路径所指查询、查重任务或文档的 ID;必须属于当前账户
registrationIdpathstring / 是当前查询或查重任务下的登记 ID

响应

200 · OK

application/json · PublicCheckResult

字段类型必需说明与约束
checkPublicCheckEvidence | null是

该登记的查重匹配与证据;无命中时为 null

coverageIssuesarray<PublicCoverageIssue>是

影响该登记判断的资料覆盖问题

coverageReasonstring否

资料不足以作完整判断时的原因

matchStatusCheckMatchStatus是

系统匹配状态;pending 表示资料尚不足以完成匹配

允许值:"matched" · "unmatched" · "pending"

pendingReasonstring否

当前结果仍待处理或复核的原因

registrationPublicRegistration是

完整登记详情及文件元数据

resultStatusCheckResultStatus是

综合系统匹配和人工结论后的结果状态

允许值:"pending" · "confirmed" · "excluded" · "unmatched"

查看通用响应与状态码 →

读取证据页码信息

GET/checks/{id}/results/{registrationId}/evidence-locations

请求参数

参数位置类型 / 必需说明
idpathstring / 是路径所指查询、查重任务或文档的 ID;必须属于当前账户
registrationIdpathstring / 是当前查询或查重任务下的登记 ID
documentIdquerystring / 是证据所属文档 ID,须属于当前登记
pageNumberqueryinteger (int32) / 是文档页码,从 1 开始,最多 2000;已知总页数时不得超出实际范围最大值:2000最小值:1

响应

200 · OK

application/json · EvidenceLocations

字段类型必需说明与约束
coordinateSystemEvidenceLocationsCoordinateSystem是

坐标系:以页面左上角为原点的归一化坐标

允许值:"normalized_top_left"

documentIdstring是

当前定位的证据文档 ID

fileNamestring是

证据文档文件名

heightnumber | null (double)是

页面高度;未知时为 null

locationsarray<EvidenceLocation>是

当前页的证据标识与页级位置

mimeTypestring是

证据文档的媒体类型

pageCountinteger (int64)是

证据文档总页数

pageNumberinteger (int64)是

当前定位页码,从 1 开始

rotationinteger (int64)是

页面旋转角度

sha256string是

证据文档文件的 SHA-256 校验值

urlstring是

需要携带 API Key 的证据文档下载路径

widthnumber | null (double)是

页面宽度;未知时为 null

查看通用响应与状态码 →

读取筛选范围内的前后登记

GET/checks/{id}/results/{registrationId}/navigation

与结果列表使用相同的搜索、结果状态、匹配状态、命中条件、可复核范围和排序。total 为筛选后的登记总数,position 从 1 开始,previousRegistrationId 与 nextRegistrationId 指向该范围的相邻登记。 页码不缩小导航范围;本人任务中的登记若被筛选排除,位置和相邻编号均为 null。登记不属于该任务或当前账户时返回 404,此接口不修改复核结论。

请求参数

参数位置类型 / 必需说明
idpathstring / 是路径所指查询、查重任务或文档的 ID;必须属于当前账户
registrationIdpathstring / 是当前查询或查重任务下的登记 ID
searchquerystring / 否按证明编号、主体名称或命中条件内容搜索,定位同一筛选范围内的相邻登记;%/_/! 按字面匹配
resultStatusquerystring / 否结果状态:all、pending、confirmed、excluded 或 unmatched

允许值:"all" · "pending" · "confirmed" · "excluded" · "unmatched"

默认值:"all"
matchStatusquerystring / 否匹配状态:all、matched、unmatched 或 pending

允许值:"all" · "matched" · "unmatched" · "pending"

默认值:"all"
criterionIdquerystring / 否仅返回命中该查重条件 ID 的登记;留空不限制条件
strengthquerystring / 否命中强度:all、invoice_match 或 keyword_only

允许值:"all" · "invoice_match" · "keyword_only"

默认值:"all"
reviewableOnlyqueryboolean / 否为 true 时仅返回来源可用且尚未人工判断的候选登记默认值:false
sortquerystring / 否结果排序:resultStatus 按结果状态,reviewPriority 将待复核结果优先

允许值:"resultStatus" · "reviewPriority"

默认值:"resultStatus"

响应

200 · OK

application/json · CheckResultNavigation

字段类型必需说明与约束
nextRegistrationIdstring | null是

当前筛选排序下的下一登记 ID;不存在或当前项被筛除时为 null

positioninteger | null (int64)是

当前登记在筛选结果中的位置,从 1 开始;被筛除时为 null

previousRegistrationIdstring | null是

当前筛选排序下的上一登记 ID;不存在或当前项被筛除时为 null

totalinteger (int64)是

当前筛选条件下的登记总数;不受页码限制

查看通用响应与状态码 →

文件下载

下载证明或附件

GET/documents/{id}/content

请求参数

参数位置类型 / 必需说明
idpathstring / 是路径所指查询、查重任务或文档的 ID;必须属于当前账户
Rangeheaderstring / 否单段字节范围,例如 bytes=0-1023;省略时下载完整文件

响应

200 · Authorized document

application/octet-stream · string (binary)

响应体为文件二进制内容。

application/pdf · string (binary)

响应体为文件二进制内容。

image/jpeg · string (binary)

响应体为文件二进制内容。

image/png · string (binary)

响应体为文件二进制内容。

响应头

Accept-Ranges · string

支持单段字节范围,值为 bytes

Cache-Control · string

私有文件禁止缓存,值为 private, no-store

Content-Disposition · string

inline 文件名,包含 UTF-8 编码的原件名称

Content-Length · integer (int64)

本次响应体的字节数;部分下载时为所请求区间长度

206 · Requested byte range

application/octet-stream · string (binary)

响应体为文件二进制内容。

application/pdf · string (binary)

响应体为文件二进制内容。

image/jpeg · string (binary)

响应体为文件二进制内容。

image/png · string (binary)

响应体为文件二进制内容。

响应头

Accept-Ranges · string

支持单段字节范围,值为 bytes

Cache-Control · string

私有文件禁止缓存,值为 private, no-store

Content-Disposition · string

inline 文件名,包含 UTF-8 编码的原件名称

Content-Length · integer (int64)

本次响应体的字节数;部分下载时为所请求区间长度

Content-Range · string

本次返回的字节范围及文件总大小

接口专属异常

416 · Unsatisfiable range

无响应体

响应头

Content-Range · string

可用的文件总大小,格式为 bytes */总字节数

查看通用响应与状态码 →

数据结构

这里列出接口处尚未展开的嵌套类型;“必需”表示契约要求包含该字段。

CandidateStrength

string

允许值:"invoice_match" · "keyword_only"

CandidateSystemDecisionDecision

string

允许值:"matched"

CandidateSystemDecisionReason

string

允许值:"invoice_exact_match"

Certificate

字段类型必需说明与约束
businessTypeCodestring | null否

官方业务大类代码

businessTypeDescriptionstring | null否

官方业务类型文字说明

certificateNumberstring | null否

登记证明编号

declaredAttachmentsarray | null否

证明原文声明的附件;不等同于已取得的实际附件

expiresAtstring | null否

登记期限届满日期

initialCertificateNumberstring | null否

关联初始登记的证明编号

issuesarray | null否

证明解析时发现的字段问题

leaseBusinessTypestring | null否

融资租赁业务类型

mainContractAmountstring | null否

主合同金额的十进制字符串

mainContractCurrencystring | null否

主合同金额币种

mainContractNumberstring | null否

主合同编号

maximumClaimAmountstring | null否

最高债权额的十进制字符串

maximumClaimCurrencystring | null否

最高债权额币种

originalRegistrationOriginalRegistration | null否

证明中记载的原登记信息

partiesarray | null否

证明中记载的当事人及角色

performanceEndDatestring | null否

债务履行期限结束日期

performancePeriodTextstring | null否

证明原文中的债务履行期限说明

performanceStartDatestring | null否

债务履行期限开始日期

preparerCertificatePreparer | null否

证明填表人信息

propertyDescriptionstring | null否

完整财产描述原文

propertyDescriptionPageinteger | null (int64)否

财产描述在证明中的起始页码

propertyDescriptionSpansarray | null否

财产描述在各页原文中的字符位置

propertyUniqueCodestring | null否

财产唯一识别码

propertyValuestring | null否

财产价值的十进制字符串

propertyValueCurrencystring | null否

财产价值币种

registerTimestring | null否

登记时间,含时区

registerTypestring | null否

登记类型,例如初始、变更或注销登记

registrationDetailsRegistrationDetails | null否

变更、展期、异议或注销等登记专属内容

registrationMonthsinteger | null (int32)否

登记期限,单位为月

securedScopestring | null否

被担保债权范围

securityContractNumberstring | null否

担保合同编号

securityTypestring | null否

担保类型

subBusinessTypeCodestring | null否

官方业务小类代码

CertificateParty

字段类型必需说明与约束
detailsPartyDetails | null否

当事人补充身份与登记信息

financialInstitutionCodestring | null否

金融机构编码

institutionCertificateNumberstring | null否

机构证件号码

namestring | null否

当事人名称或姓名

personalIdentityNumberstring | null否

个人身份证件号码

roleCertificatePartyRole | null否

当事人在本登记中的角色:债务人或担保权人

允许值:"debtor" · "secured_party"

typeCodestring | null否

主体类型一级代码

typeLevel2Codestring | null否

主体类型二级代码

typeLevel3Codestring | null否

主体类型三级代码

unifiedSocialCreditCodestring | null否

统一社会信用代码

CertificatePartyRole

string

允许值:"debtor" · "secured_party"

CertificatePreparer

字段类型必需说明与约束
addressstring | null否

填表人地址

archiveNumberstring | null否

填表人档案编号

authorizedPersonstring | null否

填表人授权经办人

certificateNumberstring | null否

填表人证件号码

certificateTypestring | null否

填表人证件类型

namestring | null否

填表人名称

CheckMatchStatus

string

允许值:"matched" · "unmatched" · "pending"

CheckResultCounts

字段类型必需说明与约束
allinteger (int64)是

任务中全部登记的数量

confirmedinteger (int64)是

人工确认风险的登记数量

excludedinteger (int64)是

人工排除为误报的登记数量

pendinginteger (int64)是

待人工复核或资料尚不足以判定的登记数量

unmatchedinteger (int64)是

未命中的登记数量;仍须结合资料完整性判断

CheckResultStatus

string

允许值:"pending" · "confirmed" · "excluded" · "unmatched"

DeclaredAttachment

字段类型必需说明与约束
fileNamestring | null否

证明原文声明的附件文件名

purposestring | null否

声明的附件用途:财产、异议或财产要素

ErrorDetails

字段类型必需说明与约束
fieldsarray<FieldError>是

输入错误字段列表,不包含被拒绝的客户值

EvidenceLocation

字段类型必需说明与约束
evidenceIdstring是

对应的证据 ID

precisionEvidenceLocationPrecision是

当前统一返回 page,表示页级位置

允许值:"word" · "region" · "page" · "unavailable"

quadsarray<array<number (double)>>是

保留响应结构;当前始终为空数组,不提供 PDF 字词坐标

reasonstring | null是

TEXT_ONLY_MODE 表示文本复核模式;PAGE_NOT_PARSED 表示该页尚未解析

EvidenceLocationPrecision

string

允许值:"word" · "region" · "page" · "unavailable"

EvidenceLocationsCoordinateSystem

string

允许值:"normalized_top_left"

FieldError

字段类型必需说明与约束
codestring是

字段原因码,如 REQUIRED、OUT_OF_RANGE、INVALID_CHOICE、INVALID_VALUE、INVALID_TYPE、INVALID_FORMAT

messagestring是

安全的字段错误说明,不回显原始输入

pathstring是

字段路径、数组下标或请求头名;$ 表示正文整体格式错误

HighlightRange

字段类型必需说明与约束
endinteger (int64)是

高亮结束字符偏移量,不包含该位置

startinteger (int64)是

高亮起始字符偏移量,从 0 开始

IndexStatus

string

允许值:"not_requested" · "pending" · "indexing" · "completed" · "failed"

OriginalRegistration

字段类型必需说明与约束
datestring | null否

原登记日期

departmentstring | null否

原登记机构

descriptionstring | null否

原登记的文字说明

numberstring | null否

原登记编号

registeredboolean | null否

证明是否记载原登记

ParseIssue

字段类型必需说明与约束
codestring | null否

解析问题代码

fieldstring | null否

出现问题的证明字段

pageNumberinteger | null (int64)否

问题所在的证明页码

rawValuestring | null否

触发问题的原文字段值

ParseStatus

string

允许值:"pending" · "parsing" · "completed" · "failed"

PartyDetails

字段类型必需说明与约束
addressstring | null否

当事人地址

businessRegistrationNumberstring | null否

工商登记号码

certificateTypestring | null否

证件类型

citystring | null否

所在城市

corporationScalestring | null否

企业规模类别

industryCodestring | null否

行业代码

legalRepresentativestring | null否

法定代表人

leistring | null否

全球法人识别编码(LEI)

nationalitystring | null否

国籍或注册地国家

organizationCodestring | null否

组织机构代码

organizationRegistrationCertificateNumberstring | null否

组织登记证书编号

passportExpiryDatestring | null否

护照有效期截止日期

passportIssuingCountrystring | null否

护照签发国家

provincestring | null否

所在省份

tradeNamestring | null否

商业名称

typeDescriptionstring | null否

主体类型文字说明

unclassifiedIdentifiersarray | null否

证明原文中的主体编号;来源标签包含多个可能类型,未擅自归类,请核对原件

PdfMimeType

string

允许值:"application/pdf"

PropertySpan

字段类型必需说明与约束
endinteger | null (int64)否

本页财产描述的结束字符偏移量,不包含该位置

pageNumberinteger | null (int64)否

财产描述所在页码

startinteger | null (int64)否

本页财产描述的起始字符偏移量

PublicAllowance

字段类型必需说明与约束
availableinteger (int64)是

当前可用于新任务的次数;权益失效时为 0

reservedinteger (int64)是

当前有效额度桶中已预留、尚未结算的次数

retainedinteger (int64)是

当前有效额度桶保留的剩余次数;不等于当前可用权益

totalinteger (int64)是

当前已生效且未过期额度桶的总次数,包含套餐、加量包及赠送

usedinteger (int64)是

当前有效额度桶中已结算的次数

PublicCheckEvidence

字段类型必需说明与约束
evidencearray<PublicEvidence>是

该登记的命中证据,包含文档、页码和文本片段

manualReviewPublicManualReview否

已有的最新人工复核结论;未复核时省略

matchedCriterionIdsarray<string>是

命中的查重条件 ID

strengthCandidateStrength是

命中强度:发票号精确命中或仅关键词命中

允许值:"invoice_match" · "keyword_only"

systemDecisionCandidateSystemDecision否

系统自动判断;与人工复核结论分别保存

versioninteger (int64)是

候选结果版本号

PublicCheckResultSummary

字段类型必需说明与约束
coverageReasonstring否

资料覆盖不足时的原因说明

matchStatusCheckMatchStatus是

系统匹配状态

允许值:"matched" · "unmatched" · "pending"

matchedCriterionIdsarray<string>是

该登记命中的查重条件 ID

pendingReasonstring否

该登记仍待处理或复核的原因

registrationRegistrationSummary是

登记摘要;完整证明与附件需读取详情

resultStatusCheckResultStatus是

该登记的综合结果状态

允许值:"pending" · "confirmed" · "excluded" · "unmatched"

reviewNotestring否

已有人工复核结论的备注

strengthCandidateStrength否

该登记的命中强度

允许值:"invoice_match" · "keyword_only"

PublicCoverageIssue

字段类型必需说明与约束
codestring是

资料覆盖问题代码

criterionIdstring否

受影响的查重条件 ID;若问题针对特定条件才提供

registrationIdstring否

受影响的登记 ID;若问题针对特定登记才提供

PublicCriterion

字段类型必需说明与约束
idstring是

服务端生成的查重条件 ID,用于关联证据和筛选结果

kindstring是

查重条件类型:发票号或关键词

允许值:"invoice_no" · "keyword"

valuestring是

查重条件原文

PublicCriterionCount

字段类型必需说明与约束
countinteger (int64)是

该条件命中的候选登记数量

criterionIdstring是

对应的查重条件 ID

PublicEvidence

字段类型必需说明与约束
certificateNumberstring是

证据所属登记的证明编号

criterionIdstring是

产生本条命中的查重条件 ID

documentIdstring否

证据所在文档 ID,可用于下载与页内定位

documentVersionIdstring否

命中时所用的文档版本 ID

endinteger (int64)是

证据在来源页文本中的 UTF-16 结束偏移量,不包含该位置

fileNamestring是

证据所在文件名

highlightRangesarray<HighlightRange>是

命中片段中的高亮字符范围

idstring是

证据 ID,用于匹配页内坐标

indexVersionstring是

产生本条命中的检索索引版本

matchedAtstring是

系统生成本条匹配证据的时间,带时区;不是文档索引完成时间

mimeTypestring否

证据文件的媒体类型

pageNumberinteger (int64)否

证据所在页码,从 1 开始

pageRangesarray<HighlightRange>否

证据在整页文本中的字符范围

ruleVersionstring否

产生本条命中的查重规则版本

snippetstring是

包含命中文字的证据片段

sourceFieldSearchSourceField是

命中来源:财产描述或附件内容

允许值:"property_description" · "attachment_content"

startinteger (int64)是

证据在来源页文本中的 UTF-16 起始偏移量,从 0 开始

termKindSearchTermKind是

命中条件的类型:发票号或关键词

允许值:"invoice_no" · "keyword"

termValuestring是

命中的查重条件原文

urlstring否

证据文档的需认证下载路径

PublicFailure

字段类型必需说明与约束
codestring是

公开失败或覆盖问题原因码;仅描述已结束任务,不包含内部异常

允许值:"SOURCE_QUARANTINED" · "SOURCE_UNAVAILABLE" · "QUERY_FAILED" · "CHECK_FAILED" · "DOCUMENT_COVERAGE_INCOMPLETE" · "CHECK_COVERAGE_INCOMPLETE"

messagestring是

原因的公开说明,不包含上游诊断或客户原文

PublicManualReview

字段类型必需说明与约束
decisionReviewDecision是

人工复核结论:确认风险或误报

允许值:"confirmed" · "false_positive"

notestring是

人工复核备注

reviewedAtstring是

人工复核时间

PublicPdf

字段类型必需说明与约束
certificateNumberstring否

该主证明对应的登记证明编号

documentIdstring否

主证明文档 ID,用于下载和证据定位

fileNamestring否

主证明文件名

mimeTypePdfMimeType否

主证明的媒体类型

允许值:"application/pdf"

pageCountinteger (int64)否

主证明页数

parseStatusParseStatus否

主证明解析状态

允许值:"pending" · "parsing" · "completed" · "failed"

parsedAtstring否

主证明完成解析的时间

sha256string否

主证明文件的 SHA-256 校验值

sizeinteger (int64)否

主证明文件大小,单位字节

urlstring否

需要携带 API Key 才能访问的主证明下载路径

PublicPlan

字段类型必需说明与约束
checkAllowanceinteger (int64)是

套餐每周期提供的查重次数

idstring是

套餐 ID

namestring是

套餐展示名称

queryAllowanceinteger (int64)是

套餐每周期提供的查询次数

PublicRegistrationSummary

字段类型必需说明与约束
attachmentsarray<RegistrationAttachmentsItem>是

实际取得的附件及下载元数据;无附件时为空数组,下载须携带 API Key

businessTypeCodestring否

已解析证明中的官方业务大类代码

certificateNumberstring是

登记证明编号

coverageCompleteboolean是

该登记的资料取得与主证明解析是否完整

dataSourcestring是

摘要来源:已解析证明或上游登记概要;不代表解析成功

允许值:"certificate" · "upstream"

debtorNamesstring否

已解析证明中的债务人名称汇总

expiresAtstring否

登记期限届满日期

idstring是

登记 ID,用于读取详情

parseStatusstring是

主证明解析状态;missing 表示未取得证明

允许值:"completed" · "pending" · "failed" · "missing"

pdfUrlstring否

当前账户可访问的主证明下载路径;来源不可用时省略

propertySummarystring否

财产描述前 200 个 Unicode 字符;完整内容见详情

最长长度:200
registerTimestring否

登记时间

registerTypestring否

登记类型

registrationMonthsinteger (int32)否

登记期限,单位为月

securedPartyNamesstring否

已解析证明中的担保权人名称汇总

sourceStatusstring是

登记资料来源状态;不可用或隔离时不要据此排除风险

允许值:"available" · "unavailable" · "quarantined"

subBusinessTypeCodestring否

已解析证明中的官方业务小类代码

upstreamSummaryUpstreamSummary否

上游返回的独立登记概要,保留原始可用字段

PublicSubscription

字段类型必需说明与约束
cyclestring是

订阅周期:monthly 为月付,annual 为年付

允许值:"monthly" · "annual"

endsAtstring是

当前订阅有效期结束时间

periodEndsAtstring是

套餐本次额度周期结束时间;加量包及赠送额度有各自有效期

planPublicPlan是

当前订阅的套餐

startsAtstring是

当前订阅有效期开始时间

RegistrationAttachmentsItem

字段类型必需说明与约束
fileNamestring是

实际附件的文件名

idstring是

附件文档 ID,用于下载

mimeTypestring否

附件媒体类型

pageCountinteger (int64)否

附件页数;非分页文件可能省略

sha256string否

附件文件的 SHA-256 校验值

statusstring否

附件获取或处理状态

urlstring是

需要携带 API Key 才能访问的附件下载路径

RegistrationChain

字段类型必需说明与约束
initialCertificateNumberstring否

登记链采用的初始登记证明编号

itemsarray<RegistrationChainItem>否

关联的登记证明,按登记顺序列出

truncatedboolean否

关联登记是否因列表限制而截断

RegistrationChainItem

字段类型必需说明与约束
certificateNumberstring否

关联登记的证明编号

expiresAtstring否

关联登记的期限届满日期

parseStatusstring否

关联登记的主证明解析状态

registerTimestring否

关联登记时间

registerTypestring否

关联登记类型

registrationIdstring否

关联登记 ID,可读取详情

RegistrationDetails

字段类型必需说明与约束
cancellationReasonstring | null否

注销登记原因

changeDescriptionstring | null否

变更登记内容说明

extensionMonthsinteger | null (int32)否

展期月数

objectionStatementstring | null否

异议登记声明;不作为财产描述

remarksstring | null否

其他登记备注

RegistrationSummary

字段类型必需说明与约束
businessTypeCodestring否

已解析证明中的官方业务大类代码

certificateNumberstring是

登记证明编号

coverageCompleteboolean是

该登记的资料取得与主证明解析是否完整

dataSourcestring是

摘要来源:已解析证明或上游登记概要;不代表解析成功

允许值:"certificate" · "upstream"

debtorNamesstring否

已解析证明中的债务人名称汇总

expiresAtstring否

登记期限届满日期

idstring是

登记 ID,用于读取详情

parseStatusstring是

主证明解析状态;missing 表示未取得证明

允许值:"completed" · "pending" · "failed" · "missing"

pdfUrlstring否

当前账户可访问的主证明下载路径;来源不可用时省略

propertySummarystring否

财产描述前 200 个 Unicode 字符;完整内容见详情

最长长度:200
registerTimestring否

登记时间

registerTypestring否

登记类型

registrationMonthsinteger (int32)否

登记期限,单位为月

securedPartyNamesstring否

已解析证明中的担保权人名称汇总

sourceStatusstring是

登记资料来源状态;不可用或隔离时不要据此排除风险

允许值:"available" · "unavailable" · "quarantined"

subBusinessTypeCodestring否

已解析证明中的官方业务小类代码

upstreamSummaryUpstreamSummary否

上游返回的独立登记概要,保留原始可用字段

ReviewDecision

string

允许值:"confirmed" · "false_positive"

SearchSourceField

string

允许值:"property_description" · "attachment_content"

SearchTermKind

string

允许值:"invoice_no" · "keyword"

UnclassifiedIdentifier

字段类型必需说明与约束
pageNumberinteger (int64)是

编号所在的证明页码

rawValuestring是

证明原文中的编号值,未判定为任何一种已分类编号

sourceLabelstring是

证明原文中的编号字段标签,包含可能的编号类型

UpstreamSummary

字段类型必需说明与约束
businessTypestring | null否

上游登记概要中的业务类型文字

certificateNumberstring | null否

上游登记概要中的证明编号

expiresAtstring | null否

上游登记概要中的到期日期

registerTimestring | null否

上游登记概要中的登记时间

registerTypestring | null否

上游登记概要中的登记类型

securedPartyNamestring | null否

上游登记概要中的担保权人名称

通用响应与状态码

以下为统一的错误处理约定,不表示每个接口都会触发所有错误。 成功响应及接口专属异常见各接口;重试和业务错误处理见接入规则。

错误结构(Error)

字段类型必需说明与约束
codestring是

稳定的机器错误码,供调用方判断处理方式

detailsErrorDetails否

可选的错误细节;不包含客户原文或密钥

messagestring是

可展示的错误说明

requestIdstring否

服务端请求编号,可用于问题排查

通用响应头

以下响应头适用于所有接口的响应。

X-Request-Id · string

服务端生成的请求编号

通用错误状态码

HTTP说明响应类型附加响应头
400业务或请求错误

application/json · Error

401业务或请求错误

application/json · Error

402业务或请求错误

application/json · Error

403业务或请求错误

application/json · Error

404业务或请求错误

application/json · Error

409业务或请求错误

application/json · Error

413业务或请求错误

application/json · Error

415业务或请求错误

application/json · Error

429业务或请求错误

application/json · Error

Retry-After · integer

重试前等待秒数

500业务或请求错误

application/json · Error

503业务或请求错误

application/json · Error