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) |
1
2
3
curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/forecasts/current_personal' \
--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
{
"financial_credibility_score": {
"generic": {
"score": "700",
"band": "b",
"reason_codes": [
{
"code": "RC1",
"description": "No Gambling Activity",
"sentiment": "Positive"
}
]
},
"custom": {
"score": "700",
"band": "b",
"reason_codes": [
{
"code": "RC1",
"description": "No Gambling Activity",
"sentiment": "Positive"
}
]
}
},
"affordability": {
"score": "700",
"band": "b"
},
"liquidity": [
{
"score": "700",
"band": "b",
"days": 0
}
],
"financial_forecast": [
{
"bank": {
"name": "Barclays",
"slug": "barclays",
"is_active": false,
"account": [
{
"id": "123",
"currency": "GBP",
"type": "Personal",
"number": "12123412341234123412341234",
"balance": {
"actual": [
{
"amount": "22.35",
"date": "1600466400"
}
],
"forecast": [
{
"amount": "22.35",
"date": "1600466400"
}
]
}
}
]
}
}
]
}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)