跳到主要内容

保险

QI Tech 为客户提供在信贷操作中附加保险的可能性，本文将帮助您了解如何在我们的 API 中使用该产品并深入了解该新产品。

注意

该产品仅对已注册的合作方开放，请咨询我们的商务团队了解更多详情。

如何使用​

要订购保险或模拟含保险的债务，应在回扣列表中添加类型为 "insurance_premium_qi" 的回扣，无需声明任何金额，因为金额将根据提案的发行金额和所订购的保险产品计算。

注意

不能将 tac 或 insurance_premium 类型的回扣与 insurance_premium_qi 一起使用。

回扣对象
{
  "rebates": [
    {
      "fee_type": "insurance_premium_qi",
      "description": "insurance_premium_plus"
    }
  ]
}

债务模拟​

请求​

下面的示例描述了一次包含保险报价的债务模拟请求。

ENDPOINT
/fgts_simulation
MÉTODO
POST
请求体
{
  "borrower": {
    "person_type": "natural",
    "individual_document_number": "46338864879",
    "birth_date": "1996-03-20"
  },
  "financial": {
    "desired_installments": [
      {
        "total_amount": 200,
        "due_date": "2023-10-01"
      }
    ],
    "interest_type": "pre_price_days",
    "disbursement_date": "2023-03-03",
    "fine_configuration": {
      "monthly_rate": 0,
      "interest_base": "calendar_days",
      "contract_fine_rate": 0
    },
    "monthly_interest_rate": 0.018,
    "credit_operation_type": "ccb",
    "interest_grace_period": 0,
    "number_of_installments": 1,
    "principal_grace_period": 0,
    "rebates": [
      {
        "fee_type": "insurance_premium_qi",
        "description": "insurance_premium_plus"
      }
    ]
  }
}

响应​

STATUS
200
响应体
{
    "type": "debt",
    "key": "a445c71c-d752-4159-82bf-097d8125b66c",
    "status": "finished",
    "event_datetime": "2024-10-03 00:26:26",
    "data": {}
}
警告

可以在模拟阶段验证保险收费的资格。
为此，必须提供出生日期（birth_date）、债务人的 CPF（document_number）以及回扣 "insurance_premium_qi"。
如果 CPF 符合资格，将返回成功响应；如果不符合资格，模拟请求将返回错误。

警告

提交出生日期（birth_date）在含保险的模拟中不是必填项。但在债务发行时，若订购了该产品，则该字段为必填项。

查询 CPF 的保险资格​

持有 CPF 数据后，可以查询该 CPF 的资格。

请求​

ENDPOINT
/debts/borrower/[document_number]/insurance_premium_eligibility?birth_date=1994-06-11&issue_amount=150
METHOD
GET

参数​

字段描述
document_number债务人的 CPF 号码
birth_date出生日期
issue_amount信贷操作的发行金额

响应​

STATUS
200
响应体
{
    "eligible": true
}

描述​

字段类型
elegibleboolean
注意

对于返回 "elegible": false 的 CPF，含 insurance_premium_qi 的模拟和债务发行都将不可能执行。

创建债务​

要创建含保险的债务，需要借款人的一些必填数据，如地址、电话、电子邮件和出生日期。如果省略其中任何数据，债务将无法发行。

请求​

ENDPOINT
/debt
MÉTODO
POST
请求体
{
  "borrower": {
    "person_type": "natural",
    "individual_document_number": "46338864879",
    "name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA",
    "is_pep": false,
    "mother_name": "HELENA DO NASCIMENTO PEREIRA DA SILVA",
    "email": "email@email.com",
    "birth_date": "1994-06-11",
    "phone": {
      "number": "900000000",
      "area_code": "11",
      "country_code": "055"
    },
    "address": {
      "city": "São Paulo",
      "state": "SP",
      "number": "215",
      "street": "Gilberto Sabino",
      "complement": "s/c",
      "postal_code": "12345012",
      "neighborhood": "Pinheiros"
    }
  },
  "financial": {
    "desired_installments": [
      {
        "total_amount": 200,
        "due_date": "2023-10-01"
      }
    ],
    "interest_type": "pre_price_days",
    "disbursement_date": "2023-03-03",
    "fine_configuration": {
      "monthly_rate": 0,
      "interest_base": "calendar_days",
      "contract_fine_rate": 0
    },
    "monthly_interest_rate": 0.018,
    "credit_operation_type": "ccb",
    "interest_grace_period": 0,
    "number_of_installments": 1,
    "principal_grace_period": 0,
    "rebates": [
      {
        "fee_type": "insurance_premium_qi",
        "description": "insurance_premium_plus"
      }
    ]
  },
  "disbursement_bank_account": {
    "ispb_number": "18236120",
    "branch_number": "1",
    "account_number": "87823171",
    "account_digit": "0",
    "document_number": "46338864879",
    "name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA",
    "percentage_receivable": 1
  },
  "purchaser_document_number": "32402502000135"
}

响应​

STATUS
201
响应体
{
  "webhook_type": "debt",
  "key": "7a9bb512-7b38-4dbc-a109-1bc122b67a4a",
  "status": "waiting_signature",
  "event_datetime": "2023-03-03 18:06:18",
  "data": {}
}

Webhooks​

保险已发行​

保险将在操作放款后发行，当保险发行完成时，将发送以下包含保险数据的 webhook。

注意

收到保险票据已发行的 webhook 时，必须将生成的票据文件传送给信贷借款人。

Webhook Body
{
  "data": {
    "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962",
    "insurance_policy_document_key": "9990ce22-aeac-4728-82da-d1f22c33873f",
    "insurance_date": "2024-09-11",
    "term_start_date": "2024-09-11",
    "term_end_date": "2025-09-11",
    "insurance_amount": 1600,
    "operation_amount": 6400,
    "covers": [
      {
        "cover_amount": 200,
        "cover_type": "permanent_disability",
        "cover_prize_amount": 572.82
      },
      {
        "cover_amount": 100,
        "cover_type": "accidental_death",
        "cover_prize_amount": 572.82
      },
      {
        "capitalcover_amount_segurado": 300,
        "cover_type": "unemployment",
        "cover_prize_amount": 572.82
      }
    ],
    "policy_number": "1098200000008",
    "prize_number": "3907",
    "insurance_premium_net_amount": 1145.63,
    "iof_amount": 4.37
  },
  "event_datetime": "2023-03-03 22:39:39",
  "key": "dc575950-dcce-48e1-99a6-5fb0ada63d86",
  "status": "active",
  "webhook_type": "insurance_premium.status_change"
}

保险已取消​

当信贷借款人希望放弃信贷操作且操作被撤销、超过某个承保限额（导致不符合保险资格），或借款人仅放弃保险时，保险可被取消。

注意

保险票据只能在信贷操作放款后 7 个自然日内全额取消；如果在此之后取消，退还金额将按保险期限比例计算。

Webhook Body
{
    "key": "dc575950-dcce-48e1-99a6-5fb0ada63d86",
    "data": {
        "cancel_reason": "reversed_operation",
        "credit_operation_key": "2fbd6613-3228-5gdg-9377-93db394bf2d4"
    },
    "status": "canceled",
    "webhook_type": "insurance_premium.status_change",
    "event_datetime": "2023-03-03 22:39:39"
}

取消原因​

cancel_reason描述
reversed_operation操作已撤销，保险已取消
cover_limit_amount_exceeded仅保险被取消。某个承保限额被超过，无法发行保险
insurance_premium_cancel仅保险被取消。借款人直接与保险公司取消

保险查询​

请求​

ENDPOINT
/debt/[debt_key]/insurance_premiums
METHOD
GET

响应​

STATUS
200
响应体
{
  "data": [],
  "pagination": {
    "current_page": 0,
    "next_page": 0,
    "rows_per_page": 1
  }
}

请求​

ENDPOINT
/debt/[DEBT-KEY]/insurance_premium/[INSURANCE-PREMIUM-KEY]
METHOD
GET

响应​

STATUS
200
响应体
{
  "insurance_premium_key": "e4fe84e3-cc71-481b-87ea-8a07f7d69079",
  "status": "active",
  "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962",
  "disbursement_key": "bd0ea133-ff47-4a21-a3e6-24186e5e2fc1",
  "contract_number": "4069550961/QIT",
  "requester_key": "1040ce22-aeac-4728-82da-d1f22c33873f",
  "insurance_policy_document_key": "9990ce22-aeac-4728-82da-d1f22c33873f",
  "insurance_date": "2024-09-11",
  "term_start_date": "2024-09-11",
  "term_end_date": "2025-09-11",
  "insurance_amount": 1600,
  "operation_amount": 6400,
  "covers": [],
  "policy_number": "1098200000008",
  "prize_number": "3907",
  "insurance_premium_net_amount": 1145.63,
  "iof_amount": 4.37
}

查询票据文件​

注意

文件链接有效期为 15 分钟。

请求​

ENDPOINT
/document/[DOCUMENT-KEY]/url
METHOD
GET

响应​

STATUS
200
响应体
{
    "document_key": "a11dc0fe-51ed-41aa-bb40-bca80d6e515b",
    "signed_document_url": null,
    "document_url": "https://storage.googleapis.com/dev-doc-api-private/documents/...",
    "expiration_datetime": "2023-03-03T19:08:53.000Z"
}