跳到主要内容

Lending Analysis (贷款分析)

初版文档

这是 Lending Analysis 文档的第一版，可能会进行小幅修改。建议关注此页面以获取未来更新。

Lending Analysis 端点允许您对借款人进行完整的信用分析，将入职审核、信用分析和私人工资单余额查询合并为一个请求。

该操作是异步的：发送请求后，API 返回状态为 pending_analysis 的同步响应。分析最终结果将在处理完成后通过 webhook 交付。

流程
  1. 客户端向 /lending_analysis 发送 POST 请求，包含借款人数据和所需查询。
  2. API 返回同步响应，包含 lending_analysis_key 和状态 pending_analysis。
  3. 处理完成后，API 发送包含完整分析结果的 webhook。

请求​

ENDPOINT
/lending_analysis
METHOD
POST
Request Body
{
    "request_identifier_key": "12345678901",
    "document_number": "46276658812",
    "lending_analysis_type": "private_payroll",
    "purchaser_document_number": "12345678000199",
    "private_payroll": {
        "employer_document_number": "12345678000199",
        "registration_number": "12345678901"
    },
    "authorization_term": {
        "legal_representative_document_number": "98765432100",
        "signature": {
            "signer": {
                "document_number": "46276658812",
                "name": "João da Silva",
                "email": "joao.silva@email.com",
                "phone": {
                    "number": "912345678",
                    "area_code": "11",
                    "country_code": "55"
                }
            },
            "authentication_type": "opt_in",
            "authenticity": {
                "timestamp": "2026-03-12T10:00:00Z",
                "ip_address": "192.168.1.100",
                "fingerprint": {},
                "session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
            }
        }
    },
    "analysis_data": {
        "name": "João da Silva"
    }
}

Body 参数​

字段类型描述字符数
request_identifier_keystring幂等请求键。每次分析必须唯一。-
document_numberstring借款人的 CPF（仅数字）。11
lending_analysis_typestring信用分析类型。Lending Analysis Type 枚举
purchaser_document_numberstring买方/受让人 CNPJ。（可选）14
private_payrollobject借款人的私人工资单数据。Private Payroll 对象
authorization_termobject借款人授权条款。Authorization Term 对象
analysis_dataobject用于分析的借款人附加数据。Analysis Data 对象

Private Payroll 对象​

字段类型描述字符数
employer_document_numberstring雇主 CNPJ。14
registration_numberstring工人登记号。-

Authorization Term 对象​

注意

当存在法定代表人时，必须在 legal_representative_document_number 字段中填写代表人的 CPF，并且 signer 对象数据必须使用代表人的信息填写。

有关 authorization_term 对象的更多信息，请参阅官方文档： 工人查询 - 余额查询

字段类型描述字符数
legal_representative_document_numberstring法定代表人的 CPF（仅在有法定代表人时必填）。11
signature.signer.document_numberstring签名人的 CPF。11
signature.signer.namestring签名人姓名。-
signature.signer.emailstring签名人电子邮件。（可选）-
signature.signer.phone.numberstring签名人电话号码。（可选）-
signature.signer.phone.area_codestring签名人区号。（可选）2
signature.signer.phone.country_codestring国家代码（例如 "55"）。（可选）3
signature.authentication_typestring认证类型。必须为 "opt_in"。-
signature.authenticity.timestampstring同意日期和时间（ISO 8601 格式：2026-03-12T10:00:00Z）。-
signature.authenticity.ip_addressstring用户会话 IP（IPv4 或 IPv6）。-
signature.authenticity.fingerprintobject附加可追溯性证据（可以是空对象 {}）。-
signature.authenticity.session_idstring用户会话标识符（最少 10 个字符，最多 50 个字符）。50

Analysis Data 对象​

字段类型描述字符数
namestring借款人姓名。（可选）-

响应​

STATUS
202
Response Body
{
    "analysis_status": "pending_analysis",
    "lending_analysis_key": "06666318-c9e9-416b-ae2f-460355a3d8e8"
}
字段类型描述
analysis_statusstring当前分析状态。同步响应中返回 pending_analysis。
lending_analysis_keystring分析的 UUID 键，用于与 webhook 关联。
STATUS
400
Response Body
{
    "title": "Bad Request",
    "description": "Invalid or missing required fields in the request body. Check 'document_number', 'lending_analysis_type', 'private_payroll', and 'authorization_term'.",
    "translation": "Campos obrigatórios ausentes ou inválidos no corpo da requisição. Verifique 'document_number', 'lending_analysis_type', 'private_payroll' e 'authorization_term'.",
    "extra_fields": {},
    "code": "LAS000001"
}
STATUS
409

当 request_identifier_key 字段已在先前的请求中使用时返回。

Response Body
{
    "title": "Conflict",
    "description": "A lending analysis with the provided 'request_identifier_key' already exists. Each analysis must use a unique identifier.",
    "translation": "Já existe uma análise de crédito com o 'request_identifier_key' informado. Cada análise deve utilizar um identificador único.",
    "extra_fields": {
        "existing_lending_analysis_key": "06666318-c9e9-416b-ae2f-460355a3d8e8"
    },
    "code": "LAS000002"
}

Webhooks​

注意！

QI Tech 的 webhook 不应严格映射。 返回的 webhook 负载中可能包含附加字段。

Webhook 类型: laas.lending_analysis.lending_analysis_status_change

当分析完成时，webhook 会发送到客户端环境中配置的 URL。

分析完成 Webhook​

Response Body
{
    "key": "06666318-c9e9-416b-ae2f-460355a3d8e8",
    "status": "completed",
    "webhook_type": "laas.lending_analysis.lending_analysis_status_change",
    "event_datetime": "2026-03-12T10:05:00Z",
    "data": {
        "request_identifier_key": "12345678901",
        "analysis_status": "reproved",
        "analysis_steps": [
            {
                "analysis_step_type": "onboarding",
                "analysis_step_status": "approved",
                "reason": "Passou nas validações",
                "output_data": {}
            },
            {
                "analysis_step_type": "credit_analysis",
                "analysis_step_status": "reproved",
                "reason": "Score do Serasa menor que 500",
                "output_data": {
                    "analysis_score": 100,
                    "credit_model_score": 100,
                    "maximum_monthly_interest_rate": 0.00,
                    "minimum_monthly_interest_rate": 0.00,
                    "maximum_installments_number": 10,
                    "minimum_installments_number": 1,
                    "maximum_disbursed_issue_amount": 4500.00,
                    "minimum_disbursed_issue_amount": 0.00
                }
            }
        ],
        "inquiries": [
            {
                "inquiry_type": "private_payroll",
                "inquiry_data": {
                    "document_number": "99999999999",
                    "registration_number": "99999999999-A",
                    "employer_document_number": "99999999999962",
                    "name": "JOÃO SILVA",
                    "gender": "male",
                    "birth_date": "1985-07-20",
                    "worker_category_code": 101,
                    "eligible": true,
                    "available_margin_amount": 5000.00,
                    "base_margin_amount": 4500.00,
                    "total_due_amount": 8207.54,
                    "admission_date": "2020-03-15",
                    "termination_date": null,
                    "termination_reason_code": null,
                    "political_exposition": "not_exposed",
                    "employer_name": "EMPRESA XYZ LTDA",
                    "mother_name": "MARIA DA SILVA",
                    "nationality": {
                        "code": 76,
                        "description": "BRASIL"
                    },
                    "occupation": {
                        "code": 724325,
                        "description": "SOLDADOR ELETRICO"
                    },
                    "economic_activity": {
                        "code": 2833000,
                        "description": "FABRICACAO DE MAQUINAS E EQUIPAMENTOS PARA A AGRICULTURA E PECUARIA"
                    },
                    "ineligibility_reason": "not_informed",
                    "employer_activity_start_date": "2010-05-12",
                    "legacy_loans": [],
                    "alerts": [
                        {
                            "alert_type": "leave",
                            "reference_date": "2025-02-11",
                            "event_id": 123456,
                            "leave_reason_code": 3,
                            "leave_start_date": "2025-02-11",
                            "leave_end_date": "2025-03-11"
                        },
                        {
                            "alert_type": "termination",
                            "reference_date": "2025-02-11",
                            "event_id": 789012,
                            "termination_reason_code": 1,
                            "termination_date": "2025-02-11",
                            "notice_period_start_date": "2025-01-11",
                            "notice_period_end_date": "2025-02-11"
                        }
                    ]
                }
            }
        ]
    }
}

Webhook 字段描述​

字段类型描述
keystring同步响应中返回的 lending_analysis_key。
statusstringWebhook 状态。
webhook_typestringWebhook 类型。
event_datetimestring事件日期和时间（ISO 8601）。
data.request_identifier_keystring原始请求中提供的幂等键。
data.analysis_statusstring最终分析状态。分析状态
data.analysis_stepsarray已执行的分析步骤列表。Analysis Steps 对象
data.inquiriesarray从执行的查询中返回的数据。请参阅 Inquiry 数据 (inquiry_data) 部分。

Analysis Steps 对象​

字段类型描述
analysis_step_typestring步骤类型。个别分析类型
analysis_step_statusstring个别步骤状态（approved 或 reproved）。
reasonstring批准或拒绝原因，由客户规则定义。
output_dataobject步骤特定的输出数据。

output_data — credit_analysis​

重要

所有 output_data 字段均可在分析规则中配置。如果规则未配置返回特定字段，该字段将返回为空或不出现在负载中。

字段类型描述
analysis_scorenumber信用分析评分。
credit_model_scorenumber信用模型评分。
maximum_monthly_interest_ratenumber最高月利率。
minimum_monthly_interest_ratenumber最低月利率。
maximum_installments_numbernumber最大分期数。
minimum_installments_numbernumber最小分期数。
maximum_disbursed_issue_amountnumber最大发放金额。
minimum_disbursed_issue_amountnumber最小发放金额。

Inquiry 数据 (inquiry_data)​

Webhook 中的 inquiries 数组包含分析期间执行的查询返回的数据。每个项目都有 inquiry_type（查询类型）和 inquiry_data（返回数据）字段。

对于 private_payroll 类型，inquiry_data 对象遵循与私人工资单模块的工人数据查询相同的响应格式，包括个人数据、代扣额度、就业关系历史、活跃贷款和警报。

inquiry_data 字段、枚举值和响应示例的完整文档请参阅：

工人查询 — 2. 工人数据查询

枚举值​

Lending Analysis Type 枚举​

字段描述
private_payroll私人工资单信用分析

分析状态​

analysis_status（同步响应和 webhook data.analysis_status）

状态描述
pending_analysis分析正在处理中
approved分析已批准
reproved分析已拒绝

Webhook 状态​

status（webhook 根字段）

状态描述
completed处理已完成
failed处理失败

个别分析类型​

analysis_step_type（analysis_steps 数组内）

枚举值描述
onboarding入职/注册分析
credit_analysis信用分析

个别分析状态​

analysis_step_status（analysis_steps 数组内）

状态描述
approved个别分析已批准
reproved个别分析已拒绝

沙盒 — 测试用例​

重要提示！

请勿在沙盒环境中使用真实个人数据（CPF、CNPJ 等）。

在沙盒环境中，分析结果由请求体中 analysis_data.name 字段的值决定。使用以下名称模拟不同场景：

名称 (analysis_data.name)入职结果信用分析结果最终状态 (analysis_status)
Ana Santosapprovedapprovedapproved
Carlos Oliveiraapprovedreprovedreproved
Mariana Costareproved—reproved
Pedro Almeidaapproved—approved
Fernanda Limareproved—reproved
工作原理
  • 入职批准 + 信用分析批准（Ana Santos）：完整分析获批。Webhook 返回 analysis_status: "approved"，两个步骤均获批准。
  • 入职批准 + 信用分析拒绝（Carlos Oliveira）：入职获批但信用分析被拒。Webhook 返回 analysis_status: "reproved"。
  • 入职拒绝（Mariana Costa、Fernanda Lima）：入职被拒，信用分析不执行。Webhook 返回 analysis_status: "reproved"，仅包含入职步骤。
  • 仅入职批准（Pedro Almeida）：仅执行入职并获批，不进行信用分析。Webhook 返回 analysis_status: "approved"，仅包含入职步骤。
Webhook — 沙盒使用名称 "Ana Santos"
{
    "key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "completed",
    "webhook_type": "laas.lending_analysis.lending_analysis_status_change",
    "event_datetime": "2026-03-12T10:05:00Z",
    "data": {
        "request_identifier_key": "sandbox-test-001",
        "analysis_status": "approved",
        "analysis_steps": [
            {
                "analysis_step_type": "onboarding",
                "analysis_step_status": "approved",
                "reason": "Passou nas validações",
                "output_data": {}
            },
            {
                "analysis_step_type": "credit_analysis",
                "analysis_step_status": "approved",
                "reason": "Score acima do mínimo",
                "output_data": {
                    "analysis_score": 750,
                    "credit_model_score": 720,
                    "maximum_monthly_interest_rate": 0.0449,
                    "minimum_monthly_interest_rate": 0.0199,
                    "maximum_installments_number": 24,
                    "minimum_installments_number": 3,
                    "maximum_disbursed_issue_amount": 15000.00,
                    "minimum_disbursed_issue_amount": 500.00
                }
            }
        ],
        "inquiries": [
            {
                "inquiry_type": "private_payroll",
                "inquiry_data": {
                    "document_number": "99999999999",
                    "registration_number": "99999999999-A",
                    "employer_document_number": "99999999999962",
                    "name": "ANA SANTOS",
                    "gender": "female",
                    "birth_date": "1990-05-15",
                    "worker_category_code": 101,
                    "eligible": true,
                    "available_margin_amount": 8000.00,
                    "base_margin_amount": 6500.00,
                    "total_due_amount": 3200.00,
                    "admission_date": "2018-09-01",
                    "termination_date": null,
                    "termination_reason_code": null,
                    "political_exposition": "not_exposed",
                    "employer_name": "EMPRESA XYZ LTDA",
                    "mother_name": "LUCIA SANTOS",
                    "nationality": {
                        "code": 76,
                        "description": "BRASIL"
                    },
                    "occupation": {
                        "code": 411010,
                        "description": "AUXILIAR DE ESCRITORIO"
                    },
                    "economic_activity": {
                        "code": 6499999,
                        "description": "OUTRAS ATIVIDADES DE SERVICOS FINANCEIROS"
                    },
                    "ineligibility_reason": "not_informed",
                    "employer_activity_start_date": "2005-01-10",
                    "legacy_loans": [],
                    "alerts": []
                }
            }
        ]
    }
}
Webhook — 沙盒使用名称 "Carlos Oliveira"（信用分析拒绝）
{
    "key": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "status": "completed",
    "webhook_type": "laas.lending_analysis.lending_analysis_status_change",
    "event_datetime": "2026-03-12T10:05:00Z",
    "data": {
        "request_identifier_key": "sandbox-test-002",
        "analysis_status": "reproved",
        "analysis_steps": [
            {
                "analysis_step_type": "onboarding",
                "analysis_step_status": "approved",
                "reason": "Passou nas validações",
                "output_data": {}
            },
            {
                "analysis_step_type": "credit_analysis",
                "analysis_step_status": "reproved",
                "reason": "Score do Serasa menor que 500",
                "output_data": {
                    "analysis_score": 100,
                    "credit_model_score": 100,
                    "maximum_monthly_interest_rate": 0.00,
                    "minimum_monthly_interest_rate": 0.00,
                    "maximum_installments_number": 10,
                    "minimum_installments_number": 1,
                    "maximum_disbursed_issue_amount": 4500.00,
                    "minimum_disbursed_issue_amount": 0.00
                }
            }
        ],
        "inquiries": [
            {
                "inquiry_type": "private_payroll",
                "inquiry_data": {
                    "document_number": "99999999999",
                    "registration_number": "99999999999-A",
                    "employer_document_number": "99999999999962",
                    "name": "CARLOS OLIVEIRA",
                    "gender": "male",
                    "birth_date": "1988-11-22",
                    "worker_category_code": 101,
                    "eligible": true,
                    "available_margin_amount": 3500.00,
                    "base_margin_amount": 3000.00,
                    "total_due_amount": 12500.00,
                    "admission_date": "2019-06-10",
                    "termination_date": null,
                    "termination_reason_code": null,
                    "political_exposition": "not_exposed",
                    "employer_name": "EMPRESA XYZ LTDA",
                    "mother_name": "ROSA OLIVEIRA",
                    "nationality": {
                        "code": 76,
                        "description": "BRASIL"
                    },
                    "occupation": {
                        "code": 724325,
                        "description": "SOLDADOR ELETRICO"
                    },
                    "economic_activity": {
                        "code": 2833000,
                        "description": "FABRICACAO DE MAQUINAS E EQUIPAMENTOS PARA A AGRICULTURA E PECUARIA"
                    },
                    "ineligibility_reason": "not_informed",
                    "employer_activity_start_date": "2010-05-12",
                    "legacy_loans": [],
                    "alerts": []
                }
            }
        ]
    }
}
Webhook — 沙盒使用名称 "Mariana Costa"（入职拒绝）
{
    "key": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "status": "completed",
    "webhook_type": "laas.lending_analysis.lending_analysis_status_change",
    "event_datetime": "2026-03-12T10:05:00Z",
    "data": {
        "request_identifier_key": "sandbox-test-003",
        "analysis_status": "reproved",
        "analysis_steps": [
            {
                "analysis_step_type": "onboarding",
                "analysis_step_status": "reproved",
                "reason": "Documentação inválida",
                "output_data": {}
            }
        ],
        "inquiries": [
            {
                "inquiry_type": "private_payroll",
                "inquiry_data": {
                    "document_number": "99999999999",
                    "registration_number": "99999999999-A",
                    "employer_document_number": "99999999999962",
                    "name": "MARIANA COSTA",
                    "gender": "female",
                    "birth_date": "1992-03-08",
                    "worker_category_code": 101,
                    "eligible": true,
                    "available_margin_amount": 6000.00,
                    "base_margin_amount": 5000.00,
                    "total_due_amount": 2100.00,
                    "admission_date": "2021-01-15",
                    "termination_date": null,
                    "termination_reason_code": null,
                    "political_exposition": "not_exposed",
                    "employer_name": "EMPRESA XYZ LTDA",
                    "mother_name": "PAULA COSTA",
                    "nationality": {
                        "code": 76,
                        "description": "BRASIL"
                    },
                    "occupation": {
                        "code": 252305,
                        "description": "ANALISTA DE SISTEMAS"
                    },
                    "economic_activity": {
                        "code": 6201500,
                        "description": "DESENVOLVIMENTO DE PROGRAMAS DE COMPUTADOR SOB ENCOMENDA"
                    },
                    "ineligibility_reason": "not_informed",
                    "employer_activity_start_date": "2015-08-20",
                    "legacy_loans": [],
                    "alerts": []
                }
            }
        ]
    }
}

参考​