- 智利先行,国家无关设计:目前主体为智利(
country: "CL",RUT 作为doc_id);新国家无需更改契约即可接入。 - 实时新鲜度:每份报告在购买时查询数据源,并按来源声明数据是
live、cached还是unavailable。绝不静默使用陈旧数据。 - 内置合规:声明的
purpose为必填(智利数据保护法),每个评分都带有原因码,每份报告都包含公开验证码。
Qscore 是付费产品,由您账户的
risk 服务标志门控,按报告计费(独立费用 risk_report_person / risk_report_company)。如果收费后生成失败,费用将自动退还,报告以 failed 结束并带有 error_code。例外:您自己的报告(自助)是免费的——见下文”您自己的报告(自助)“。工作原理
生成是同步的:POST 获取征信记录、计算评分、渲染 PDF,并在单个响应中返回就绪的报告。某个来源宕机不会导致付费报告失败——报告将使用持久化数据生成,该来源在 sources 部分声明为 cached(如果完全没有贡献则声明为 unavailable)。
您自己的报告(自助)
如果您持有已验证账户(KYC/KYB 已批准),您可以直接生成并下载您自己的 Qscore 报告。这是您访问个人数据的权利(ARCO / 智利第 21.719 号法律),而不是购买:- 免费:永不收取费用。
- 不影响评分:自助报告不计入您评分的查询次数——查看自己的报告绝不会损害评分。
- 设计上防预言机:主体身份来自您 KYC/KYB 中已验证的
tax_id。请求不接受doc_id——通过这些端点请求他人报告是不可能的。 - 频率限制:每 30 天一份新报告。如果您在窗口期内已有
ready报告,POST将返回该报告并带idempotency_hit: true(HTTP 200),而不会生成新报告。
生成(或复用)您的报告
POST /v1/qscore/my-report — 请求体可选:{"lang": "en"|"es"|"zh"}(默认 en)。生成是同步的:响应携带已完成的报告。无需 idempotency_key——幂等性按账户、主体和日期确定(同一天重复提交将返回已创建的报告)。
生成您自己的报告
201 Created(已生成新报告)
200 OK,携带同一报告并带 "idempotency_hit": true。如果生成失败,响应为 201,status: "failed" 并带 error_code / error_message(未收取任何费用——自助报告是免费的)。
读取您的最新报告
GET /v1/qscore/my-report 返回您最近的自助报告(任何状态),不生成新报告——如果您从未生成过,则返回 404 not_found。
下载 PDF
GET /v1/qscore/my-report/pdf 下载您最新自助报告的 PDF(Content-Disposition: attachment; filename="qscore_self_<id>.pdf")。如果报告尚未 ready,则返回 404 pdf_not_ready。
PDF 带有与任何 Qscore 报告相同的公开验证码——任何持有它的人都可以在 GET /verify/qscore/{code} 验证其真实性(见下文”公开验证”)。
自助报告错误
商业端点
POST /v1/qscore/reports 会以 400 invalid_purpose 拒绝 purpose: "self_access"——自助访问只能通过 /v1/qscore/my-report。自助报告的 risk_report_ready webhook 在 data 中带有额外的 "purpose": "self_access" 字段(商业报告省略该字段)。1. 购买报告
POST /v1/qscore/reports 创建并生成完整报告。idempotency_key 为必填(报告会收取费用:使用相同密钥重试将返回原始报告并带 idempotency_hit: true,绝不会重复收费)。
- 个人
- 企业
创建个人报告
201 Created(报告就绪)
error_code: "generation_failed"。使用相同的 idempotency_key 重新运行将返回原始报告(或其失败状态)——绝不会重复收费。
2. 评分(模型 v1)
评分运行qscore-v1:基础分 600,范围 1–999,根据不利事实(未结逾期、拒付票据、破产、近期查询)和正面信号(活跃信贷账户、信用历史深度、公司活跃度、替代数据)进行调整。
每份报告都带有
reason_codes——评分的可解释层:
行业同业基准(仅企业报告)
企业报告可能包含peer_benchmark 块:评分在其细分行业中的相对位置——相同国家、相同行业(ISIC 分类,取自税务登记)。
基准规则:
- 仅企业报告 — 个人报告永不包含该块(直接省略)。
- 行业取自税务登记,并记录在主体上(以最新值为准)。
- 可比群体为同国家同行业每家企业的最新评分,不含被评估主体。
- 可比企业少于 5 家时不发布 — 该块将从报告中省略(绝不虚构统计背景)。
percentile读作”优于 N% 的同业”;median_score为该细分行业的评分中位数。
3. 查询与历史
列出报告
GET /v1/qscore/reports 列出您账户购买的报告。from 和 to(日期 YYYY-MM-DD,组织时区,两端均包含)为必填;subject_id 和 status(pending、ready、failed)为可选筛选;使用 page / page_size 分页(默认 50,最大 200)。
列出报告
200 OK
报告详情
GET /v1/qscore/reports/{report_id} 返回报告;当状态为 ready 时,包含完整的 report 对象(与创建响应相同的结构)。
下载 PDF
GET /v1/qscore/reports/{report_id}/pdf 下载品牌化 PDF(application/pdf,文件名 qscore_<report_id>.pdf)。在报告 ready 之前,响应为 404 pdf_not_ready。PDF 是私密文档:下载需要身份验证——绝不会附加到电子邮件或暴露在公开 URL 上。
主体档案与当前评分(无需购买新报告)
GET /v1/qscore/subjects/{doc_id}?country=CL 返回您已购买过报告的证件的主体档案(身份 + 最新评分):
200 OK(主体档案)
GET /v1/qscore/subjects/{doc_id}/score?country=CL 仅返回当前评分(如果主体尚未有评分,则为 404 no_score):
200 OK(当前评分)
4. 报告状态
5. 错误
完整目录请参阅错误。
6. Webhooks
在您的 webhook 设置中订阅 Qscore 事件。三者都是账户受众事件,与所有其他 webhook 一样签名。risk_report_ready — 报告已生成完毕
risk_report_ready — 报告已生成完毕
risk_report_ready
"purpose": "self_access" 字段;商业报告省略该字段。risk_score_changed — 主体的评分发生变化
risk_score_changed — 主体的评分发生变化
当新报告计算出的评分与主体之前的评分不同时触发。
risk_score_changed
risk_monitoring_alert — 被监控主体发生变化
risk_monitoring_alert — 被监控主体发生变化
每当主体的评分跌破您的
monitor_since_score 下限、征信出现新记录或记录被移除时,都会为每条启用的监控订阅触发。订阅后的首次评估仅建立基线,绝不告警。risk_monitoring_alert
7. 公开验证
每份报告 PDF 都会打印验证码和 URL。持有验证码的任何人都可以在GET /verify/qscore/{code} 检查报告的真实性——不包含 PII(无需身份验证):
200 OK(有效报告)
404 和 {"valid": false, ...}。该端点按 IP 限流,除了有效性、等级和日期外不透露任何信息。
8. ARCO 异议
数据主体可以行使其 ARCO 权利(访问、更正、删除、反对)。您的账户可以针对主体的特定记录提出异议:提出异议
201 Created
open → under_review → resolved_corrected | resolved_rejected(最终)。使用 GET /v1/qscore/subjects/{doc_id}/disputes?country=CL&status=open 列出(分页),使用 GET /v1/qscore/disputes/{dispute_id} 读取单个。异议由您的组织管理员在管理面板中处理。
9. 监控
当您已持有某主体的ready 报告后,可订阅持续监控,在发生相关变化时收到 risk_monitoring_alert webhook:评分跌破您的阈值、征信出现新记录或记录被移除。监控免费 —— 唯一要求是已购买该主体的报告(与评分端点同一策略:未付费了解某主体之前,任何人都不能监控它)。
订阅(或更新阈值)
200 OK
monitor_since_score(可选,1–999):当评分跌破此阈值时告警(触发器score_drop_below)。only_material(默认false):为true时仅重大变更触发告警。- Worker 每 约 5 分钟重新评估所有被监控主体。首次评估仅建立基线 —— 绝不会针对您在已购报告中已见过的数据告警。
GET /v1/qscore/subjects/{doc_id}/monitoring 读取单个订阅,使用 GET /v1/qscore/monitoring?active=true&page=1&page_size=50 列出账户下所有被监控主体(分页:items、page、page_size、total),并使用 DELETE 停用:
停用监控
200 OK
DELETE 为停用(active: false)—— 订阅历史永不删除,再次 PUT 即以新阈值重新激活。
告警负载(risk_monitoring_alert)包含触发器(score_drop_below、new_records、records_removed)、当前与先前评分、等级以及新记录 —— 完整示例见 webhooks。
10. 批量评分(组合)
若要一次性评估整个组合而非逐个主体,请通过POST /v1/qscore/batches 提交一个批次:最多 5,000 个主体(JSON 或 CSV),整个批次共享一个 country 和 purpose,费用预先估算。API 立即返回 202 Accepted,后台 worker 逐条生成单份报告——每个条目都是标准的 Qscore 报告,带有自己的 PDF、费用,以及生成失败时的自动退款。
- 结束时仅一次通知:批次完成后,您将收到恰好一个
risk_batch_completedwebhook 和一封汇总邮件(绝不按主体逐个发送)。 - 后续跟踪:列出并查看批次、分页浏览条目,并通过
GET /v1/qscore/batches/{id}/results.csv下载汇总 CSV。
常见问题
如果收费后报告失败会怎样?
如果收费后报告失败会怎样?
费用将在同一流程中自动退还,报告以
failed 结束并带有 error_code。您的 idempotency_key 将重放到该失败的报告;要重试,请使用新密钥。为什么用途是必填的?
为什么用途是必填的?
智利数据保护法要求声明合法用途才能查询个人或企业的信用数据。该用途与报告一起存储并打印在报告中(供数据主体审计)。
我可以在不支付报告费用的情况下查看某人的评分吗?
我可以在不支付报告费用的情况下查看某人的评分吗?
可以——如果您已经购买过该主体的报告,
GET /v1/qscore/subjects/{doc_id}/score 将免费返回最新计算的评分。主体的第一份报告始终是付费的完整报告。PDF 会通过电子邮件发送吗?
PDF 会通过电子邮件发送吗?
不会。“报告就绪”电子邮件特意不携带附件(第三方数据最小化)。PDF 只能通过 API 身份验证后下载。
支持哪些国家/地区?
支持哪些国家/地区?
目前为智利(
country: "CL",RUT 作为 doc_id)。契约是国家无关的:新国家/地区接入其来源后将使用相同的端点。被监控主体多久检查一次?
被监控主体多久检查一次?
每约 5 分钟。
risk_monitoring_alert webhook 仅在相对基线发生变化时才触发(设置 only_material: true 后仅重大变更触发)—— 绝不会因无变化而打扰您。