v1

latestOpenAPI 3.0.0Apache 2.02026-07-244385400.4 KB

Credit Insights

Retrieve Summary Insights (Customer)

Returns income and creditworthiness information extracted from transactions belonging to a specific customer.

get/customers/{customer_id}/credit_analysis

Path parameters

customer_idstring uuid required

The id of the customer to return.

Query parameters

start_datestring date

Specifies the start date for data retrieval. Only data with a date on or after this will be considered. This helps in filtering the data to a specific time frame of interest.

end_datestring date

Specifies the end date for data retrieval. Only data with a date before this will be considered. This helps in filtering data to a specific time frame of interest.

document_idsstring

A comma separated list of document UUIDs. Only data from these documents will be considered (as well as open banking data). This helps in filtering data to include/exclude certain documents.

include_unreconciled_documentsboolean

Unreconciled bank statements are statements where the difference between the parsed opening and closing balances is not explained by the sum of the parsed transaction amounts. Statements are typically unreconciled if the uploaded document has poor quality or is missing some of its original pages. It can also happen when the parsing models fail to parse and extract all relevant data. If this parameter is set to False, unreconciled bank statements will be excluded from the credit insights. This parameter defaults to True, keeping all documents included.

Response

Successfully retrieved customer credit insights.

bank_accountsstring[]

A list of bank accounts associated with the customer.

confidence_scorenumber float

The confidence score represents the degree of certainty for the accuracy of the Credit Insights outputs. We calculate this score using a weighted combination of parsing and transaction categorization certainties. Confidence scores above 0.5 represent high confidence. Also accessible under the metadata header.

customer_contains_low_trust_documentsboolean

This value will be set to True if the customer contains any documents under a trust score threshold of 50. Else, this will be set to False. Also accessible under the metadata header.

Example response

{
  "summary_statistics": {
    "credits_count": 3,
    "credits_total": 200,
    "debits_count": 10,
    "debits_total": 300,
    "maximum_consecutive_days": 31,
    "personal_income_annual_gross": 1200,
    "personal_income_annual_net": 960,
    "personal_income_period_gross": 100,
    "personal_income_period_net": 80,
    "revenue_annual_gross": 1200,
    "revenue_period_gross": 100,
    "total_net": -100,
    "transfers_count": 6,
    "transfers_credits_total": 100,
    "transfers_debits_total": 200,
    "unique_days_count": 31
  },
  "bank_accounts": [
    "http://.../customer/{customer_id}/bank_accounts/{bank_account_id}"
  ],
  "metadata": {
    "confidence_score": 0.99,
    "included_data_sources": {
      "documents": [
        {
          "document_id": "b3de84cf-97aa-4321-a223-51640d5d8fca"
        }
      ],
      "open_banking": [
        {
          "open_banking_data_id": "e959ed48-a9e4-44f3-a6f8-b9dddd21f27c"
        }
      ]
    },
    "excluded_data_sources": {
      "documents": [
        {
          "document_id": "fd7abd7d-5d62-42d0-b49e-62eae1fd4e22",
          "exclusion_reason": "UNRECONCILED_BANK_ACCOUNT"
        }
      ],
      "open_banking": [
        {
          "open_banking_data_id": "920b148f-db30-46fe-8da9-3de2c9e55b04"
        }
      ]
    }
  },
  "confidence_score": 0.99
}