Get Insights for Business Accounts
GET
/public/v3/customers/{customer_id}/insights/current_business
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| customer_id | string | yes | Customer ID |
none
none
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| income | Income | yes | Total monthly income with breakdowns by transaction category |
| expenditure | Expenditure | yes | Total monthly expenditures with breakdowns by transaction category |
| financial_patterns | Financial Patterns | yes | Historical trends of key metrics at transaction level |
| financial_markers | Financial Markers | yes | Metrics that are indicative of some measure of financial risk |
| employment | Employment | yes | Calculated and inferred metrics related to customer's payroll transactions |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| currency | string | yes | Currency code (compatible with ISO 4217) |
| monthly_amounts | Monthly Amount | yes | Array of total monthly amounts |
| categories | Category Income | yes | Array of monthly amounts by category |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| currency | string | yes | Currency code (compatible with ISO 4217 |
| monthly_amounts | Monthly Amount | yes | Array of total monthly amounts |
| categories | Category Expenditure | yes | Array of monthly amounts by category |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| currency | string | yes | Currency code (compatible with ISO 4217) |
| recurrence | Recurring Transactions | yes | Statistics for recurring transactions |
| by_category | Category Trends | yes | Statistics by transaction category |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| number_of_salaries | integer | yes | Number of Payrolls |
| expected_salary | Expected Salary | yes | Variable shows the list of expected salary payments by the customer |
| currency | string | yes | Currency code (compatible with ISO 4217) |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| amount | float | yes | Value of expected salary |
| expected_pay_date | integer | yes | Timestamp of the next expected salary |
| pay_frequency | string | yes | Frequency of the expected salary. Available values: Weekly, Fortnightly, Monthly, Irregular |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| sales_proportion | float | yes | Variable indicates ratio of sales income to total income |
| services_proportion | float | yes | Variable indicates ratio of services income to total income |
| other_income_proportion | float | yes | Variable indicates ratio of all incomes except sales and services to total income |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| fixed_proportion | float | yes | Variable indicates ratio of fixed expenditures to total expenditures |
| flexible_proportion | float | yes | Variable indicates ratio of flexible expenditures to total expenditures |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| amount | float | yes | Value in associated currency |
| year | integer | yes | Year |
| month | integer | yes | Month |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| name | string | yes | Category name |
| monthly_amounts | Monthly Amount | yes | Array of monthly amounts |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| name | string | yes | Category name |
| fixed_flexible | string | yes | Variable indicating whether the corresponding transaction category represents a fixed or flexible expenditure |
| monthly_amounts | Monthly Amount | yes | Array of monthly amounts |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| description | string | yes | Transaction description |
| average_amount | float | yes | Average value of recurring transactions |
| amount_variance | float | yes | Variance in the value of recurring transactions |
| transaction_ids | array | yes | Array of recurring transaction id |
| amount_stability_of_transaction | float | yes | Amount Consistency - Determines how consistent are the monthly amounts within the group. 1.0 means the values are the same. |
| frequency_stability_of_transaction | float | yes | Regularity - Determines how regular in time are transaction to each other. 1.0 means exactly the same period of time between transactions. |
| time_stability_of_transaction | float | yes | Longevity - Determines for how long we have transactions in the group. 1.0 means the transactions occur in each of the last 12 months. |
| expected_amount | string | yes | Expected amount for the next occurrence of this transaction |
| expected_pay_date | string | yes | Expected date for the next occurrence of this transaction (Unix timestamp) |
| frequency | string | yes | Frequency of the recurring transaction (e.g., Monthly, Weekly, Irregular) |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| category | string | yes | Category name |
| min | float | yes | Minimum transaction value within category |
| mean | float | yes | Mean transaction value within category |
| max | float | yes | Maximum transaction value within category |
| variance | float | yes | Variance in transaction value within category |
| frequency | float | yes | Average number of transactions per month within category |
| continuity | integer | yes | Longest number of consecutive months in which transactions from a given category occur |
| recency | integer | no | Months since last transaction within a given category occurred |
| amount_stability_of_category | float | yes | Amount Consistency - Determines how consistent are the monthly amounts within the category. 1.0 means the values are the same. |
| frequency_stability_of_category | float | yes | Regularity - Determines how regular in time are transactions in the category. 1.0 means exactly the same period of time between transactions. |
| time_stability_of_category | float | yes | Longevity - Determines for how long we have transactions in the category. 1.0 means the transactions occur in each of the last 12 months. |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| currency | string | yes | Currency code (compatible with ISO 4217) |
| new_debt_indicator | boolean | yes | Flag indicating the presence of a new debt product on the customer’s account over the last six months |
| debt_management_indicator | boolean | yes | Flag indicating the presence of any payments to a debt collection, recoveries or management company on the customer’s account over the last twelve months |
| recent_account_indicator | boolean | yes | Flag indicating whether the account has up to recent three months of transactions data |
| mortgage_rent_indicator | boolean | yes | Determines mortgage/rent payments are detected in the most recent 12 months |
| insurance_indicator | boolean | yes | Determines insurance payments are detected in the most recent 12 months |
| high_cost_short_term_credit_indicator | boolean | yes | Flag indicating the presence of high cost short term loan over the last twelve months |
| profitability_ratio | float | yes | The ratio of total sales and services incomes to total expenditures over the last twelve months |
| negative_balance_ratio | float | yes | The percentage of time the customer spends with a negative total balance over the last twelve months |
| bank_charges | Monthly Statistics | yes | Count of the number of times a customer has been penalised by their bank for some adverse activity (such as unarranged overdraft usage, unpaid standing orders and interest charged) over the last three, six and twelve months. |
| income_proportion | Income Proportion | yes | The ratio of sales, services and other incomes to total income |
| expense_proportion | Expense Proportion | yes | The ratio of fixed and flexible expenditures to total expenditures |
| returned_direct_debits | Monthly Statistics | yes | Count of the number of returned direct debits over the last three, six and twelve months |
| credit_repayments | Rate Statistics | yes | Credit repayment statistics over the last twelve months |
| debit_bank_transfer | Rate Statistics | yes | Debit bank transfer statistics over the last twelve months |
| summary_averages | Average Statistics | yes | Average statistics for expenditures and incomes over the last twelve months |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| num_last_3m | Occurrence | yes | Statistics over last three months |
| num_last_6m | Occurrence | yes | Statistics over last six months |
| num_last_12m | Occurrence | yes | Statistics over last twelve months |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| timestamp_from | integer | yes | Timestamp |
| timestamp_to | integer | yes | Timestamp |
| count | integer | yes | Count |
| ratio_to_income | float | yes | Ratio to income |
| total_amount | float | yes | Total amount |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| rate_of_change | float | yes | Variable which describes the rate of change of contributions from a given transaction category. This is calculated by comparing the most recent three-month average value to the average value over the period of evaluation |
| pred_next_month | float | yes | Variable is deprecated |
| ratio_to_income | float | yes | Average monthly payment from transaction category as a percentage of average monthly income |
| ratio_to_recurring_income | float | yes | Average monthly payment from transaction category as a percentage of average monthly recurring income |
| count | integer | yes | Total Count of Incidents in the last 12 months |
| total_amounts | Total Amount | yes | Total Amount |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| average_fixed_exp | float | yes | Average fixed expenditure |
| average_flexible_exp | float | yes | Average flexible expenditure |
| average_income | float | yes | Average income |
| average_recurring_income | float | yes | Average recurring income |
| predicted_amounts | object | yes | Predicted amounts for the next period |
| predicted_amounts.fixed_expenses | float | yes | Predicted fixed expenses for the next period |
| predicted_amounts.flexible_expenses | float | yes | Predicted flexible expenses for the next period |
| predicted_amounts.income | float | yes | Predicted income for the next period |
| predicted_amounts.recurring_income | float | yes | Predicted recurring income for the next period |
Was this article helpful?
Friendly Score UK Ltd.
41 Luke Street
London EC2A 4DP
Call us on +44 20 3996 3540
Company registered in England
Company number 09168668, ICO ZA111687
VAT registration number 206 9758 80
Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)