Get Forecasts for Personal Accounts

POST

/public/v3/customers/{customer_id}/forecasts/current_personal

Parameters

ParameterData typeRequired?Description
customer_idstringyesCustomer ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
financial_credibility_scoreFinancial Credibility ScoresyesFinancial Credibility Scores
affordabilityAffordability ScoreyesAffordability Scores
liquidityLiquidity ScoreyesMultiple liquidity scores for various timespans
financial_forecastFinancial ForecastyesBank balance forecasts for customer accounts

Financial Credibility Scores

ParameterData typeRequired?Description
genericFinancial Credibility ScoreyesGeneric Financial Credibility Score
customFinancial Credibility ScoreyesCalibrated Financial Credibility Score

Affordability Score

ParameterData typeRequired?Description
scoreintegeryesScore
bandstringyesBand

Financial Credibility Score

ParameterData typeRequired?Description
scoreintegeryesScore
bandstringyesBand
reason_codesReason CodeyesReason codes

Liquidity Score

ParameterData typeRequired?Description
scoreintegeryesScore
bandstringyesBand
daysintegeryesDays

Financial Forecast

ParameterData typeRequired?Description
bankBankyesBanks with actual and forecasted balance

Bank

ParameterData typeRequired?Description
namestringyesBank name
slugstringyesBank slug (unique identifier)
is_activebooleanyesDenotes if this bank can currently be used
accountAccountyesArray of bank accounts with actual and predicted balance

Account

ParameterData typeRequired?Description
idintegeryesAccount ID
currencystringyesCurrency code (compatible with ISO 4217)
typestringyesAllowed:(Business, Personal)
numberstringyesAccount number
balanceBalance CollectionyesBalance includes actual and forecasted balance

Balance Collection

ParameterData typeRequired?Description
actualBalanceyesArray of historical balances
forecastBalanceyesArray of predicted balances

Balance

ParameterData typeRequired?Description
amountfloatyesAmount of associated currency
dateintegeryesTimestamp of balance

Reason Code

ParameterData typeRequired?Description
codestringyesReason code
descriptionstringyesReason code description
sentimentstringyesAllowed:(Positive, Negative)

Request example

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}'

Response example:

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.

52 Brook Street 1st Floor, Mayfair

London W1K 5DS

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: 781963)