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

Parameter	Data type	Required?	Description
customer_id	string	yes	Customer ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

Parameter	Data type	Required?	Description
id	integer	yes	ID of the Event
event_type	string	yes	Event Type
account_type	string	yes	Bank Account Type. Only Personal bank accounts are supported.
year	integer	yes	Year
month	integer	yes	Month
day	integer	no	Day
threshold	float	no	Determines the threshold of the event
higher_than_threshold	boolean	no	Determines if the amount was higher than threshold
description	string	yes	Description of the event
amount	float	yes	Amount associated to the event
currency	string	yes	Currency
transaction_id	int	no	Most recent Transaction Id associated with the event
granularity	int	yes	Granularity, possible values: YEARLY, MONTHLY, WEEKLY, DAILY
percentage_change	float	no	Determines the percentage change to the previous the same event type
is_alert	float	boolean	Determines if event is alert
is_event	float	boolean	Determines 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

{
    "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.

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)