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.
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| customer_id | string | yes | Customer ID |
none
none
| 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 |
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)