Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-244385400.4 KB
Credit Insights

Retrieve Risk Insights (Customer)

Returns risk insights derived from submitted customer documents and transactions.

get/customers/{customer_id}/credit_analysis/risk_insights

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 risk insights.

count_atm_withdrawalnumber

The quantity of ATM withdrawal transactions.

total_atm_withdrawalnumber

The summed amount of all ATM withdrawal transactions (in cents).

count_nsfnumber

The quantity of non-sufficient fund transactions. Excluding refund transactions.

count_nsf_daysnumber

The number of unique days on which non-sufficient fund transactions occurred. Excluding refund transactions.

count_overdraftnumber

The quantity of overdraft transactions. Excluding refund transactions.

count_overdraft_daysnumber

The number of unique days on which overdraft transactions occurred. Excluding refund transactions.

gambling_netnumber

This is the total gambling income minus the total gambling losses (in cents).

total_gambling_spendnumber

The summed amount of all gambling spend transactions (in cents).

expenditure_exceeds_incomeboolean

A boolean which checks if total expenditure exceeded total income. For example, this will be set to True if total expenditure is $100 and total income is $50.

count_crypto_tradingnumber

The quantity of crypto trading transactions.

crypto_trading_netnumber

The summed amount of all crypto trading transactions (in cents).

count_negative_balance_daysnumber

The number of days for which there was a negative balance. Daily balances are taken from the end of each day.

daily_balance_volatilitynumber

This is the standard deviation of all daily balances. This represents the volatility of the customers bank account balances. For customers with multiple bank accounts, we calculate the standard deviation of the sum of the bank account balance variables.

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.

Example response

{
  "count_atm_withdrawal": 4,
  "total_atm_withdrawal": 10000,
  "count_nsf": 2,
  "count_nsf_days": 2,
  "count_overdraft": 2,
  "count_overdraft_days": 1,
  "gambling_net": -10000,
  "total_gambling_spend": 10000,
  "expenditure_exceeds_income": true,
  "count_crypto_trading": 2,
  "crypto_trading_net": 500000,
  "daily_balance_volatility": 119,
  "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
}