个人债务发行
使用债务发行 API,可以为自然人申请发行债务。无需提前注册借款人,只需在申请时提供注册数据即可。
注意!
债务 API 设计为只需执行一次请求即可完成,需在提前上传文件(文档上传)之后执行。 请求头和请求体的签名格式详情请参见此处。
请求
ENDPOINT
/debtMÉTODO
POST请求体
{
"borrower": {
"name": "Alan Mathison Turing",
"email": "alan.turing@email.com",
"phone": {
"number": "912345678",
"area_code": "11",
"country_code": "055"
},
"is_pep": false,
"address": {
"city": "São Paulo",
"state": "SP",
"number": "1000",
"street": "Avenida Feliz",
"complement": "AP 801",
"postal_code": "49026100",
"neighborhood": "Centro"
},
"role_type": "issuer",
"birth_date": "1990-11-20",
"mother_name": "Nome da Mãe do Alan",
"nationality": "brasileiro",
"person_type": "natural",
"individual_document_number": "96969879003",
"document_identification": "494598fd-c226-4332-a500-591ae3884673"
},
"financial": {
"disbursed_amount": 123456,
"interest_type": "pre_price_days",
"credit_operation_type": "ccb",
"monthly_interest_rate": 0.018,
"disbursement_date": "2026-03-01",
"rebates": [
{
"amount": 10,
"fee_type": "tac",
"amount_type": "absolute",
"rebate_bank_account": {
"name": "CONTA BANCARIA",
"bank_code": "329",
"account_digit": "1",
"branch_number": "0001",
"account_number": "00003",
"document_number": "32402502000135"
}
}
],
"interest_grace_period": 0,
"principal_grace_period": 0,
"number_of_installments": 2,
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
}
},
"disbursement_bank_account": {
"name": "Alan Mathison Turing",
"document_number": "96969879003",
"bank_code": "341",
"branch_number": "8615",
"account_number": "22110",
"account_digit": "2",
"account_type": "checking_account"
},
"purchaser_document_number": "32402502000135",
"credit_agent": {
"document_number": "87237271016",
"name": "Agente de credito"
}
}
注意
credit_agent 对象代表信贷代理(有时称为"pastinha"),负责该债务的来源开发。对于代扣工资贷款的发行,该字段为必填项。
响应
此次债务请求的响应将返回还款计划以及 DEBT-KEY,即债务在 QI SCD 中的标识符。
STATUS
200响应体
{
"webhook_type": "debt",
"key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
"status": "waiting_signature",
"event_datetime": "2025-03-27 22:46:10",
"data": {}
}
定义
请求体对象
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
| borrower * | object | Borrower 对象 - 信贷操作的债务人 | - |
| disbursement_bank_account * | object | Disbursement Bank Account 对象 - 操作放款的银行账户数据 | - |
| financial * | object | Financial 对象 - 操作放款的银行账户数据,标识所发送的对象为自然人。borrower PF 时必须始终包含 "natural" 值 | - |
| purchaser_document_number * | string | 信贷操作受让人(买方)的 CNPJ | - |
Borrower 对象
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
| name * | string | 债务人姓名 | 100 |
| string | 债务人电子邮件 | 254 | |
| phone | object | Phone 对象 - 债务人联系电话 | - |
| is_pep * | boolean | PEP 指示器(http://www.portaldatransparencia.gov.br/download-de-dados/pep) | - |
| address * | object | Address 对象 - 债务人地址 | - |
| role_type * | enum | 默认值:issuer | - |
| birth_date * | date | 债务人出生日期(格式 "YYYY-MM-DD") | - |
| mother_name * | string | 债务人母亲姓名 | 100 |
| nationality | string | 债务人国籍 | 50 |
| person_type * | string | 自然人标识 - 默认值:natural | - |
| individual_document_number * | string | 债务人 CPF(仅数字) | 11 |
| document_identification * | string | 带照 片的债务人身份证明文件 PDF 的 DOCUMENT_KEY(身份证或驾驶证) | - |
| document_identification_back | string | 带照片的身份证明文件背面 PDF 的 DOCUMENT_KEY(身份证或驾驶证)(预先上传)。 | 11 |
| wedding_certificate | string | 结婚证 PDF 的 DOCUMENT_KEY(预先上传)。若 marital_status 为 "single",该字段值应为 NULL。 | 11 |
| proof_of_residence * | string | 所提供地址的居住证明 PDF 的 DOCUMENT_KEY(预先上传)。 | 11 |
Address 对象
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
| city * | string | 地址所在城市 | 100 |
| state * | string | 地址所在州(两位大写字母) | 2 |
| number * | string | 门牌号 | 10 |
| street * | string | 街道名称 | 100 |
| complement * | string | 地址补充信息(自由文本) | 100 |
| postal_code * | string | 邮政编码(http://www.buscacep.correios.com.br/sistemas/buscacep/) | 8 |
| neighborhood * | string | 社区/街区名称 | 100 |
Phone 对象
| 字段 | 描述 | 示例 | 最大字符数 |
|---|---|---|---|
| number * | string | 电话号码 | 10 |
| area_code * | string | 区号(https://ddd.guiamais.com.br/) | 2 |
| country_code * | string | 国家代码(https://ddi.guiamais.com.br/) | 3 |
Disbursement Bank Account 对象
债务发行必须包含放款的银行账户信息,默认情况下为债务人名下的账户。
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
| name | string | 账户持有人姓名 | 50 |
| document_number | string | 账户持有人 CPF | 11 |
| bank_code * | string | 金融机构的 COMPE 代码(https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) | 3 |
| branch_number * | string | 支行号码(请勿填写支行验证位!) | 4 |
| account_number * | string | 账号(不含验证位!) | 10 |
| account_digit * | string | 账户验证位(字母处填写零) | 1 |
| account_type | enum | 账户类型枚举值 账户类型 | 1 |
Financial 对象
Financial 对象描述信贷操作的财务信息。
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
| amout | float | 信贷操作的发行/名义金额 | - |
| interest_type | object | 利率类型枚举值 - 摊销方法和利率计算方式 | - |
| credit_operation_type | object | 信贷操作类型枚举值 - 信贷合同类型 | - |
| annual_interest_rate | float | 以年化小数表示的固定利率 | - |
| disbursement_date | date | 操作放款日期 | - |
| interest_grace_period | int | 利息宽限期(月) | - |
| principal_grace_period | int | 本金宽限期 | - |
| number_of_installments | int | 信贷操作的分期数 | - |
| fine_configuration | object | Fine Configuration 对象 - 逾期利息和罚款配置 | - |
Fine Configuration 对象
Fine Configuration 对象中填写信贷操作的逾期罚款和利息金额。
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
| contract_fine_rate | float | 逾期罚款百分比 | - |
| interest_base | enum | 利率基准枚举值 - 利率计算基准 | - |
| monthly_rate | float | 月逾期利率 | - |
Rebates 对象
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
| fee_type * | enum | 费用类型。 | - |
| amount_type * | object | 收取金额的类型。 | - |
| amount * | object | 费用金额。若费用类型为百分比,则值应在 0 到 100 之间。 | - |
响应体
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
| data[n].data | object | Data 对象 | - |
| data[n].event_datetime | date | 信贷操作生成时刻 | - |
| data[n].key | string | DEBT-KEY - QI 内信贷操作的唯一密钥 | - |
| data[n].status | string | 债务可能的状态 | - |
| data[n].type | string | debt | - |
枚举值
Person Type 枚举值
| 枚举值 | 描述 |
|---|---|
| legal | 法人 |
| natural | 自然人 |
Amount Type 枚举值
| 枚举值 | 描述 |
|---|---|
| tac | 向借款人收取的费用。 |
| spread | 向基金收取并加入操作转让价格的费用。 |
Account Type 枚举值
| 枚举值 | 描述 |
|---|---|
| checking_account | 活期账户 |
| deposit_account | 存款账户 |
| guaranteed_account | 担保账户 |
| investment_account | 投资账户 |
| payment_account | 支付账户 |
| saving_account | 储蓄账户 |
| salary_account | 工资账户 |
Interest Type 枚举值
| 枚举值 | 描述 |
|---|---|
| pre_price_days | Price 摊销法(等额分期),按日计算固定利率 |
| pre_price | Price 摊销法(等额分期),按固定周期(30天)计算固定利率 |
| pre_sac | SAC 摊销法(等额本金),按日计算固定利率 |
| post_sac | SAC 摊销法(等额本金),按日计算基于固定利率加浮动指数(cdi、ipca 或 igpm)的利率 |
| post_price | Price 摊销法(等额分期),按固定周期(30天)计算基于固定利率加浮动指数(cdi、ipca 或 igpm)的利率 |
| post_price_days | Price 摊销法(等额分期),按日计算基于固定利率加浮动指数(cdi、ipca 或 igpm)的利率 |
Credit Operation Type 枚举值
| 枚举值 | 描述 |
|---|---|
| ccb | 银行信贷凭证 |
| cce | 出口信贷凭证 |
| cci | 房地产信贷凭证 |
| nce | 出口信贷票据 |
Interest Base 枚举值
| 枚举值 | 描述 |
|---|---|
| workdays | 以工作日为基准计算利率,按 252 天/年计算 |
| calendar_days | 以自然日为基准计算利率,按 360 天/年计算 |
| calendar_days_365 | 以自然日为基准计算利率,按 365 天/年计算 |
Fee Type 枚举值
每种费用类型必须提前由 QI Tech 启用和配置
| 枚举值 | 描述 |
|---|---|
| tac | 开户费 |
| spread | 信贷操作收购金额中收取的溢价 |
| warranty_analysis | 担保分析费 |
| ted_fee | TED 费用 |
| spread_ted_fee | 信贷操作收购金额中收取的 TED 费用溢价 |