v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Debt Reports Chile

Retrieve debt details for a link

Retrieve debt reports information for a specific fiscal link.

post/api/cl/debt-reports/

Query parameters

omitstring

Omit certain fields from being returned in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

Headers

X-Belvo-Request-Mode'async'

Example:async

Recommended header parameter to make your POST request asynchronous (thus preventing timeouts and improving your data flow).

When you make an asynchronous request, Belvo responds with a 202 - Accepted payload, including the request_id. Once we have retrieved the requested information, you will receive a webhook with the link and request IDs.

Request body

linkstring uuid required

The link.id you want to retrieve information for.

attach_pdfboolean

When set to true, you will receive the PDF in binary format in the response.

save_databoolean

Indicates whether or not to persist the data in Belvo. By default, this is set to true and we return a 201 Created response.

When set to false, the data won't be persisted and we return a 200 OK response.

Example request

{
  "link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
  "attach_pdf": true,
  "save_data": true
}

Response

Ok (when save_data=false)

idstring uuid

Belvo's unique identifier for the current item.

linkstring uuid nullable

The link.id the data belongs to.

collected_atstring date-time

The ISO-8601 timestamp when the data point was collected.

created_atstring date-time

The ISO-8601 timestamp of when the data point was created in Belvo's database.

debt_data_last_updatestring date

The date when the debt data was last updated, in YYYY-MM-DD format.

currencystring

The currency of the debts. For Chile, this will be the CLP.

totalnumber float nullable

The total amount of debt including current, delinquent, severely delinquent, and defaulted debts.

currentnumber float nullable

The amount of debt that is currently outstanding but not past due.

delinquentnumber float nullable

The amount of debt that is 30-59 days past due.

severely_delinquentnumber float nullable

The amount of debt that is 60-89 days past due.

defaultednumber float nullable

The amount of debt that is 90 days past due.

Example response

[
  {
    "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
    "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
    "collected_at": "2022-02-09T08:45:50.406032Z",
    "created_at": "2022-02-09T08:45:50.406032Z",
    "personal_data": {
      "full_name": "Cabezas Pérez Martín Vicente ",
      "document_id_type": "RUT",
      "document_id_number": "12345678-9"
    },
    "debt_data_last_update": "2023-07-02",
    "currency": "CLP",
    "total": 6506000.02,
    "current": 5350000.02,
    "severely_delinquent": 56000.02,
    "defaulted": 1100000.02,
    "direct_debts": [
      {
        "financial_institution": "Banco Santander",
        "credit_type": "Vivienda",
        "amount": 5000000.02,
        "current": 5000000.02
      }
    ],
    "indirect_debts": [
      {
        "financial_institution": "Banco BCI",
        "credit_type": "Consumo",
        "amount": 200000.02,
        "defaulted": 200000.02
      }
    ],
    "credit_lines": [
      {
        "financial_institution": "Banco BCI",
        "direct_amount": 5000000.02
      }
    ],
    "other_credits": [
      {
        "financial_institution": "Banco BCI",
        "indirect_amount": 250000.02
      }
    ]
  }
]