Get OBB Analytics Report - FCRA
GET {{baseUrl}}/analytics/data/v1/{{obbFcraReportId}}/fcra?purpose=31
Retrieve the report saved by Generate Balance Analytics - FCRA, Generate Cash Flow Analytics - FCRA, or Generate Payment History - FCRA. Requires the report ID generated by the previous call.
Report data can either be retrieved as a JSON document or PDF file.
Note: this is a premium service, billable per every successful API call for non-testing customers.
Supported regions:
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
purpose | number | (Required) 2-digit code from Permissible Purpose Codes, specifying the reason for retrieving this report. Required for retrieving some reports. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Finicity-App-Token | string | ||
Finicity-App-Key | string |
RESPONSES
status: OK
{"accountResults":[{"accountDetails":{"accountNumberDisplay":"8888","accountOwner":{"address":"123 Main St, Portland, OR 12345","name":"Johnny Appleseed"},"aggregationAttemptDate":"2022-03-30T14:47:19-07:00","aggregationStatusCode":0,"aggregationSuccessDate":"2022-03-30T14:47:19-07:00","currency":"USD","currentBalance":2239.22,"id":"1234902309er","institution":{"institutionIconUrl":"https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/101732/icon.svg","institutionId":12345,"institutionName":"Wells Fargo","institutionPrimaryColor":"#1B3E4A"},"institutionLoginId":1007302745,"name":"Super Checking","realAccountNumberLast4":5678,"status":"active","type":"checking"},"accountId":5001127492,"balanceAnalyticsMetrics":{"availableBalance":{"description":"Available Balance","example":1000.01,"type":"number"},"availableBalanceDate":{"description":"Available Balance date","example":"2022-02-18T02:34:00-07:00","type":"string","minLength":25,"maxLength":25},"averageDailyBalanceByMonthForTheReportTimePeriod":[{"amount":890.99,"period":"last30to1","periodBeginDate":"2022-03-01","periodEndDate":"2022-03-30"}],"averageDailyBalanceForTheReportTimePeriod":{"description":"Average Daily Balance","example":-10442.53,"type":"number"},"averageWeekdayBalanceForTheReportTimePeriod":{"description":"Average Weekday Balance","example":-10442.53,"type":"number"},"countDailyNegativeBalancesByMonthForTheReportTimePeriod":[{"count":5,"period":"last30to1","periodBeginDate":"2022-03-01","periodEndDate":"2022-03-30"}],"currentRunningBalance":{"description":"Current Running Balance Date","example":1000.01,"type":"number"},"currentRunningBalanceDate":{"description":"Current Running Balance date","example":"2022-02-10T05:00:00-07:00","type":"string","minLength":25,"maxLength":25},"dailyBalancesByWeekdayForTheReportTimePeriod":[{"date":"2021-10-11","dayOfWeek":"Monday","endingBalance":21527.3}],"dailyBalancesForTheReportTimePeriod":[{"date":"2021-10-11","dayOfWeek":"Monday","endingBalance":21527.3}],"historicNumberOfWeeksAverageBalanceIncreasing":{"historicAverageWeeklyBalances":[{"amount":679.07,"fromDate":"2020-01-01","toDate":"2020-01-07","week":1}],"historicNumberOfWeeksAverageBalanceIncreasing":3,"historicNumberOfWeeksWithDataAvailable":4},"maximumDailyBalanceByMonthForTheReportTimePeriod":[{"amount":890.99,"period":"last30to1","periodBeginDate":"2022-03-01","periodEndDate":"2022-03-30"}],"maximumRunningBalanceForTheReportTimePeriod":-28749.44,"minimumDailyBalanceByMonthForTheReportTimePeriod":[{"amount":890.99,"period":"last30to1","periodBeginDate":"2022-03-01","periodEndDate":"2022-03-30"}],"minimumRunningBalanceForTheReportTimePeriod":-28749.44},"currentReportRequest":{"reportBeginDate":"2022-03-01","reportEndDate":"2022-03-30","reportRequestDate":"2022-03-30T14:47:19-07:00","requestedDaysForReport":90,"requestedReportBeginDate":"2022-01-01"},"historicDataAvailability":{"historicAvailabilityBeginDate":"2022-03-01","historicAvailabilityEndDate":"2022-03-30","historicAvailableDays":30,"historicDataAvailability":"Data is available from 2022-03-01 to 2022-03-30"}}],"businessId":4444,"businessSummary":{"balanceAnalyticsMetrics":{"availableBalance":{"description":"Available Balance","example":1000.01,"type":"number"},"availableBalanceDate":{"description":"Available Balance date","example":"2022-02-18T02:34:00-07:00","type":"string","minLength":25,"maxLength":25},"averageDailyBalanceByMonthForTheReportTimePeriod":[{"amount":890.99,"period":"last30to1","periodBeginDate":"2022-03-01","periodEndDate":"2022-03-30"}],"averageDailyBalanceForTheReportTimePeriod":{"description":"Average Daily Balance","example":-10442.53,"type":"number"},"averageWeekdayBalanceForTheReportTimePeriod":{"description":"Average Weekday Balance","example":-10442.53,"type":"number"},"countDailyNegativeBalancesByMonthForTheReportTimePeriod":[{"count":5,"period":"last30to1","periodBeginDate":"2022-03-01","periodEndDate":"2022-03-30"}],"currentRunningBalance":{"description":"Current Running Balance Date","example":1000.01,"type":"number"},"currentRunningBalanceDate":{"description":"Current Running Balance date","example":"2022-02-10T05:00:00-07:00","type":"string","minLength":25,"maxLength":25},"dailyBalancesByWeekdayForTheReportTimePeriod":[{"date":"2021-10-11","dayOfWeek":"Monday","endingBalance":21527.3}],"dailyBalancesForTheReportTimePeriod":[{"date":"2021-10-11","dayOfWeek":"Monday","endingBalance":21527.3}],"historicNumberOfWeeksAverageBalanceIncreasing":{"historicAverageWeeklyBalances":[{"amount":679.07,"fromDate":"2020-01-01","toDate":"2020-01-07","week":1}],"historicNumberOfWeeksAverageBalanceIncreasing":3,"historicNumberOfWeeksWithDataAvailable":4},"maximumDailyBalanceByMonthForTheReportTimePeriod":[{"amount":890.99,"period":"last30to1","periodBeginDate":"2022-03-01","periodEndDate":"2022-03-30"}],"maximumRunningBalanceForTheReportTimePeriod":-28749.44,"minimumDailyBalanceByMonthForTheReportTimePeriod":[{"amount":890.99,"period":"last30to1","periodBeginDate":"2022-03-01","periodEndDate":"2022-03-30"}],"minimumRunningBalanceForTheReportTimePeriod":-28749.44},"currentReportRequest":{"reportBeginDate":"2022-03-01","reportEndDate":"2022-03-30","reportRequestDate":"2022-03-30T14:47:19-07:00","requestedDaysForReport":90,"requestedReportBeginDate":"2022-01-01"},"historicDataAvailability":{"historicAvailabilityBeginDate":"2022-03-01","historicAvailabilityEndDate":"2022-03-30","historicAvailableDays":30,"historicDataAvailability":"Data is available from 2022-03-01 to 2022-03-30"}},"customerId":10001,"reportHeader":{"businessAddress":"123 Main St","businessCity":"Portland","businessName":"B\u0026G Construction","businessState":"OR","businessZip":"12345","referenceNumber":"32asdfaasd0823","reportDate":"2022-03-16T21:28:38-07:00","reportId":"8ff8b4b2-706f-45c3-8d66-857bdb516214"},"requesterName":"Mortgage ABC LLC","title":"Fincity Balance Analytics"}