Get Forecasts for Personal Accounts
GET
/public/v3/customers/{customer_id}/forecasts/current_personal
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| customer_id | string | yes | Customer ID |
none
none
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| financial_credibility_score | Financial Credibility Scores | yes | Financial Credibility Scores |
| affordability | Affordability Score | yes | Affordability Scores |
| liquidity | Liquidity Score | yes | Multiple liquidity scores for various timespans |
| financial_forecast | Financial Forecast | yes | Bank balance forecasts for customer accounts |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| generic | Financial Credibility Score | yes | Generic Financial Credibility Score |
| custom | Financial Credibility Score | yes | Calibrated Financial Credibility Score |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| score | integer | yes | Score |
| band | string | yes | Band |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| score | integer | yes | Score |
| band | string | yes | Band |
| reason_codes | Reason Code | yes | Reason codes |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| score | integer | yes | Score |
| band | string | yes | Band |
| days | integer | yes | Days |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| bank | Bank | yes | Banks with actual and forecasted balance |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| name | string | yes | Bank name |
| slug | string | yes | Bank slug (unique identifier) |
| is_active | boolean | yes | Denotes if this bank can currently be used |
| account | Account | yes | Array of bank accounts with actual and predicted balance |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| id | integer | yes | Account ID |
| currency | string | yes | Currency code (compatible with ISO 4217) |
| type | string | yes | Allowed:(Business, Personal) |
| number | string | yes | Account number |
| balance | Balance Collection | yes | Balance includes actual and forecasted balance |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| amount | float | yes | Amount of associated currency |
| date | integer | yes | Timestamp of balance |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| code | string | yes | Reason code |
| description | string | yes | Reason code description |
| sentiment | string | yes | Allowed:(Positive, Negative) |
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)