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. |
| 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 |
1
2
3
curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/insights/current_business' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
{
"income": {
"currency": "GBP",
"monthly_amounts": [
{
"amount": "22.35",
"year": "2019",
"month": "11"
}
],
"categories": [
{
"name": "Salary",
"monthly_amounts": [
{
"amount": "22.35",
"year": "2019",
"month": "11"
}
]
}
]
},
"expenditure": {
"currency": "GBP",
"monthly_amounts": [
{
"amount": "22.35",
"year": "2019",
"month": "11"
}
],
"categories": [
{
"name": "Hobby",
"fixed_flexible": "fixed",
"monthly_amounts": [
{
"amount": "22.35",
"year": "2019",
"month": "11"
}
]
}
]
},
"financial_patterns": {
"currency": "GBP",
"recurrence": [
{
"description": "Granny's Bakery",
"average_amount": "22.35",
"amount_variance": "0.2",
"transaction_ids": [
"string"
]
}
],
"by_category": [
{
"category": "Groceries & Supplies",
"min": "5.05",
"mean": "8.05",
"max": "15.02",
"variance": "0.5",
"frequency": "15.5",
"continuity": "6",
"recency": "3"
}
]
},
"financial_markers": {
"bank_charges": {
"num_last_3m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
},
"num_last_6m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
},
"num_last_12m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
}
},
"new_debt_indicator": false,
"credit_repayments": {
"rate_of_change": "0.66",
"pred_next_month": "122.35",
"ratio_to_income": "0.07"
},
"currency": "GBP",
"returned_direct_debits": {
"num_last_3m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
},
"num_last_6m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
},
"num_last_12m": {
"timestamp_from": "1600466400",
"timestamp_to": "1608418799",
"count": "5"
}
},
"negative_balance_ratio": 0.5,
"debt_management_indicator": false,
"debit_bank_transfer": {
"rate_of_change": "0.66",
"pred_next_month": "122.35",
"ratio_to_income": "0.07"
},
"summary_averages": {
"average_fixed_exp": 0.5,
"average_flexible_exp": 0.5,
"average_income": 0.5
},
"expense_proportion": {
"fixed_proportion": 0.5,
"flexible_proportion": 0.5
},
"high_cost_short_term_credit_indicator": false,
"profitability_ratio": 0.5,
"recent_account_indicator": false,
"income_proportion": {
"other_income_proportion": 0.5,
"sales_proportion": 0.5,
"services_proportion": 0.5
}
},
"employment": {
"number_of_salaries": "2",
"expected_salary": [
{
"amount": "1220.35",
"expected_pay_date": "1608418799",
"pay_frequency": "monthly"
}
],
"currency": "GBP"
}
}Was this article helpful?
Friendly Score UK Ltd.
84 Brook Street
London W1K 5EH
Call us on +44 20 3709 6726
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)