Get Personal Events

GET

/public/v3/customers/{customer_id}/events/personal

Returns events and alerts for personal bank accounts. See Product Insight Guide for event definitions.

Parameters

ParameterData typeRequired?Description
customer_idstringyesCustomer ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
idintegeryesID of the Event
event_typestringyesEvent Type
account_typestringyesBank Account Type. Only Personal bank accounts are supported.
yearintegeryesYear
monthintegeryesMonth
dayintegernoDay
thresholdfloatnoDetermines the threshold of the event
higher_than_thresholdbooleannoDetermines if the amount was higher than threshold
descriptionstringyesDescription of the event
amountfloatyesAmount associated to the event
currencystringyesCurrency
transaction_idintnoMost recent Transaction Id associated with the event
granularityintyesGranularity, possible values: YEARLY, MONTHLY, WEEKLY, DAILY
percentage_changefloatnoDetermines the percentage change to the previous the same event type
is_alertfloatbooleanDetermines if event is alert
is_eventfloatbooleanDetermines if regular event

Request example

1 2 3 curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/events/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 { "data": [ { "id": 123456, "event_type": "PENSION_MISSING", "account_type": "Personal", "year": 2022, "month": 2, "day": 28, "threshold": null, "description": "Pension transaction not detected in 2022-02", "amount": 162.53, "transaction_id": null, "granularity": "MONTHLY", "percentage_change": null, "currency": "GBP", "higher_than_threshold": null, "is_alert": true, "is_event": true, "created_at": 1646145450 } ] }

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)