Generate Balance Analytics

POST {{baseUrl}}/analytics/balance/v1/customer/{{customerId}}?reference-number=abc123

Balance Analytics for Business analyzes bank balances over time to report metrics and identify behavior that may indicate risk.

Calculated metrics include: * Current/available account balances * Minimum/maximum/average account balances over the requested time period and broken down by month

• Daily ending balance of accounts for each day in the requested time period

• Propensity of the customer's account balances to increase week over week

• Number of days in the requested time period ending with a negative balance

This version of the API is intended for piloting and integration testing your application with the Balance Analytics product. It does not adhere to FCRA requirements, and should not be used for production/lending purposes. See Generate Balance Analytics - FCRA for the FCRA compliant version of this API.

A successful call to this API will generate analytics and store a report within Finicity. The report can be retrieved via Get Balance Analytics Report (operation: GetObbAnalyticsReport).

Supported regions:

Request Params

HEADERS

RESPONSES

status: OK

{"accountIds":[10001,10002,10003],"businessId":123,"createdDate":"2022-02-10T05:00:00-07:00","customerId":10001,"reportId":"145cabe0-2b38-4175-9b7e-115431359839","reportPin":"qert","requesterName":"Mortage ABC LLC","title":"Finicity Balance Analytics"}